Options
This page provides an overview of all available options for the plugin. It includes both the core options provided by TypeDoc (where supported) and the additional options added by this plugin.
TypeDoc Options
TypeDoc exposes many options, most of which this plugin supports while others are HTML-only and ignored.
Output
Output options control TypeDoc’s generated output. These options mainly apply to TypeDoc’s default HTML renderer, but this plugin supports or extends a subset.
The options listed here are the output options that this plugin supports or extends.
| Option Name | Description |
|---|---|
| outputs | Specifies the outputs which should be rendered by TypeDoc. |
| out | Specifies the location the markdown should be written to. |
| router | Selects the router used to determine the file and folder structure. |
| lang | Sets the language of the translations used when generating documentation. |
| cleanOutputDir | Used to prevent TypeDoc from cleaning the output directory. |
| navigation | Determines how the navigation JSON structure will be built. |
| includeHierarchySummary | Specifies whether or not to generate a dedicated hierarchy page. |
Conversion
Conversion options control how TypeDoc analyzes the source code and builds the reflection models. They are theme-agnostic and are not affected by this plugin.
The option groups listed here link directly to the TypeDoc documentation website.
| Option Group | Description |
|---|---|
| Configuration | Options that control where TypeDoc reads its configuration from. |
| Input | Options that control what files TypeDoc processes. |
| Comments | Options that control how TypeDoc parses comments. |
| Organization | Options that control how content is structured on generated pages. |
| Validation | Options that control how TypeDoc validates your documentation. |
| Other | Options which don’t fit elsewhere. |
Plugin Options
In addition to the TypeDoc core options, this plugin provides its own options. They can be viewed as a subset of output-related options specific to this plugin’s functionality.
File
File options are used by the plugin’s
router to configure file output details.
| Option Name | Description |
|---|---|
| fileExtension | Specify the file extension for generated output files. |
| entryFileName | The file name of the entry page. |
| modulesFileName | The file name of the separate modules / index page. |
| mergeReadme | Appends the documentation index page to the readme page. |
| flattenOutputFiles | Flatten output files to a single directory. |
| excludeScopesInPaths | Exclude writing @ scope directories in paths. |
Display
Display options are used to configure how the output is structured and displayed.
| Option Name | Description |
|---|---|
| hidePageHeader | Hide the page header. |
| hideBreadcrumbs | Hide the page breadcrumbs. |
| hidePageTitle | Hide the page title. |
| useCodeBlocks | Wraps signatures and declarations in code blocks. |
| expandObjects | Expand objects inside declarations. |
| expandParameters | Expand parameters in signature parentheses to display type information. |
| blockTagsPreserveOrder | Specifies comment block tags that should preserve their position. |
| strikeDeprecatedPageTitles | Controls whether to strikethrough page titles of deprecated items. |
| indexFormat | Sets the format of index items. |
| parametersFormat | Sets the format of parameter and type parameter groups. |
| interfacePropertiesFormat | Sets the format of property groups for interfaces. |
| classPropertiesFormat | Sets the format of property groups for classes. |
| typeAliasPropertiesFormat | Sets the format of style for type alias properties. |
| enumMembersFormat | Sets the format of enumeration members. |
| propertyMembersFormat | Sets the format of style for property members for interfaces and classes. |
| typeDeclarationFormat | Sets the format of style for type declaration members. |
| pageTitleTemplates | Configure page title output with placeholders. |
| tableColumnSettings | Control how table columns are configured and displayed. |
Utility
Utility options are used for general configuration and utility purposes.
| Option Name | Description |
|---|---|
| formatWithPrettier | Apply additional output formatting with Prettier. |
| prettierConfigFile | Specify a custom Prettier configuration file location. |
| publicPath | Specify the base path for all urls. |
| useHTMLEncodedBrackets | Use HTML encoded entities for angle brackets. |
| useCustomAnchors | Add custom anchors like {#custom-id} to headings. |
| customAnchorsFormat | The format of custom anchors. |
| useHTMLAnchors | Add HTML anchors to page headings. |
| anchorPrefix | Custom anchor prefix to add to anchor links. |
| sanitizeComments | Sanitize HTML and JSX inside JsDoc comments. |
| navigationJson | Specifies the file path where the navigation JSON will be written. |