Genereer documentatie met Markdown-bestanden met Docsify

Als u een gratis plug-in, framework of opensource-script maakt je hebt documentatie nodig. Het is cruciaal om documenteer uw werk, zowel voor je geestelijke gezondheid als om anderen te helpen die jouw geweldige hulpbron willen leren.

Het maken van online documentatie kan echter heel lastig zijn. dankbaar, Docsify maakt het gemakkelijker door een gratis documentatie generator draait op Markdown.

Dit is geen typische statische-sitegenerator en dat is zo geen statische HTML / CSS-pagina's vereisen. In plaats daarvan, het laadt Markdown-bestanden dynamisch en geeft ze weer als webpagina's. Best netjes!

Bekijk de Docsify-startpagina voor een voorbeeld van de lay-out, samen met verdere instellingsdetails.

Het vereist je wel maak zelf het index.html-bestand aan, die vervolgens kan worden geüpload naar GitHub-pagina's of kan worden gehost op uw eigen server. Vanaf daar, je gewoon schrijf Markdown-bestanden voor elke pagina en gebruik deze als uw primaire documenten.

Het hele proces is in detail beschreven in de Snelstartgids, dus dat is waarschijnlijk de beste plek om te beginnen. Dit kan allemaal doorlopen via npm, dus het helpt echt om je opdrachtprompt te kennen of op zijn minst bereid te zijn om te leren.

Het is mogelijk om zelf een onbewerkt HTML-bestand te maken en de sjabloon gewoon te kopiëren / plakken vanuit de setuphandleiding van Docsify. Maar ik raad aan dynamisch doen, omdat het een hoop tijd bespaart - en dat is niet echt het punt?

Naarmate u het Docsify-systeem leert, kunt u dit doen functies toevoegen met Markdown of onbewerkte HTML. Deze functies omvatten een aangepaste navigatiebalk en zelfs uw eigen voorpagina met het logo van uw project.

Docsify zelfs wordt geleverd met een heleboel gratis thema's als je vooraf ontworpen lay-outs wilt gebruiken. Of je kan blader door hun showcase-galerij om te zien welke projecten Docsify gebruiken voor hun documentatie.

Al de basis setup info & bestandsdownloads is te vinden op GitHub, dus ga daarheen als je dit een kans wilt geven.

Je kan ook bekijk een live demo op de hoofddocumentatie van Docsify wat, zeker genoeg, op Docsify draait. Dus, als je die webpagina-opmaak leuk vindt, kun je diezelfde sjabloon gebruiken en alles via Docsify uitvoeren, 100% gratis en open-source.