spool-hubBlog

Czytaj dokumentację repozytorium w aplikacji

aktualnościa-686

Elegancka biblioteka cyfrowa i eksplorator dokumentacji, abstrakcyjna reprezentacja ze schludnymi folderami i dokumentami tekstowymi

Czym to jest

Eksplorator Dokumentów (Docs explorer) to natywna przeglądarka plików markdown Twojego repozytorium. Znajduje się w sekcji „Pomoc” na lewym pasku i renderuje pliki readme, specyfikacje oraz inne pliki .md bezpośrednio w aplikacji.

Dlaczego warto korzystać

Eliminuje konieczność opuszczania obszaru roboczego lub przechodzenia do zewnętrznych serwisów, takich jak GitHub, w celu przeczytania dokumentacji projektu. Wszystkie pliki są renderowane w natywnym motywie aplikacji.

Jak z tego korzystać

Kliknij ikonę Dokumenty. Na szerokich ekranach eksplorator otwiera się w dwóch panelach: interaktywne drzewo folderów po lewej stronie i przeglądarka dokumentów po prawej. Możesz rozwijać foldery, aby znaleźć dokumenty, lub klikać łącza wewnątrz dokumentów, aby nawigować. Na telefonie widoczna jest pojedyncza kolumna z przyciskiem „Foldery”, który pozwala przełączać eksplorator nad dokumentem. Możesz łatwo udostępniać linki, ponieważ adresy URL mają strukturę /docs/<repo path>.

Stary sposób

Wcześniej użytkownicy musieli przechodzić do zewnętrznego hosta repozytorium lub czytać surowe pliki markdown lokalnie, aby przeglądać dokumentację projektu.

Nowy sposób

Dokumenty są teraz parsowane i przejrzyście renderowane wewnątrz obszaru roboczego. Przeglądarka obsługuje względne linki między plikami i intuicyjnie zachowuje Twoją pozycję.