1.0.0 • Published 10 months ago

typedoc-plugin-document-page-headings v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

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:

OptionTypeDefaultDescription
omitDocumentTypeInPageHeadingsbooleanfalseWhen set the "Document" type will be omitted from page headings.
typedocplugintypedoc-plugintypedocplugindocumentdocumentspageheadingheadings
jsdom
1.0.0

10 months ago