A clean, responsive documentation template theme for JSDoc 3.
- the Taffy Database library
- Underscore Template library
- Montserrat & Helvetica Neue
$ npm install --save-dev minamiClone repository to your designated jsdoc template directory, then:
$ jsdoc entry-file.js -t path/to/minamiIn your projects package.json file add a generate script:
"script": { "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose" }In your .jsdoc.json file, add a template option.
"opts": { "template": "node_modules/minami" }{ "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 }, "opts": { "destination": "./docs/", "encoding": "utf8", "private": true, "recurse": true, "template": "./node_modules/minami" } }Licensed under the Apache2 license.