Documenter mon projet open-source rapidement

Je reçois beaucoup de questions sur les outils à utiliser. J’ai décidé d’y répondre ici.

Comment documenter de façon économique un projet open-source, fait sur le temps libre ?

Les générateurs statiques sont très efficaces, et en version hébergée pour vous, il n’y a pas, en 2020, tant de solutions que cela. Mes recherches ont été faciles.

En fait, j’ai identifié 4 solutions pratiques qui supportent le Markdown :

• Github Pages : un Jekyll rattaché à vos projets hébergés sur Github
• Gitlab Pages : à vous de choisir le générateur statique qui vous convient.
• ReadTheDocs (gratuit pour les projets open-source) : choisissez entre deux parfums, un Sphinx ou un MkDocs, pour utiliser le format de fichier qui vous convient le mieux.
• Gitbook (gratuit pour les projets open-source) : solution propre, l’équipe est à Lyon.

Publicité