Generera dokumentation med markdown-filer med hjälp av Docsify

Om du skapar ett gratis plugin-, ram- eller open-source-skript du behöver dokumentation. Det är viktigt att dokumentera ditt arbete, både för din sanity och för att hjälpa andra som vill lära dig din fantastiska resurs.

Men att skapa online dokumentation kan vara en verklig smärta. Tack och lov, Docsify gör det enklare genom att tillhandahålla en gratis dokumentationsgenerator som körs på Markdown.

Detta är inte en typisk statisk webbplatsgenerator och det gör det behöver inte statiska HTML / CSS-sidor. Istället är det laddar markdown-filer dynamiskt och visar dem som webbsidor. Ganska snyggt!

Kolla in Docsify hemsida för a förhandsgranskning av layouten, tillsammans med ytterligare installationsdetaljer.

Det kräver att du skapa index.html filen själv, som sedan kan laddas upp till GitHub Pages eller vara värd på din egen server. Därifrån, du bara skriv Markdown-filer för varje sida och använd dem som dina primära dokument.

Hela processen beskrivs i detalj i Snabbstartsguide, så det är förmodligen det bästa stället att börja. Detta kan alla går igenom npm, så det hjälper verkligen att känna din ledningsprompt eller åtminstone villig att lära dig.

Det är möjligt att själv skapa en rå HTML-fil och kopiera / klistra in mallen från Docsifys installationsguide. Men jag rekommenderar gör det dynamiskt, eftersom det sparar massor av tid - och det är inte det som verkligen är meningen?

När du lär dig Docsify-systemet kan du lägg till funktioner med Markdown eller raw HTML. Dessa funktioner inkluderar a anpassad navigeringsfält och även din egen omslagssida med ditt projektets logotyp.

Dokumentera även kommer förpackad med ett gäng gratis teman om du vill ha förkonstruerade layouter att arbeta med. Eller kan du bläddra igenom deras showcase galleri för att se vilka projekt som använder Docsify för deras dokumentation.

Alla grundläggande installationsinformation och nedladdningar av filer kan hittas på GitHub, så huvud där borta om du vill ge detta ett skott.

Du kan också se en live-demo på huvudsidan Dokumentations dokumentation som säkert, körs på Docsify. Så om du gillar den här webbsidayouten kan du använda samma mall och köra allt via Docsify, 100% gratis och öppen källkod.