Options

These options should be used in conjunction with the core TypeDoc options (see TypeDoc Usage).

File Options

Options that are used to configure how files are output.

Option	Description
`outputFileStrategy`	Determines how output files are generated.
`membersWithOwnFile`	Determines which members are exported to their own file.
`flattenOutputFiles`	Flatten output files to a single directory.
`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.
`entryModule`	The name of a module that should act as the root page for the documentation.
`excludeScopesInPaths`	Exclude writing @ scope directories in paths.

Options that are used to configure how the output is structured and displayed.

Option	Description
`hidePageHeader`	Do not print page header.
`hideBreadcrumbs`	Do not print breadcrumbs.
`hidePageTitle`	Do not print page title.
`hideGroupHeadings`	Excludes grouping by kind so all members are rendered at the same level.
`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.
`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.
`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.
`typeDeclarationVisibility`	Set the visibility level for type declaration documentation.
`tableColumnSettings`	Control how table columns are configured and displayed.

Options that are used for general configuration and utility purposes.

Option	Description
`formatWithPrettier`	Apply additional output formatting with Prettier.
`prettierConfigFile`	Specify a custom Prettier configuration file location.
`sanitizeComments`	Sanitize HTML and JSX inside JsDoc comments.
`publicPath`	Specify the base path for all urls.
`anchorPrefix`	Custom anchor prefix when anchoring to in-page symbols.
`useHTMLEncodedBrackets`	Use HTML encoded entities for angle brackets.
`useHTMLAnchors`	Add HTML anchors to page headings.
`preserveAnchorCasing`	Preserve anchor casing when generating link to symbols.
`pageTitleTemplates`	Change specific text placeholders in the template.