Documenter mon projet open-source rapidement

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.

Vendredÿ : jouer du trombone, un chêne boîte aux lettres, orthographe et ponctuation

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ: un yoddler poursuit Yahoo!

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Chickens eating

Vendredÿ : des slips enterrés, de la cuisine par -70°C, from a galaxy far far away et Alexa dans votre partie de jeu de plateau

 

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

 

Vendredÿ : viande imprimée en 3D, gymnastique et barbier pubien

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ : sandwich du bureau, crypto-jeu de société, punk, atlas imaginaire et message codé

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

2012 05 27 062 Irokesenschnitt

Vendredÿ : prévention canadienne, chercher des couleurs, et des outils

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ: toponymie, side-projects et émeute dans l’ascenseur

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ : des Legos sur la mort, Kinder Surprise fail et Etienne Daho en 1996

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ: guano, imagination sans images et sushis imprimés en 3D

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »