This repository has been archived by the owner on Mar 27, 2023. It is now read-only.
air-jsdoc-template 1.0.8
Install from the command line:
Learn more about npm packages
$ npm install @airthium/air-jsdoc-template@1.0.8
Install via package.json:
"@airthium/air-jsdoc-template": "1.0.8"
About this version
Inspired from the JSDoc default template.
Add sub-namespaces support, search, favicon, title block, code highlight, ...
Uses Materialize.
Options take place in the templateOptions attribute of the jsdoc configuration file.
icon {string}
Icon to be displayed on the side menu.
Example:
"icon": "./icon.png",title {string}
Title to be displayed on the side menu.
Example:
"title": "Air JSDoc Template",subTitle {string}
Subtitle to be displayed on the side menu.
Example:
"subTitle": "JSDoc template",favicon {string}
Favicon.
Example:
"favicon": "./icon.png",menu {Array}
Menu items to append just after the title.
Example:
"menu": [
{
"label": "Github repository",
"link": "https://github.com/Airthium/air-jsdoc-template"
}
]footer {string}
Footer.
Example:
"footer": "Copyright © 2021 Airthium"