README
Docdash
A clean, responsive documentation template theme for JSDoc 3.
Example
See http://clenemt.github.io/docdash/ for a sample demo. :rocket:
Install
$ npm install docdash
Usage
Clone repository to your designated jsdoc
template directory, then:
$ jsdoc entry-file.js -t path/to/docdash
Usage (npm)
In your projects package.json
file add a new script:
"script": {
"generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}
In your jsdoc.json
file, add a template option.
"opts": {
"template": "node_modules/docdash"
}
jsdoc.json
Sample See the config file for the fixtures or the sample below.
{
"tags": {
"allowUnknownTags": false
},
"source": {
"include": "../js",
"includePattern": ".js