Postman JSDoc3 Theme
A clean, responsive documentation template theme for JSDoc 3, based on LatoDoc
Install
$ npm install --save-dev postman-jsdoc-theme
Usage
Clone repository to your designated jsdoc
template directory, then:
$ jsdoc entry-file.js -t path/to/postman-jsdoc-theme
Optionally, provide a package version on the command line, which will be rendered into the final documentation
$ jsdoc entry-file.js -t path/to/postman-jsdoc-theme --query 'pkgVersion=2.3.0'
Node.js Dependency
In your projects package.json
file add a generate script:
"script":
In your .jsdoc.json
file, add a template option.
"opts":
Example JSDoc Config
License
Licensed under the MIT license.