typedoc-plugin-markdown

Please note this pre-release version may contain breaking changes within the same semantic version.

A plugin for TypeDoc that renders TypeScript API documentation as Markdown.

Contents

• What does it do?
• Installation
• Usage
• Plugin Options
• Custom templates
• Contributing
• License

What does it do?

By default, TypeDoc will render API documentation as a webpage, e.g. HTML files.

The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options. This is useful if documentation is required to be included in project README files, Wikis and static site generators.

Installation

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

Usage

How to load the plugin?

Plugins are loaded by using the plugin configuration option:

Via the command line.

typedoc --plugin typedoc-plugin-markdown

Using a typedoc.json config file or under the typedocOptions key in tsconfig.json.

{ "plugin": ["typedoc-plugin-markdown"] }

Please see https://typedoc.org/options/configuration for general TypeDoc option configuration.

What TypeDoc options are supported?

• All of TypeDoc's Configuration, Input and Organization options are all respected as these are executed at the conversion phase of the project.

• TypeDoc's Output options are relevant to the rendering phase and in the main HTML output specific and are ignored by this plugin with the exception of --out and --cleanOutputDir.

Plugin Options

This plugin exposes additional options. Please see Options Guide for detailed usage.

Output Options

Options that define how output files are generated.

• --outputFileStrategy
• --includeFileNumberPrefixes
• --flattenOutputFiles
• --entryFileName
• --indexFileName
• --indexPageTitle
• --skipIndexPage
• --preserveAnchorCasing
• --anchorPrefix

UI Options

UI Options

• --excludeGroups
• --hidePageHeader
• --hidePageTitle
• --hideBreadcrumbs
• --hideInPageTOC
• --hideHierarchy
• --identifiersAsCodeBlocks
• --propertiesFormat
• --enumMembersFormat
• --typeDeclarationFormat
• --tocFormat
• --titleTemplate

Custom templates

Coming soon

Contributing

Contributions and suggestions are welcome. Please see the contributing guidelines for further details.

License

MIT