petrbela / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

Installation

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

Usage

The plugin provides an additional theme named 'markdown' that can be referenced by name:

$ typedoc --theme markdown [plugin args] [typedoc args]

Arguments

By default the theme will render standard GitHub Flavored Markdown suitable for the majority of markdown engines.

Configuring output

• --namedAnchors
  Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.

Controlling the visibility of components

• --hideProjectTitle
  Suppress project title (Home/README link) rendering.
• --hideBreadcrumbs
  Suppress breadcrumb rendering.
• --hideIndexes
  Suppress indexes rendering.
• --hideSources
  Suppress source file link rendering.

Acknowledgements

Thanks to kimamula's typedoc-markdown-theme for the inspiration behind this project.