spool-hubBlogi

Lue repositorion dokumentaatiota suoraan sovelluksessa

uutiseta-686

Tyylikäs digitaalinen kirjasto ja dokumentaatioselain, abstrakti esitys siisteillä kansioilla ja tekstitiedostoilla

Mikä se on

Dokumentit-selain (Docs explorer) on natiivi katseluohjelma repositoriosi markdown-tiedostoille. Se sijaitsee vasemman palkin Ohje-osion alla ja renderöi readme-tiedostot, määrittelyt sekä muut .md-tiedostot suoraan sovelluksessa.

Miksi käyttää sitä

Se poistaa tarpeen poistua työtilasta tai siirtyä ulkoiseen lähteeseen, kuten GitHubiin, projektin dokumentaation lukemiseksi. Kaikki tiedostot renderöidään sovelluksen omalla teemalla.

Miten sitä käytetään

Napsauta Dokumentit-kuvaketta. Leveillä näytöillä selain avautuu kahteen ruutuun: interaktiivinen kansiopuu vasemmalla ja asiakirjan katseluohjelma oikealla. Voit laajentaa kansioita asiakirjojen löytämiseksi tai navigoida napsauttamalla linkkejä dokumenttien sisällä. Puhelimessa näet yhden sarakkeen, jossa on Kansiot-painike selaimen avaamiseksi dokumentin yläpuolelle. Linkkien jakaminen on helppoa, sillä URL-osoitteet noudattavat rakennetta /docs/<repo path>.

Vanha tapa

Aiemmin käyttäjien oli siirryttävä ulkoiseen repositoriopalveluun tai luettava raakoja markdown-tiedostoja paikallisesti nähdäkseen projektin dokumentaation.

Uusi tapa

Nyt asiakirjat jäsennetään ja renderöidään suoraan työtilassa. Katseluohjelma tukee tiedostojen välisten linkkien suhteellista reititystä ja säilyttää sijaintisi intuitiivisesti.