tache
A clean, responsive documentation template theme for JSDoc 3 inspired by slate and based on jsdoc-stale which is based on minami.
Install
With npm:
If you don't already have jsdoc installed globally:
npm i -g jsdocOR if you want to use jsdoc locally:
npm i --save-dev jsdocThen add tache as a dev dependency
npm install --save-dev tacheconfigure jsdoc
In your jsdoc configuration file, add a template option and plugins option
"plugins": [
"./node_modules/tache/"
]
"opts": {
"template": "./node_modules/tache"
}generate
jsdoc -c yourjsdocConfigfile entry-file.jsOR if you installed jsdoc locally:
./node_modules/.bin/jsdoc -c yourjsdocConfigfile entry-file.jsExample JSDoc Config
{
"plugins": [
"plugins/markdown",
"./node_modules/tache/"
],
"recurseDepth": 10,
"source": {
"include": ["package.json"],
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"templates": {
"cleverLinks": false,
"monospaceLinks": true,
"useLongnameInNav": false,
"showInheritedInNav": true
},
"opts": {
"template": "./node_modules/tache",
"destination": "docs",
"package": "package.json"
},
"articles": [
"**/*.md",
"**/*.markdown"
],
"markdown": {
"idInHeadings": true
}
}Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).
License
Licensed under the Apache2 license.
