vivocha/docdash

Name: docdash

Owner: Vivocha

Description: Docdash inspired JSDoc 3 template / theme

Forked from: clenemt/docdash

Created: 2016-05-23 13:28:23.0

Updated: 2017-05-22 15:45:43.0

Pushed: 2017-05-22 15:45:17.0

Homepage:

Size: 249

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Vivocha Docdash

Usage

Clone repository to your designated jsdoc template directory, then:

doc entry-file.js -t path/to/docdash

Usage (npm)

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

ipt": {
enerate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"

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

s": {
emplate": "node_modules/docdash"

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/docdash/",
    "encoding": "utf8",
    "destination": "docs/",
    "recurse": true,
    "verbose": true
},
"templates": {
    "cleverLinks": false,
    "monospaceLinks": false
}

Thanks

Thanks to lodash and minami.

License

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