Documentez votre prochain projet avec Wiki-js

Le 03/10/2017

Aujourd'hui, je vous propose de découvrir un moteur de Wiki extrêmement simple à installer pour créer la documentation de votre prochain projet.

Wiki.js

Pour documenter son projet, la solution de prédilection des développeurs est bien souvent un générateur automatique, qui permet de créer une documentation en extrayant les commentaires du code même. Si cette solution est parfaite pour documenter une API, pour des projets plus grand public les besoins sont différents, et la main de l'homme est nécessaire pour écrire la documentation.

Si vous êtes dans ce deuxième cas et que vous cherchez un outil pour vous permettre de mettre en place votre documentation, laissez-moi vous présenter Wiki-js.

Bien que faite originellement pour créer des Wiki, cette application Node.js très simple à installer est pour moi une des meilleures solutions disponibles actuellement pour créer une documentation complète simplement. Gestion du Markdown, des images et autres assets, recherche complète, les fonctionnalités nécessaires sont présentes et fonctionnent bien.