1.0.0 • Published 5 years ago
jsdoc-ilafolt v1.0.0
Minami
Funny theme for JSDoc 3.
Fork from Minami.
Uses
- the Taffy Database library
- Underscore Template library
- Montserrat & Helvetica Neue
Install
$ npm install --save-dev jsdoc-ilafolt
Usage
Clone repository to your designated jsdoc
template directory, then:
$ jsdoc entry-file.js -t path/to/jsdoc-ilafolt
Node.js Dependency
In your projects package.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/jsdoc-ilafolt"
}
Example JSDoc Config
{
"templates": {
"title": "ilafolt",
"navigates": [
{
"text": "Text",
"url": "your/url",
"_blank": true
}
]
}
}