jsdoc-stock

JSDocStock

A template for JSDoc 4. Forked from github.com/nijikokun/minami.

Install

$ npm install --save-dev jsdoc-stock

Usage

Clone repository to your designated jsdoc template directory, then:

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

Node.js Dependency

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

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

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

"opts": {
  "template": "node_modules/jsdoc-stock"
}

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,
        "logo": "path/to/logo",
        "default": {
            "staticFiles": {
                "include": ["docs-src/"]
            }
        }
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/jsdoc-stock"
    }
}

Configuration Options

option	type	description	default
logo	String	path to logo in staticFiles	none
nav.titles	Array[String]	which type titles to include	all
nav.sections	Array[String]	which sections to include	all
nav.icons	Boolean	to render icons for type next to item	true
footer	Boolean,String	what to render in footer, false for nothing	default footer

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.