A JSDoc theme and plugin collection based on Minami and Loke.
npm install c2cs-jsdoc
This project provides JSDoc and a collection of plugin's that we use at
C2C Schools, LLC for most of our Node.js projects.
It abbreviates the necessary dependencies for our projects, allowing us to include
fewer libraries for our JSDoc generation needs.
We wanted a simple way to add JSDoc documentation to all (or most) of our Javascript
projects without needing to train each of our developers on the intricacies of
JSDoc execution and configuration. Our hope was that this, in turn, would lead
to a wider adoption rate of JSDoc in our internal projects.
We also wanted to make our JSDoc output more consistent.
Use NPM to install this library as a devDependency of your project:
``shell`
$ npm install --save-dev --save-exact c2cs-jsdoc
conf/docs/html.json
`javascript`
{
"source" : {
"include" : [
"lib",
"package.json",
"README.md"
],
"includePattern" : ".js$",
"excludePattern" : "(node_modules/|docs)"
},
"opts" : {
"destination" : "./doc/html/",
"template" : "./node_modules/c2cs-jsdoc"
}
}
`shell``
$ cd /path/to/myproject
$ node node_modules/c2cs-jsdoc/node_modules/jsdoc/jsdoc.js --configure conf/docs/html.json
The above example is a minimal implementation. You should, at least, add your
documentation generation to an "npm script". More information about that is
outlined in the Usage Document.
* Usage
* Configuration
* Developing
* Dependency Documentation
* Acknowledgements