Docdash

A clean, responsive documentation template theme for JSDoc 4.

Example

See http://clenemt.github.io/docdash/ for a sample demo. :rocket:

Install

1$ npm install docdash

Usage

Clone repository to your designated jsdoc template directory, then:

1$ jsdoc entry-file.js -t path/to/docdash

Usage (npm)

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

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

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

1"opts": {
2  "template": "node_modules/docdash"
3}

Sample jsdoc.json

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

1{
2    "tags": {
3        "allowUnknownTags": false
4    },
5    "source": {
6        "include": "../js",
7        "includePattern": "\\.js$",
8        "excludePattern": "(node_modules/|docs)"
9    },
10    "plugins": [
11        "plugins/markdown"
12    ],
13    "opts": {
14        "template": "assets/template/docdash/",
15        "encoding": "utf8",
16        "destination": "docs/",
17        "recurse": true,
18        "verbose": true
19    },
20    "templates": {
21        "cleverLinks": false,
22        "monospaceLinks": false
23    }
24}

Options

Docdash supports the following options:

1{
2    "docdash": {
3        "static": [false|true],         // Display the static members inside the navbar
4        "sort": [false|true],           // Sort the methods in the navbar
5        "sectionOrder": [               // Order the main section in the navbar (default order shown here)
6             "Classes",
7             "Modules",
8             "Externals",
9             "Events",
10             "Namespaces",
11             "Mixins",
12             "Tutorials",
13             "Interfaces"
14        ],
15        "disqus": "",                   // Shortname for your disqus (subdomain during site creation)
16        "openGraph": {                  // Open Graph options (mostly for Facebook and other sites to easily extract meta information)
17            "title": "",                // Title of the website
18            "type": "website",          // Type of the website
19            "image": "",                // Main image/logo
20            "site_name": "",            // Site name
21            "url": ""                   // Main canonical URL for the main page of the site
22        },
23        "meta": {                       // Meta information options (mostly for search engines that have not indexed your site yet)
24            "title": "",                // Also will be used as postfix to actualy page title, prefixed with object/document name
25            "description": "",          // Description of overal contents of your website
26            "keyword": ""               // Keywords for search engines
27        },
28        "search": [false|true],         // Display seach box above navigation which allows to search/filter navigation items
29        "commonNav": [false|true],      // Group all html code for <nav> in a nav.inc.html fetched on each page (instead of include it in each html page, save {navSize}×{nb html pages} which can be huge on big project)
30        "collapse": [false|true|top],   // Collapse navigation by default except current object's navigation of the current page, top for top level collapse
31        "wrap": [false|true],           // Wrap long navigation names instead of trimming them
32        "typedefs": [false|true],       // Include typedefs in menu
33        "navLevel": [integer],          // depth level to show in navbar, starting at 0 (false or -1 to disable)
34        "private": [false|true],        // set to false to not show @private in navbar
35        "removeQuotes": [none|all|trim],// Remove single and double quotes, trim removes only surrounding ones
36        "scripts": [],                  // Array of external (or relative local copied using templates.default.staticFiles.include) js or css files to inject into HTML,
37        "ShortenTypes": [false|true], // If set to true this will resolve the display name of all types as the shortened name only (after the final period).
38        "menu": {                       // Adding additional menu items after Home
39            "Project Website": {        // Menu item name
40                "href":"https://myproject.com", //the rest of HTML properties to add to manu item
41                "target":"_blank",
42                "class":"menu-item",
43                "id":"website_link"
44            },
45            "Forum": {
46                "href":"https://myproject.com.forum",
47                "target":"_blank",
48                "class":"menu-item",
49                "id":"forum_link"
50            }
51        },
52        "scopeInOutputPath": [false|true], // Add scope from package file (if present) to the output path, true by default.
53        "nameInOutputPath": [false|true], // Add name from package file to the output path, true by default.
54        "versionInOutputPath": [false|true] // Add package version to the output path, true by default. 
55    }
56}

Place them anywhere inside your jsdoc.json file.

Contributors

Thanks to lodash and minami.

License

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