Skip to content
Clean and minimal JSDoc 3 Template / Theme
JavaScript CSS
Branch: master
Clone or download
Pull request Compare This branch is 8 commits ahead of nijikokun:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
static
tmpl
.gitignore
LICENSE
README.md
package.json
publish.js

README.md

Minami

A clean, responsive documentation template theme for JSDoc 3.

Minami Screenshot

Uses

Install

$ npm install --save-dev minami

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t path/to/minami

Node.js Dependency

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

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

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

"opts": {
  "template": "node_modules/minami"
}

Example JSDoc Config

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc"]
    },
    "source": {
        "include": ["lib", "package.json", "README.md"],
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": true,
        "useLongnameInNav": false,
        "showInheritedInNav": true
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/minami"
    }
}

Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).

License

Licensed under the Apache2 license.

You can’t perform that action at this time.