A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami
npm install docdashA clean, responsive documentation template theme for JSDoc 4.
``bash`
$ npm install docdash
template directory, then:`bash
$ jsdoc entry-file.js -t path/to/docdash
`Usage (npm)
In your projects package.json file add a new script:`json
"script": {
"generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}
`In your
jsdoc.json file, add a template option.`json
"opts": {
"template": "node_modules/docdash"
}
`Sample
jsdoc.json
See the config file for the fixtures or the sample below.`json
{
"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
}
}
`Options
Docdash supports the following options:`json5
{
"docdash": {
"static": [false|true], // Display the static members inside the navbar
"sort": [false|true], // Sort the methods in the navbar
"sectionOrder": [ // Order the main section in the navbar (default order shown here)
"Classes",
"Modules",
"Externals",
"Events",
"Namespaces",
"Mixins",
"Tutorials",
"Interfaces"
],
"disqus": "", // Shortname for your disqus (subdomain during site creation)
"openGraph": { // Open Graph options (mostly for Facebook and other sites to easily extract meta information)
"title": "", // Title of the website
"type": "website", // Type of the website
"image": "", // Main image/logo
"site_name": "", // Site name
"url": "" // Main canonical URL for the main page of the site
},
"meta": { // Meta information options (mostly for search engines that have not indexed your site yet)
"title": "", // Also will be used as postfix to actualy page title, prefixed with object/document name
"description": "", // Description of overal contents of your website
"keyword": "" // Keywords for search engines
},
"search": [false|true], // Display seach box above navigation which allows to search/filter navigation items
"commonNav": [false|true], // Group all html code for `Place them anywhere inside your
jsdoc.json` file.