README
Minami template, customized to better describe Sails.js structure:
- models described as classes of module:Models
- controllers described as classes of module:Controllers
- etc ...
UI translated to russian. [not full translation]
All parts forked from original minami module
A clean, responsive documentation template theme for JSDoc 3.
Customized theme:
Original theme:
Uses
- the Taffy Database library
- Underscore Template library
- Montserrat & Helvetica Neue
Install
$ npm install --save-dev minami_customized
Usage
Clone repository to your designated jsdoc
template directory, then:
$ jsdoc entry-file.js -t path/to/minami_customized
Node.js Dependency
In 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_customized "
}
Example JSDoc Config
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": ["lib", "package.json", "README.md"],
"includePattern": ".js