ngdoc-md
Generate ngdoc with markdown format.
Installation
npm install ngdoc-md --g
Usage
Generate ngdoc documents from js source files.
$ ngdoc-md "src/javascripts/**/*.js" "docs/apiguide"
Options
$ ngdoc-md -h
Usage: ngdoc-md [options] <src> <dest>
Options:
-h, --help output usage information
-V, --version output the version number
-v, --verbose Show verbose log.
-b, --basedir <basedir> Working directory path.
Programmatic API
ngdoc-md
also provides programmatic API.
Install as a local module,
$ npm install ngdoc-md --save-dev
then,
#!/usr/bin/env node
var ngdocMd = require('ngdoc-md');
ngdocMd('src/javascripts/*.js', 'doc/apiguide', {}, function (err) {
/*...*/
});
License
This software is released under the MIT License.