Generer dokumentation med Markdown-filer ved hjælp af Docsify

Hvis du opretter et gratis plugin, framework eller open source script du skal bruge dokumentation. Det er afgørende at dokumentere dit arbejde, både for din hygiejne og for at hjælpe andre, der ønsker at lære din fantastiske ressource.

Men at skabe online dokumentation kan være en reel smerte. Heldigvis, Docsify gør det lettere ved at levere en gratis dokumentationsgenerator, der kører på Markdown.

Dette er ikke en typisk statisk site generator og det gør det kræver ikke statiske HTML / CSS-sider. I stedet er det Loads Markdown-filer dynamisk og viser dem som websider. Smukt pænt!

Tjek Docsify hjemmeside for a Forhåndsvisning af layoutet, sammen med Yderligere installationsoplysninger.

Det kræver, at du opret selv index.html filen, som derefter kan uploades til GitHub Pages eller hostes på din egen server. Derfra er du bare skriv markdown filer for hver side og brug dem som dine primære dokumenter.

Hele processen er skitseret detaljeret i hurtig start guide, så det er nok det bedste sted at starte. Dette kan alle løber gennem npm, så det hjælper virkelig at kende din kommandoprompt eller i det mindste er villig til at lære.

Det er muligt at lave en rå HTML-fil selv og bare kopiere / indsætte skabelonen fra Docsify's installationsvejledning. Men jeg anbefaler gør det dynamisk, da det sparer masser af tid - og det er ikke det rigtige punkt?

Når du lærer Docsify-systemet, kan du Tilføj funktioner ved hjælp af Markdown eller rå HTML. Disse funktioner omfatter a brugerdefineret navigationslinje og endda din egen forsiden med dit projekts logo.

Dokumenterer selv kommer pakket med en flok gratis temaer hvis du vil have prædesignede layouter til at arbejde med. Eller det kan du gennemse deres showcase galleri for at se, hvilke projekter der bruger Docsify til deres dokumentation.

Alle Grundlæggende opsætningsinfo og download af filer kan findes på GitHub, så hoved derovre, hvis du vil give dette et skud.

Du kan også Se en live demo på hoveddokumentationen Dokumentations dokumentation som sikkert nok kører på Docsify. Så hvis du kan lide det websiderlayout, kan du bruge den samme skabelon og køre det hele gennem Docsify, 100% fri og open source.