Si vous développez des logiciels, possiblement des logiciels libres, peut-être avez-vous envie de mettre à disposition de vos utilisateurs, un joli site web avec l’ensemble de la documentation relative à votre projet ?
Mais comment faire pour ne pas y passer trop de temps ?
Pourquoi ne pas mettre en place une instance de Docusaurus ?
Docusaurus permet de concevoir, déployer et maintenir facilement des sites documentaires pour vos projets open source. Propulsé par React, Docusaurus peut être étendu ou customisé selon vos besoin. Le support et la gestion des langues y sont intégrés, et tout ce que vous produirez comme contenu (posts de blog, documentions…etc.) au sein de Docusaurus pourra être rédigé grâce à la syntaxe markdown avant d’être généré sous la forme de fichiers HTML statiques.
Docusaurus offre aussi du versionning pour que votre documentation soit toujours synchronisée avec les releases de vos projets et un moteur de recherche basé sur Algolia permettra à vos utilisateurs de s’y retrouver facilement.
Pour voir des exemples d’implémentation de Docusaurus, vous pouvez déjà consulter le site du projet, mais aussi les sites de projets qui l’utilisent comme Bowler, React Native ou Metro de Facebook ou encore Prettier.
Bonne doc à tous !