typedoc-plugin-document-page-headings
v1.0.0
Published
A plugin for TypeDoc that adds page headings to document files
Downloads
11
Maintainers
Readme
typedoc-plugin-document-page-headings
A plugin for TypeDoc that adds page headings to document files.
Example
A basic example is available at https://mrfigg.github.io/typedoc-plugin-document-page-headings.
Installation
$ npm install -D typedoc-plugin-document-page-headings
Options
The following options are added to TypeDoc when the plugin is installed:
| Option | Type | Default | Description |
| ---------------------------------- | ------- | ------- | ---------------------------------------------------------------- |
| omitDocumentTypeInPageHeadings | boolean | false
| When set the "Document" type will be omitted from page headings. |