apiguide
Generate jsdoc with theme colors
Installation
npm install apiguide --save-dev
Usage
'use strict'
const apiguide = require('apiguide')
apiguide([
'lib/**/*.js',
'README.md'
], {
destination: 'doc/apiguide',
verbose: true,
templates: {
color: '#38E'
}
}).then(() => {
/* ... */
})
Options
Key | Description |
---|---|
verbose | Verbose or not. |
tutorials | Directory path for tutorials. |
destination | Destination directory path. |
templates | Markup options. |
templates.systemName | Name of theme. |
templates.footer | Footer html. |
templates.copyright | Copyright string. |
templates.color | Theme color. |
License
This software is released under the MIT License.