Air JSDoc template

Live demo

Inspired from the JSDoc default template.

Add sub-namespaces support, search, favicon, title block, code highlight, ...

Uses Materialize.

!Screenshot

Options

Options take place in the templateOptions attribute of the jsdoc configuration file.

$3

icon {string}

Icon to be displayed on the side menu.

Example:

``json
"icon": "./icon.png",
`

$3

title {string}

Title to be displayed on the side menu.

Example:

`json
"title": "Air JSDoc Template",
`

$3

subTitle {string}

Subtitle to be displayed on the side menu.

Example:

`json
"subTitle": "JSDoc template",
`

$3

favicon {string}

Favicon.

Example:

`json
"favicon": "./icon.png",
`

$3

menu {Array}

Menu items to append just after the title.

Example:

`json
"menu": [
{
"label": "Github repository",
"link": "https://github.com/Airthium/air-jsdoc-template"
}
]
`

$3

footer {string}

Footer.

Example:

`json
"footer": "Copyright © 2021 Airthium"
``