Générer de la documentation avec des fichiers Markdown à l'aide de Docsify

Si vous créez un plugin gratuit, un framework ou un script open source vous aurez besoin de documentation. Il est crucial de documenter votre travail, à la fois pour votre santé mentale et pour aider les autres qui veulent apprendre votre ressource impressionnante.

Cependant, créer de la documentation en ligne peut être une vraie douleur. Heureusement, Docsify le facilite en fournissant un générateur de documentation gratuit fonctionnant sur Markdown.

C'est pas un générateur de site statique typique et ça le fait pas besoin de pages HTML / CSS statiques. Au lieu de cela, il charge les fichiers Markdown dynamiquement et les affiche sous forme de pages Web. Génial!

Consultez la page d'accueil de Docsify pour une aperçu de la mise en page, de même que détails d'installation supplémentaires.

Cela nécessite que vous créez vous-même le fichier index.html, qui peuvent ensuite être téléchargés sur GitHub Pages ou hébergés sur votre propre serveur. De là, vous venez écrire des fichiers Markdown pour chaque page et utilisez-les comme documents principaux.

L’ensemble du processus est décrit en détail dans le Guide de démarrage rapide, c'est donc probablement le meilleur endroit pour commencer. Cela peut tout passe par npm, donc il est vraiment utile de connaître votre invite de commande ou au moins être disposé à apprendre.

Il est possible de créer un fichier HTML brut vous-même et de simplement copier / coller le modèle à partir du guide d'installation de Docsify. Mais je recommande le faire dynamiquement, car cela fait économiser une tonne de temps, et n'est-ce pas vraiment le but??

En apprenant le système Docsify, vous pouvez ajouter des fonctionnalités en utilisant Markdown ou HTML brut. Ces fonctionnalités comprennent un barre de navigation personnalisée et même votre propre page de garde avec le logo de votre projet.

Docsify même vient emballé avec un tas de thèmes gratuits si vous souhaitez utiliser des mises en page prédéfinies. Ou tu peux parcourir leur galerie vitrine pour voir quels projets utilisent Docsify pour leur documentation.

Tous les informations de configuration de base et téléchargements de fichiers peut être trouvé sur GitHub, alors allez-y si vous voulez essayer.

Vous pouvez également voir une démonstration en direct sur la page principale de la documentation de Docsify qui fonctionne bien sur Docsify. Donc, si vous aimez cette mise en page Web, vous pouvez utiliser ce même modèle et l'exécuter avec Docsify, 100% gratuit et open-source.