Documenter ses projets avec Docsify & Github Pages

J'ai récemment découvert Docsify (https://docsify.js.org), une librairie Javascript qui permet de manière rapide & efficace de documenter un projet grâce à des fichiers markdown qui sont interprétés puis déployés sur GitHub Pages. Cette librairie VueJS vient avec un thème embarqué épuré & très facilement modifiable. On a également accès à une variété de plugins. Par exemple, j'ai choisi de rajouter l'extension pour la coloration syntaxique pour les bouts de code en PHP, une autre extension permettant de créer des onglets (tabs) ou encore la fonctionnalité 'Copier dans le presse-papier' sur les extraits de code. Pour documenter un projet existant, il vous faudra Node.js d'installé sur votre ordinateur (https://nodejs.org/en/download/). On télécharge docsify avec la commande npm i docsify-cli -g Ensuite, on initialise le projet avec docsify init ./docs Des fichiers sont ajoutés dans le dossier docs (index.html, .nojekyll et README.md). On peut déjà faire tourner un serveur local pour voir le contenu de base avec la commande docsify serve docs Ensuite, on peut configurer certains paramètres dans le fichier index.html. A partir de là, je vous invite à voir tout ce qu'il est possible de faire directement sur la documentation de Docsify https://docsify.js.org/#/quickstart. Rendez vous ensuite sur la pages Paramètres > Pages de votre projet sur Github. Ici, j'ai opté pour la simplicité en sélectionnant la branche main & j'ai créé un dossier docs pour entreposer le projet de documentation. Une fois que cela est fait, une URL vous est attribuée et votre site de documentation est automatiquement déployé en ligne, c'est magique !