[.NET] Générer rapidement une documentation

Avec Docnet. Cette librairie permet de générer un site statique (pages html) à partir de fichiers markdown (*.md).

1. Créer un dossier dans le quel stocker tous les fichiers *.md.

2. Créer un fichier « docnet.json« . ce fichier va contenir les différentes informations. Exemple

Exemple avec BenchmarkDotNet

3. Télécharger une release de Docnet

4. Depuis le répertoire dézippé contenant Docnet.exe et les thèmes, ouvrir une invite de commande (raccourci « cmd » dans la barre d’explorateur de fichiers sous Windows) puis « docnet <chemin vers dossier contenant la documentation> »

5. Ensuite il est possible d’héberger le site avec Github. Créer un nouveau « repository » ou utiliser un existant. Aller dans les « Settings » du repository dans la section « Github Pages« , sélectionner la source sur « master-branch/docs folder par exemple », sauvegarder.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *