project-bin-doc
Generate documentation of your project.
if you provide a gh-branch on which commit, it will realize it for you.
Use the most suitable tool to document your project.
YUIDoc, ApiDoc, JsDoc, JsDox, mocha TOC.
Install
npm i project-bin-doc -g
You will need to install appropriate binary separately.
npm i yuidoc -gnpm i apidoc -gnpm i jsdoc -gnpm i jsdox -gnpm i mocha -g ... etc
Usage
Usage: project-doc [env] Generate documentation Options: -h, --help output usage information -V, --version output the version number
Configuration
Create a .local.json
file on root directory of your project.
project-bin-doc
will ensure .local.json
file
is added to .gitignore
file.
YuiDoc
Note that the project will always import a yuidoc helper by default.
This helper read a file and inject its content into your documentation.
Usage
{{#F "path"}}{{/F}}
yuidoc-include-helper.js
moduleexports = { return ; };