Wiki

Clone wiki

bookmaak / doc-generation

howto

generate docs:

$ make docs

clean docs:

$ make clean-docs

required software

If you want to generate the docs form the source code you need to have ndoc in your node_modules folder.

ndoc can be installed like all other dependencies. installing_dependencies; note that this is a development dependence.

writing docs

We use ndoc syntax, take a look at our code or see: https://github.com/nodeca/ndoc/blob/master/syntax.md

Updated