DKDoc is a custom dark theme for JSDoc 3 and uses CodeMirror 5.65.0 to display the source code.
NOTE:
CodeMirror is includes as npm dependency and the files used are minimized and integrated in the documentation.
The DKDoc template uses also SimpleBar for the custom scrollbar (available through UNPKG).
npm i @kdominic/dkdoc
- Simple Searchbox for Classes / Members / Methods
- Collapsible
"opts": {
"template": "node_modules/@kdominic/dkdoc"
}
"templates": {
"title": "{string} [title=Documentation]"
}
"templates": {
"logo": "{string|null|Object} [logo=DKDoc]"
}
OR
"templates": {
"logo": {
"type": "text",
"src": "{string} [src=DKDoc]"
}
}
"templates": {
"logo": {
"type": "img",
"src": "{string} <path to image>"
}
}
"templates": {
"logo": {
"type": "{string|null} [type=text]",
"src": "{string} [src=DKDoc]",
"link": "{string} <page address>",
}
}
"templates": {
"logo": null
}
NOTE: You can also set logo to "none" or logo.type to null or "none" to disable the logo.
"templates": {
"collapsibleNav": "{boolean} [collapsibleNav=false]"
}
"templates": {
"footer": "{string} [title=Documentation generated by {@link JSDoc <version>}]"
}