@kdominic/dkdoc v1.1.0

DKDoc

DKDoc is a custom dark theme for JSDoc 3 and uses CodeMirror 5.64.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).

Installation

npm i @kdominic/dkdoc

Feature

Navigation

• Simple Searchbox for Classes / Members / Methods
• Collapsible

Configuration

(jsdoc page - configuration)

Template

"opts": {
    "template": "node_modules/@kdominic/dkdoc"
}

Page Title

"templates": {
    "title": "{string} [title=Documentation]"
}

Page Logo

Text

"templates": {
    "logo": "{string|null|Object} [logo=DKDoc]"
}

OR

"templates": {
    "logo": {
        "type": "text",
        "src":  "{string} [src=DKDoc]"
    }
}

Image

"templates": {
    "logo": {
        "type": "img",
        "src":  "{string} <path to image>"
    }
}

Make logo to link

"templates": {
    "logo": {
        "type": "{string|null} [type=text]",
        "src":  "{string} [src=DKDoc]",
        "link": "{string} <page address>",
    }
}

Disable logo

"templates": {
    "logo": null
}

NOTE: You can also set logo to "none" or logo.type to null or "none" to disable the logo.

Collapsible Navigation

"templates": {
    "collapsibleNav": "{boolean} [collapsibleNav=false]"
}

Page Footer

"templates": {
    "footer": "{string} [title=Documentation generated by {@link JSDoc <version>}]"
}