jamsyoung/turner-jsdoc-template

Turner - A JSDoc Template

Turner - A JSDoc Template

This is a custom template for JSDoc. It is a modified version of the default template that comes with jsdoc-3.3.0-alpha13 to fit my needs. This is free to use and open for community input. Feel free to create issues and pull requests.

How to use on the command line

$ jsdoc some/javascript.js -t path/to/turner-jsdoc-template/turner

How to use as a node dependency

In your projects package.json file add a script and a dependency.

"script": {
    "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc-conf.json --verbose"
},
"devDependencies": {
    "jsdoc": "3.3.0-alpha13",
    "turner-jsdoc-template": "git+https://github.com/jamsyoung/turner-jsdoc-template.git#0.1.3"
}

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

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

Here is my full .jsdoc-conf.json file for context.

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