ChluNetwork / chlu-ipfs-support

Support libs to talk to IPFS
MIT License
1 stars 1 forks source link

Decide on documentation system to use #38

Closed kulpreet closed 6 years ago

fazo96 commented 6 years ago

IPFS manager their js projects using a tool called aegir that they built, which in turn uses http://documentation.js.org/ for documentation. It does look pretty good: we write jsdoc documentation in our JS files and this generates HTML, MD or JSON output. We could either put the MD output in a file like API.md or HTML output in Github Pages.

There is also JSDoc which, using the same style of in-js docs, generates HTML pages http://usejsdoc.org/about-getting-started.html#generating-a-website