Name: docdash
Description: :zap: Lodash inspired JSDoc 3 template/theme
Created: 2016-02-29 14:12:20.0
Updated: 2018-01-19 14:36:12.0
Pushed: 2017-11-24 11:56:23.0
Homepage: http://clenemt.github.io/docdash/
Size: 197
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
A clean, responsive documentation template theme for JSDoc 3.
See http://clenemt.github.io/docdash/ for a sample demo. :rocket:
m install docdash
Clone repository to your designated jsdoc
template directory, then:
doc entry-file.js -t path/to/docdash
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"
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
}
Docdash supports the following options:
"docdash": {
"static": [false|true], // Display the static members inside the navbar
"sort": [false|true] // Sort the methods in the navbar
}
Place them anywhere inside your jsdoc.json
file.
Licensed under the Apache License, version 2.0. (see Apache-2.0).