RadGrad specific JSDoc3 template uses semantic-ui to make it look more like RadGrad.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
fixtures
static
tmpl
.gitignore
LICENSE
README.md
package.json
publish.js

README.md

RadGrad JSDoc 3 Template

A Semantic UI documentation template theme for JSDoc 3.

Install

$ npm install radgrad-jsdoc-template

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t path/to/radgrad-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/radgrad-jsdoc-template"
}

Sample jsdoc.json

See the config file for the fixtures or the sample below.

{
    "tags": {
        "allowUnknownTags": false
    },
    "source": {
        "include": "../js",
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "opts": {
        "template": "assets/template/radgrad-jsdoc-template/",
        "encoding": "utf8",
        "destination": "docs/",
        "recurse": true,
        "verbose": true
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}

Thanks

Thanks to docdash.

License

Licensed under the Apache License, version 2.0. (see Apache-2.0).