@sileigiser/typedoc-plugin-markdown

typedoc-plugin-markdown

A plugin for TypeDoc that renders TypeScript API documentation as Markdown.

What it does?

The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options.

Useful if documentation is required to be included in project README files, Wikis and static site generators.

Installation

npm install --save-dev typedoc typedoc-plugin-markdown

Usage

Usage is the same as documented at TypeDoc.

typedoc --plugin typedoc-plugin-markdown

The --plugin arg is optional (all plugins are loaded by default), however if using with the default html theme, use --plugin none to switch the plugin off.

Options

The following options can be used in addition to relevant TypeDoc options (please note that TypeDoc options specific to the html theme will be ignored).

Do not render breadcrumbs in template header. Defaults to false.

• --entryDocument
  The file name of the entry document. Defaults to README.md.
• --hideBreadcrumbs
  Do not render breadcrumbs in template header. Defaults to false.
• --hideInPageTOC
  Do not add special symbols for class members. Defaults to false.
• --hasOwnDocument
  Determines which symbols should be hoisted to their own document. Expected values are None, All OR Array of ['class', 'interface', 'enum', 'function', 'variable', 'type'] Defaults to None (all symbols included in a single module page). See directory strategy.
• --namedAnchors
  Use HTML named anchors tags for implementations that do not assign header ids. Defaults to false.
• --embedHeadingsInCodeBlock
  Wraps the heading of a reflection in a code block. Defaults to false.

License

MIT