cd ~/open-source/

chrille@linux:~$ apt show docsify

Docsify

Docsify genererar dokumentationssajter direkt i webbläsaren utan att behöva bygga statiska filer i förväg. Du skriver Markdown och lägger till ett skript, så är du igång med en docs-sajt på nolltid. Det passar mindre projekt, interna guider eller prototyper där du vill slippa en byggpipeline.

Projektsidan för Docsify
Projektets egen sida, som den såg ut vid importen.

Docsify skiljer sig från många andra generatorer genom att den inte kräver något byggsteg. Du skapar en HTML-fil och pekar på dina Markdown-dokument, sedan renderar Docsify sajten direkt i besökarens webbläsare. Det gör det otroligt enkelt att komma igång och att uppdatera. Det passar mindre projekt, interna guider eller prototyper där du vill slippa en byggpipeline. Prestandan blir inte lika bra som hos förgenererade sajter, men för många ändamål spelar det ingen roll. Du kan lägga till sidopaneler, sökning och teman med plugins, och du behöver inte bekymra dig om byggsteg eller deployment-rutiner. Det passar interna guider, tillfälliga dokument eller projekt där du vill att alla ska kunna redigera Markdown direkt i repot.