SmoothJSDoc (based on minami)

A clean, responsive documentation template theme for JSDoc 3.

What's new :

• search engine
• expandable nav menu
• smooth navigation

Uses

• the Taffy Database library
• Underscore Template library
• Montserrat & Helvetica Neue
• minami

Install

1$ npm install --save-dev simple-jsdoc

Usage

Clone repository to your designated jsdoc template directory, then:

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

Node.js Dependency

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

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

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

1"opts": {
2  "template": "node_modules/smooth-jsdoc"
3}

Example JSDoc Config

1{
2    "tags": {
3        "allowUnknownTags": true,
4        "dictionaries": ["jsdoc"]
5    },
6    "source": {
7        "include": ["lib", "package.json", "README.md"],
8        "includePattern": ".js$",
9        "excludePattern": "(node_modules/|docs)"
10    },
11    "plugins": [
12        "plugins/markdown"
13    ],
14    "templates": {
15        "cleverLinks": false,
16        "monospaceLinks": true
17    },
18    "opts": {
19        "destination": "./docs/",
20        "encoding": "utf8",
21        "private": true,
22        "recurse": true,
23        "template": "./node_modules/smooth-jsdoc"
24    }
25}

License

Licensed under the Apache2 license.