Documentez votre prochain projet avec Wiki-js
Vous souhaitez mettre votre solution en avant en haut de cet article ? Contactez-nous
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 grands publics 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 presenter Wiki-js.
Bien que faire originellement pour creer des Wiki, cette application Node.js tres simple a installer est pour moi une des meilleur solution disponible actuellement pour creer une documentation complete simplement. Gestion du markdown, des images et autres assets, recherche complète, les fonctionnalités nécessaires sont présentes et fonctionnent bien.
Pour en savoir plus ou l'installer, je vous propose de passer sur leur documentation, bien évidemment faite elle-même avec Wikijs.
Wiki.js est open source et gratuit, je vous encourage donc à aller jeter un oeil a leur depot Github.