Output File Structure

TypeDoc generates documentation models according to exports derived from the given entryPoints and entryPointsStrategy TypeDoc configurations.

TypeDoc 0.28.0 introduced an additional "router" option which can be used to modify the output folder structure.

The plugin now utilises this mechanism for output file generation.

Plugin Routers

The plugin ships with the following custom built-in routers:

“member” (default)

typedoc.json


{
  "router": "member"
}

Note: This is equivalent to the deprecated outputFileStrategy="members".

Generates an individual file for each exported module member kind. Pages are grouped by kind within their respective module hierarchy.

This mirrors a combination of TypeDoc’s kind and structure routers.

This is the default router of the plugin.

README.md
- - ClassA.md
  - ClassB.md
- - FunctionA.md
  - FunctionB.md
- - ClassA.md
  - ClassB.md

”module”

typedoc.json


{
  "router": "module"
}

Note: This is equivalent to the deprecated outputFileStrategy="modules".

Generates a single file for every module and namespace where all module members are hoisted to a single file.

This creates a flat navigation structure and reduces the amount of files generated.

README.md
module-a.md
module-b.md

Core Routers

typedoc.json


{
  "router": "kind"
}

TypeDoc ships with several built-in routers used by the HTML theme. These routers are decorated to fix the .html extension and additionally support the file options of this plugin.

This provides the ability to generate output files in the same structure as the default HTML theme but rendered using the plugin’s Markdown theme.

Please see TypeDoc’s router documentation for details of available core routers.