Pour écrire de la documentation, utiliser du Markdown reste un grand classique. Mais quand on a 50 fichiers, ça peut vite devenir compliqué de s'y retrouver !
Pierre, développeur chez Younup, vous propose de découvrir MkDocs, un outil qui vous permettra de générer un site web statique à partir de fichiers Markdown.
Vous pourrez ensuite naviguer facilement dans vos fichiers et faire de la recherche. L'outil est donc un indispensable pour gagner en lisibilité, praticité et surtout pour l'utiliser à plusieurs.
Au programme de cette vidéo :
- Introduction à MkDocs : qu'est-ce que l'outil permet de faire et quels sont ses avantages, dans quel cas l'utiliser
- Importation de la documention d'un projet existant "Catch2" (un framework de test unitaire en C++) et paramétrage du fichier yaml
- Installation de MkDocs et déploiement de la documentation en ligne (navigation dans les fichiers, recherche...)
- Importation d'un nouveau projet et redéfinition de la structure de la documentation dans le fichier yaml
- Installation de nouveaux thèmes pour l'affichage de la documentation
