npm install -g writeme
Just go to a directory that you want to generate documentation for, and type:
writeme will create a
readme.html at the root of your directory, containing the generated docs. It relies on your code being commented using jsdoc format.
writeme grabs your jsdoc-formatted comments, and generates nice-looking documentation for you.
To see examples of what
writeme-generated documentation looks like, check out
api.html at the root of this repo, or the examples inside the