The Daily Shaarli

All links of one day in a single page

May 11, 2020

Documenter ses projets
### Documenter les fonctions d'une lib
Utiliser JSDoc et l'adapter à ses besoins/son gout avec des thèmes :

https://github.com/nijikokun/minami (minimaliste et permet de différencier ƒn et classes, ma préférence)
https://github.com/smeijer/latodoc (classique)
https://github.com/docstrap/docstrap (differentes variantes bootstrap)
https://medium.com/swlh/creating-better-jsdoc-documentation-8b7a65744dcb

### Documenter un projet plus complexe
Pour documenter un projet avec plus de texte, on peut utiliser [docsify](https://docsify.js.org/).

Les deux outils peuvent tout à fait s'utiliser conjointement.

#### RAML
https://raml.org/
https://github.com/mulesoft/osprey
https://github.com/mulesoft/api-console
http://www.mikestowe.com/blog/2014/07/raml-vs-swagger-vs-api-blueprint.php
https://dzone.com/articles/rest-api-documentation-part-2-1
https://www.q-perior.com/en/blog/openapi-and-raml-in-comparison/
https://blogs.mulesoft.com/dev/api-dev/open-api-raml-better-together/

https://apiblueprint.org/