gpbl / 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.

What it does?

The plugin will replace the default HTML theme with a built-in Markdown theme, and expose some additional arguments.

By default, the Markdown theme will attempt to render standard CommonMark, suitable for the majority of Markdown engines. It follows the same structure and file patterns as the default HTML theme.

Installation

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

Usage

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

Note:

• The --plugin arg is optional - if omitted all installed plugins will run.
• If using with the default HTML theme or other themes, use --plugin none to switch the plugin off.
• The plugin needs to be executed from the same location as typedoc. Either run as an npm script or make sure to run npx typedoc.

Arguments

The following arguments can be used in addition to the default TypeDoc arguments.

• --theme <markdown|docusaurus|docusaurus2|vuepress|bitbucket|path/to/theme>
  Specify the theme that should be used. Defaults to markdown. Please read Markdown Themes for further details.
• --namedAnchors
  Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.
• --hideSources
  Do not print source file link rendering.
• --hideBreadcrumbs
  Do not print breadcrumbs.

License

MIT