spool-hubBlog

Čítajte dokumentáciu repozitára priamo v aplikácii

novinkya-686

Elegantná digitálna knižnica a prieskumník dokumentácie, abstraktné zobrazenie s usporiadanými priečinkami a textovými dokumentmi

Čo to je

Prieskumník Dokumentov (Docs explorer) je vstavaný prehliadač pre markdown súbory vášho repozitára. Nachádza sa v časti „Pomoc“ na ľavom paneli a vykresľuje súbory readme, špecifikácie a ďalšie súbory .md priamo v aplikácii.

Prečo to používať

Eliminuje potrebu opustiť pracovný priestor alebo prechádzať na externý zdroj, ako je GitHub, kvôli čítaniu projektovej dokumentácie. Všetky súbory sa zobrazujú v natívnom motíve aplikácie.

Ako to používať

Kliknite na ikonu Dokumenty. Na širokých obrazovkách sa prieskumník otvorí v dvoch paneloch: interaktívny strom priečinkov vľavo a prehliadač dokumentov vpravo. Môžete rozbaliť priečinky a nájsť dokumenty alebo kliknúť na odkazy v dokumentoch pre navigáciu. Na telefóne sa zobrazuje jeden stĺpec s tlačidlom „Priečinky“ na prepnutie prieskumníka nad dokumentom. Odkazy môžete jednoducho zdieľať, pretože adresy URL sledujú štruktúru /docs/<repo path>.

Starý spôsob

V minulosti museli používatelia prechádzať na externý hostiteľský repozitár alebo čítať nespracované súbory markdown lokálne, aby si prezreli projektovú dokumentáciu.

Nový spôsob

Dokumenty sa teraz spracúvajú a prehľadne vykresľujú priamo v pracovnom priestore. Prehliadač podporuje relatívne smerovanie pre odkazy medzi súbormi a intuitívne zachováva vašu pozíciu.