A clean, responsive documentation template theme for JSDoc 3.
$ npm install --save-dev tik-jsdoc-theme
Clone repository to your designatedjsdoc template directory, then:
$ jsdoc entry-file.js -t path/to/tik-jsdoc-theme
In your projectspackage.json file add a generate script:
"scripts": {"generate-docs":"node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"}In your.jsdoc.json file, add a template option.
"opts": {"template":"node_modules/tik-jsdoc-theme"}{"tags": {"allowUnknownTags":true,"dictionaries": ["jsdoc"] },"source": {"include": ["lib","package.json","README.md"],"includePattern":".js$","excludePattern":"(node_modules/|docs)" },"plugins": ["plugins/markdown" ],"templates": {"cleverLinks":false,"monospaceLinks":true,"useLongnameInNav":false,"showInheritedInNav":true },"opts": {"destination":"./docs/","encoding":"utf8","private":true,"recurse":true,"template":"./node_modules/tik-jsdoc-theme" }}Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).
Licensed under the Apache2 license.