@alexispuga/jsdoc-template NPM

JSDoc Template

A decent template for JSDoc, redesigned from the default template.

Use it

Installing it via npm

npm i @alexispuga/jsdoc-template
jsdoc your/files -t ./node_modules/@alexispuga/jsdoc-template

Previews

Customize it

Make this template yours too:

Create a jsdoc.config.js file.
Modify it (see all supported properties).
Load it from jsdoc: jsdoc your/files -t this/template -c your/jsdoc.config.js.

Examples

Changing the default font (the simplest way)

// jsdoc.config.js

module.exports = {
    templates: {
        // Options for this template.
        custom: {
            tags: {
                head: [
                    `<style>body, html { font-family: serif; }</style>`
                ]
            }
        }
    }
}

Changing the theme for the prettified code and replacing it with my own (this time by using a JSON)

{
    "templates": {
        "default": {
            "staticFiles": {
                "include": [
                    "./path/to/your/theme.css"
                ]
            }
        },
        "custom": {
            "themes": {
                "prettify": "theme.css"
            }
        }
    }
}

Changing the site name and adding a favicon

// jsdoc.config.js

module.exports = {
    templates: {
        default: {
            staticFiles: {
                include: [
                    'path/to/your/favicon-32x32.png'
                ]
            }
        },
        custom: {
            siteName: 'My site',
            tags: {
                head: [
                    `<link href="favicon-32x32.png" rel="icon" sizes="32x32" type="image/png"/>`
                ]
            }
        }
    } 
};