TypeDoc Options

This plugin is like any other TypeDoc plugin and is fully compatible with the TypeDoc ecosystem, supporting other plugins (not specifically targetting HTML output) and the majority of TypeDoc’s options.

Conversion Options

The majority of TypeDoc’s options  are used internally by TypeDoc during conversion.

These options are output/theme agnostic and can be set in the same way as you would with the HTML theme:

• Configuration  ✅
• Input  ✅
• Comments  ✅
• Organization  ✅
• Validation  ✅
• Other  ✅

Output Options

TypeDoc’s Output  options are used by the renderer and theme. The majority of these options are specific to HTML output and are not applicable to Markdown output.

Below is a list of which TypeDoc Output options are supported:

• --out ✅
• --cleanOutputDir ✅
• --router ✅ (See Output File Structure)
• --lang ✅
• --locales ✅
• --githubPages ✅ (defaults to false)
• --includeHierarchySummary ✅ (defaults to false)
• --navigation ✅ (See Utilizing Navigation)

All other output options will have no effect on the Markdown output.