Generer dokumentasjon med Markdown-filer ved hjelp av Docsify
Hvis du lager et gratis plugin-, rammeverk eller åpen kildekode du trenger dokumentasjon. Det er viktig å dokumentere arbeidet ditt, både for din sunnhet og for å hjelpe andre som ønsker å lære din fantastiske ressurs.
Men å lage online dokumentasjon kan være en ekte smerte. Heldigvis, Docsify gjør det lettere ved å gi en gratis dokumentasjonsgenerator som kjører på Markdown.
Dette er ikke en typisk statisk nettsted generator og det gjør det ikke krever statiske HTML / CSS sider. I stedet er det Laster Markdown-filer dynamisk og viser dem som nettsider. Temmelig stilig!
Ta en titt på Docsify-hjemmesiden for en forhåndsvisning av oppsettet, sammen med Ytterligere oppsettdetaljer.
Det krever at du opprett index.html filen selv, som deretter kan lastes opp til GitHub Pages eller hostes på din egen server. Derfra, bare du skriv Markdown-filer for hver side og bruk dem som dine primære dokumenter.
Hele prosessen er omtalt i detalj i Hurtigstartveiledning, så det er sannsynligvis det beste stedet å starte. Dette kan alle går gjennom npm, så det hjelper virkelig å vite ledeteksten din eller i det minste være villig til å lære.
Det er mulig å lage en rå HTML-fil selv og bare kopiere / lime inn malen fra Docsifys installasjonsveiledning. Men jeg anbefaler gjør det dynamisk, siden det sparer massevis av tid - og det er ikke det egentlig poenget?
Når du lærer Docsify-systemet, kan du legg til funksjoner ved hjelp av Markdown eller raw HTML. Disse funksjonene inkluderer a egendefinert navigeringslinje Til og med din egen forsiden med prosjektets logo.
Dokumenterer selv kommer pakket med en mengde gratis temaer hvis du vil ha forhåndsdefinerte layouter å jobbe med. Eller, det kan du bla gjennom deres showcase galleri for å se hvilke prosjekter som bruker Docsify for deres dokumentasjon.
Alle grunnleggende oppsettinfo og filnedlastinger kan bli funnet på GitHub, så hodet der bort hvis du vil gi dette et skudd.
Du kan også se en live-demo på hoveddokumentasjonen for Docsify som sikkert nok kjører på Docsify. Så, hvis du liker det nettsideoppsettet, kan du bruke samme mal og kjøre alt gjennom Docsify, 100% gratis og åpen kildekode..
