typedoc.json

Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory

Specify a TypeScript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory

Selectively override the TypeScript compiler options used by TypeDoc

Sets the language to be used in generation and in TypeDoc's messages

Add translations for a specified locale. This option is primarily intended to be used as a stopgap while waiting for official locale support to be added to TypeDoc

Set options which will be set within each package when entryPointStrategy is set to packages

The entry points of your documentation

The strategy to be used to convert entry points into documentation modules

When set, TypeDoc will always create a Module for entry points, even if only one is provided

Documents which should be added as children to the root of the generated documentation. Supports globs to match multiple files

Define patterns to be excluded when expanding a directory that was specified as an entry point

Define patterns for files that should be considered being external

Prevent externally resolved symbols from being documented

Prevent symbols that are not explicitly documented from appearing in the results

Specify the type of reflections that can be removed by excludeNotDocumented

Prevent symbols that are marked with @internal from being documented

Exclude symbols within this category from the documentation

Ignore members marked with the private keyword and #private class fields, defaults to true.

Ignore #private class fields, defaults to true.

Ignore protected variables and methods

If a symbol is exported multiple times, ignore all but the first export

Define custom links for symbols not included in the documentation

Path to the readme file that should be displayed on the index page. Pass none to disable the index page and start the documentation on the globals page

Specifies a path which links may be resolved relative to.

Specify the location the documentation for the default output should be written to. The default output type may be changed by plugins.

Specify the location the documentation for the default output should be written to. The default output type may be changed by plugins.

Specify the location where html documentation should be written to.

Specify the location and filename a JSON file describing the project is written to

Specify whether the output JSON should be formatted with tabs

Specify what TypeDoc should emit, 'docs', 'both', or 'none'

Specify the theme name to render the documentation with

Specify the router name to use to determine file names in the documentation

Specify the code highlighting theme in light mode

Specify the code highlighting theme in dark mode

Specify the languages which will be loaded to highlight code when rendering

Specify languages which will be accepted as valid highlight languages, but will not be highlighted at runtime

Width at which to wrap code to a new line when rendering a type

Path to a custom CSS file to for the theme to import

Path to a custom JS file to import

Specify the options passed to markdown-it, the Markdown parser used by TypeDoc

Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use

Set the maximum depth of types to be converted

Set the name of the project that will be used in the header of the template

Add the package version to the project name

Disable setting the source of a reflection when documenting it

Specify a link template to be used when generating source urls. If not set, will be automatically created using the git remote. Supports {path}, {line}, {gitRevision} placeholders

Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set

Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set

Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath

Specifies the base path to be used when displaying file paths. If not specified, basePath is used.

Set the CNAME file text, it's useful for custom domains on GitHub Pages

Path to favicon to include as the site icon

Specifies that source links should be treated as external links to be opened in a new tab

Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab

Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to true

Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated

If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option

Do not print the TypeDoc link at the end of the page

Custom footer after the TypeDoc link

If set, disables the wrapper element for customFooterHtml

Include the generation time in links to static assets

If set, the search index will also include comments. This will greatly increase the size of the search index

If set, the search index will also include documents. This will greatly increase the size of the search index

If set, TypeDoc will remove the output directory before writing output

Set the link the title in the header points to. Defaults to the documentation homepage

Defines links to be included in the header

Defines links to be included in the sidebar

Branches of the navigation tree which should not be expanded

Determines how the navigation sidebar is organized

Determines which optional headings are rendered

Determines how anchors within rendered HTML are determined.

If set, a reflections hierarchy summary will be rendered to a summary page. Defaults to true

Specify the default visibility for builtin filters and additional filters according to modifier tags

Configure search to give a relevance boost to selected categories

Configure search to give a relevance boost to selected kinds (eg "class")

If set and no @summary tag is specified, TypeDoc will use the first paragraph of comments as the short summary in the module/namespace view

Sets compatibility options for comment parsing that increase similarity with JSDoc comments

Prevents warnings due to unspecified tags from being reported in comments within .d.ts files.

Determines how TypeDoc searches for comments

Use TypeScript's link resolution when determining where @link tags point. This only applies to JSDoc style comments

If set, @link tags without link text will use the text content as the link. If not set, will use the target reflection name

Block tags which TypeDoc should recognize when parsing comments

Inline tags which TypeDoc should recognize when parsing comments

Modifier tags which TypeDoc should recognize when parsing comments

Remove the listed block/modifier tags from doc comments

Tags which will be preserved in doc comments, but not rendered when creating output

Modifier tags which should be copied to all children of the parent reflection

Block tags whose type annotations should be preserved in the output.

Specify whether categorization will be done at the group level

If set, references will be grouped with the type they refer to rather than in a 'References' group

Specify the default category for reflections without a category

Specify the order in which categories appear. * indicates the relative order for categories not in the list

Specify the order in which groups appear. * indicates the relative order for groups not in the list

Specify the sort strategy for documented values

If set, entry points will be subject to the same sorting rules as other reflections

Specify the sort order for reflections when 'kind' is specified

Watch files for changes and rebuild docs on change

If set, TypeDoc will not clear the screen between compilation runs

Do not run TypeScript's type checking before generating docs

Print the resolved configuration and exit

Specify the npm plugins that should be loaded. Omit to load all installed plugins

Specify what level of logging should be used

If set, all warnings will be treated as errors

If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings

A list of types which should not produce 'referenced but not documented' warnings

A list of reflection kinds that must be documented

A list of packages that must be documented

A list of full reflection names which should not produce warnings about not being documented

Specify which validation steps TypeDoc should perform on your generated documentation