gulp-codo
Gulp plug-in to generate documentation with codo.
Install:
First install codo globally:
$ npm install -g codo
Then:
$ npm install --save-dev gulp-codo
Usage:
var gulp = codo = ; gulp;
Options:
- options: Object : Object containing any of the following options:
- name: string : Project name for generated documenation (e.g. Greeter).
- title: string : Title for generated documentation (e.g. Greeter documentation).
- readme: string: : Readme to use for generated documentation (e.g. greeter.md).
- dir: string : Output directory for documentation (e.g. ./doc).
- theme: string : The theme to be used (e.g. default).
- undocumented: boolean : List undocumented objects
- closure: boolean : Try to parse closure-like block comments
- private: boolean : Show privates
- verbose: boolean : Show parsing errors
- extra: string or Array : Add extra files (e.g. ['LICENSE.md'])