Luo dokumentaatio merkintätiedostoilla käyttäen Docsifyä
Jos luot ilmaisen laajennuksen, kehyksen tai avoimen lähdekoodin komentosarjan tarvitset asiakirjoja. Se on ratkaisevan tärkeää dokumentoi työsi, sekä oman järkeä että auttaa muita, jotka haluavat oppia mahtavan resurssin.
Online-dokumentaation luominen voi kuitenkin olla todellinen kipu. Onneksi, Docsify helpottaa tarjoamalla a ilmainen dokumentointi generaattori käynnissä Markdown.
Tämä on ei tyypillinen staattisen sivuston generaattori ja se tekee ei vaadi staattisia HTML / CSS-sivuja. Sen sijaan se lataa Markdown-tiedostoja dynaamisesti ja näyttää ne verkkosivuina. Aika siisti!
Tutustu Docsifyn kotisivulle a esikatselu ulkoasusta, kera lisäasetukset.
Se edellyttää, että sinä luo index.html-tiedosto itse, joka voidaan sitten ladata GitHub-sivuille tai isännöidä omassa palvelimessasi. Sieltä olet juuri kirjoita jokaisen sivun Markdown-tiedostoja ja käytä niitä ensisijaisena asiakirjana.
Koko prosessi on kuvattu yksityiskohtaisesti Pikaopas, joten se on luultavasti paras paikka aloittaa. Tämä voi kaikki kulkevat npm: n kautta, joten se todella auttaa tuntemaan komentorivisi tai ainakin olemaan valmis oppimaan.
Raaka HTML-tiedosto voidaan luoda itse ja vain kopioida / liittää malli Docsifyn asennusoppaasta. Mutta suosittelen tekee sen dynaamisesti, koska se säästää tonnia aikaa, eikä se ole oikea asia?
Kun opit Docsify-järjestelmän, voit lisää ominaisuuksia käyttämällä Markdownia tai raakaa HTML-koodia. Näitä ominaisuuksia ovat mm mukautettu navigointipalkki ja jopa oman kansilehden hankkeen logon kanssa.
Docsify edes tulee pakattuja ilmaisia teemoja jos haluat valmiiksi suunniteltujen asettelujen toimivan. Tai voit selaa heidän esitystapahtuman galleriaansa nähdä, mitkä hankkeet käyttävät Docsify-dokumenttia niiden dokumentointiin.
Kaikki perusasetukset ja tiedostojen lataukset löytyy GitHubista, joten päätä sinne, jos haluat antaa tämän laukauksen.
Voit myös katso live-esittelyä Docsify-dokumentaatiosivulla joka varmasti riittää Docsifyyn. Joten, jos pidät tästä verkkosivun asettelusta, voit käyttää samaa mallia ja käyttää sitä koko Docsifyn, 100%: n ilmaisen ja avoimen lähdekoodin kautta.
