typedoc-plugin-markdown

A plugin for TypeDoc that renders TypeScript API documentation as MDX 2 files. (By default, TypeDoc will render API documentation as a webpage, e.g. HTML files.) The code is an adoption from the original typedoc-plugin-markdown extended to produce MDX 2 files for Storybook.

What does it do?

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

Note that the plugin switches the default HTML theme to the built-in Markdown theme by default. If you want to use the default HTML theme instead, use --plugin none to turn the plugin off.

Options

This plugin provides additional options beyond the normal options that are provided by TypeDoc, which are listed below. Note that any vanilla TypeDoc options that customize the HTML theme will be ignored.

• --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.
• --hideMembersSymbol<boolean>
  Do not add special symbols for class members. 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.
• --preserveAnchorCasing<boolean>
  Preserve anchor id casing for implementations where original case is desirable. Defaults to false.

License

MIT