@amilajack/typedoc-plugin-markdown v3.0.12-alpha1

typedoc-plugin-markdown

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

What it does?

The plugin will replaces the default HTML theme with a built-in Markdown 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.

• --hideProjectName<boolean> Do not render project name in template header. Defaults to false.
• --hideBreadcrumbs<boolean> Do not render breadcrumbs in template header. Defaults to false.
• --publicPath<string> Specify the base path for all urls. If undefined urls will be relative. Defaults to undefined.
• --namedAnchors<boolean> Use HTML named anchors tags for implementations that do not assign header ids. Defaults to false.

Additional plugins

If using specifically for Docusaurus v2 or VuePress check out the respective plugin for the platform:

• docusaurus-plugin-typedoc
• vuepress-plugin-typedoc

License

MIT