PluginOptions

Describes the options declared by the plugin.

Properties

anchorPrefix

anchorPrefix: string

Custom anchor prefix when anchoring to in-page symbols.

blockTagsPreserveOrder

blockTagsPreserveOrder: string[]

Specifies comment block tags that should preserve their position.

classPropertiesFormat

classPropertiesFormat: "table" | "list" | "htmlTable"

Sets the format of property groups for classes.

entryFileName

entryFileName: string

The file name of the entry page.

entryModule

entryModule: string

The name of a module that should act as the root page for the documentation.

enumMembersFormat

enumMembersFormat: "table" | "list" | "htmlTable"

Sets the format of enumeration members.

excludeGroups

excludeGroups: boolean

Deprecated

This option has been renamed hideGroupHeadings to better reflect its purpose.

excludeScopesInPaths

excludeScopesInPaths: boolean

Exclude writing @ scope directories in paths.

expandObjects

expandObjects: boolean

Expand objects inside declarations.

expandParameters

expandParameters: boolean

Expand parameters in signature parentheses to display type information.

fileExtension

fileExtension: string

Specify the file extension for generated output files.

flattenOutputFiles

flattenOutputFiles: boolean

Flatten output files to a single directory.

formatWithPrettier

formatWithPrettier: boolean

Apply additional output formatting with Prettier.

hideBreadcrumbs

hideBreadcrumbs: boolean

Do not print breadcrumbs.

hideGroupHeadings

hideGroupHeadings: boolean

Excludes grouping by kind so all members are rendered at the same level.

hidePageHeader

hidePageHeader: boolean

Do not print page header.

hidePageTitle

hidePageTitle: boolean

Do not print page title.

indexFormat

indexFormat: "table" | "list" | "htmlTable"

Sets the format of index items.

interfacePropertiesFormat

interfacePropertiesFormat: "table" | "list" | "htmlTable"

Sets the format of property groups for interfaces.

membersWithOwnFile

membersWithOwnFile: ("Enum" | "Variable" | "Function" | "Class" | "Interface" | "TypeAlias")[]

Determines which members are exported to their own file.

mergeReadme

mergeReadme: boolean

Appends the documentation index page to the readme page.

modulesFileName

modulesFileName: string

The file name of the separate modules / index page.

navigationModel

navigationModel: object

excludeGroups

excludeGroups: boolean

excludeCategories

excludeCategories: boolean

excludeFolders

excludeFolders: boolean

Deprecated

This option has been deprecated in favour of TypeDoc navigation option.

outputFileStrategy

outputFileStrategy: "members" | "modules"

Determines how output files are generated.

pageTitleTemplates

pageTitleTemplates: object

Change specific text placeholders in the template.

index

index: string | (name) => string

member

member: string | (name) => string

module

module: string | (name) => string

parametersFormat

parametersFormat: "table" | "list" | "htmlTable"

Sets the format of parameter and type parameter groups.

preserveAnchorCasing

preserveAnchorCasing: boolean

Preserve anchor casing when generating link to symbols.

prettierConfigFile

prettierConfigFile: string

Specify a custom Prettier configuration file location.

propertiesFormat

propertiesFormat: "table" | "list" | "htmlTable"

Sets the format of property groups for interfaces and classes.

propertyMembersFormat

propertyMembersFormat: "table" | "list" | "htmlTable"

Sets the format of style for property members for interfaces and classes.

publicPath

publicPath: string

Specify the base path for all urls.

sanitizeComments

sanitizeComments: boolean

Sanitize HTML and JSX inside JsDoc comments.

tableColumnSettings

tableColumnSettings: object

Control how table columns are configured and displayed.

hideDefaults

hideDefaults: boolean

hideInherited

hideInherited: boolean

hideModifiers

hideModifiers: boolean

hideOverrides

hideOverrides: boolean

hideSources

hideSources: boolean

hideValues

hideValues: boolean

leftAlignHeaders

leftAlignHeaders: boolean

textContentMappings

textContentMappings: object

Change specific text placeholders in the template.

header.title

title: string

breadcrumbs.home

home: string

title.indexPage

indexPage: string

title.memberPage

memberPage: string

title.modulePage

modulePage: string

typeDeclarationFormat

typeDeclarationFormat: "table" | "list" | "htmlTable"

Sets the format of style for type declaration members.

typeDeclarationVisibility

typeDeclarationVisibility: "compact" | "verbose"

Set the visibility level for type declaration documentation.

useCodeBlocks

useCodeBlocks: boolean

Wraps signatures and declarations in code blocks.

useHTMLAnchors

useHTMLAnchors: boolean

Add HTML named anchors to headings and table rows.

useHTMLEncodedBrackets

useHTMLEncodedBrackets: boolean

Use HTML encoded entities for angle brackets.