@airthium/air-jsdoc-template
v1.0.13
Published
Air JSDoc template
Downloads
167
Maintainers
Readme
Air JSDoc template
Inspired from the JSDoc default template.
Add sub-namespaces support, search, favicon, title block, code highlight, ...
Uses Materialize.
Options
Options take place in the templateOptions
attribute of the jsdoc configuration file.
Icon
icon {string}
Icon to be displayed on the side menu.
Example:
"icon": "./icon.png",
Title
title {string}
Title to be displayed on the side menu.
Example:
"title": "Air JSDoc Template",
Subtitle
subTitle {string}
Subtitle to be displayed on the side menu.
Example:
"subTitle": "JSDoc template",
Favicon
favicon {string}
Favicon.
Example:
"favicon": "./icon.png",
Menu
menu {Array}
Menu items to append just after the title.
Example:
"menu": [
{
"label": "Github repository",
"link": "https://github.com/Airthium/air-jsdoc-template"
}
]
Footer
footer {string}
Footer.
Example:
"footer": "Copyright © 2021 Airthium"