daybrush-jsdoc-template

1.10.0 • Public • Published

daybrush-jsdoc-template

npm package license

daybrush-jsdoc-template is a template based on the docdash template.

Install

$ npm install daybrush-jsdoc-template

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t path/to/daybrush-jsdoc-template

scene.js

$  jsdoc ./outjs ./README.md -d doc -t ./node_modules/daybrush-jsdoc-template

Usage (npm)

In your projects package.json file add a new script:

"script": {
  "generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}

In your jsdoc.json file, add a template option.

"opts": {
  "template": "node_modules/daybrush-jsdoc-template"
}

Package Sidebar

Install

npm i daybrush-jsdoc-template

Weekly Downloads

101

Version

1.10.0

License

Apache-2.0

Unpacked Size

207 kB

Total Files

48

Last publish

Collaborators

  • younkue