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 --out docs src/index.ts

Note:

• If using with the default HTML theme or other themes, use --plugin none to switch the plugin off.
• The plugin should be executed in the same location as TypeDoc. Use npx if running command directly in shell.

Options

The following options can be used in addition to relevant TypeDoc options.

• --entryDocument<string> The file name of the entry document. Defaults to README.md.
• --hideBreadcrumbs<boolean> Do not render breadcrumbs in template header. Defaults to false.
• --hideInPageTOC<boolean> Do not render in-page table of contents items. Defaults to false.
• --publicPath<string> Specify the base path for all urls. If undefined urls will be relative. Defaults to ..
• --namedAnchors<boolean> Use HTML named anchors tags for implementations that do not assign header ids. Defaults to false.

Additional plugins and themes

If targeting specific static site generators or wiki platforms the following plugins and themes may be of interest:

Plugins

Plugins that integrates TypeDoc seamlessly with a particular platform ecosystem:

• Docusaurus v2 - docusaurus-plugin-typedoc
• VuePress - vuepress-plugin-typedoc

Themes

Themes that target output to particular Markdown platforms:

• GitHub Wiki - typedoc-github-wiki-theme
• GitLab Wiki - typedoc-gitlab-wiki-theme

License

MIT