Arguments

TypeDoc accepts most of the command line arguments that the TypeScript compiler accepts. All arguments that are passed in without a flag will be parsed as input files. TypeDoc accepts directories as input files. To view all TypeDoc’s options use the --help option.

To create documentation for an entire project via the CLI you can type:

$ typedoc --out path/to/documentation/ path/to/typescript/project/

Help

$ typedoc --help

The help command will print the following listing of available commands.

Usage:
 typedoc --mode modules --out path/to/documentation path/to/sourcefiles

TypeDoc options:
 --categorizeByGroup       Specifies whether categorization will be done at the group level.
 --categoryOrder           Specifies the order in which categories appear. * indicates the relative order for categories not in the list.
 --defaultCategory         Specifies the default category for reflections without a category.
 --disableOutputCheck      Should TypeDoc disable the testing and cleaning of the output directory?
 --entryPoint              Specifies the fully qualified name of the root symbol. Defaults to global namespace.
 --exclude                 Define patterns for excluded files when specifying paths.
 --excludeExternals        Prevent externally resolved TypeScript files from being documented.
 --excludeNotExported      Prevent symbols that are not exported from being documented.
 --excludePrivate          Ignores private variables and methods
 --excludeProtected        Ignores protected variables and methods
 --externalPattern         Define patterns for files that should be considered being external.
 --gaID                    Set the Google Analytics tracking ID and activate tracking code.
 --gaSite                  Set the site name for Google Analytics. Defaults to `auto`.
 --gitRevision             Use specified revision instead of the last revision for linking to GitHub source files.
 -h, --help                Print this message.
 --hideGenerator           Do not print the TypeDoc link at the end of the page.
 --ignoreCompilerErrors    Should TypeDoc generate documentation pages even after the compiler has returned errors?
 --includeDeclarations     Turn on parsing of .d.ts declaration files.
 --includes DIRECTORY      Specifies the location to look for included documents (use [[include:FILENAME]] in comments).
 --json                    Specifies the location and file name a json file describing the project is written to.
 --listInvalidSymbolLinks  Emits a list of broken symbol [[navigation]] links after documentation generation
 --logger                  Specify the logger that should be used, 'none' or 'console'
 --media DIRECTORY         Specifies the location with media files that should be copied to the output directory.
 --mode                    Specifies the output mode the project is used to be compiled with: 'file' or 'modules'
 --name                    Set the name of the project that will be used in the header of the template.
 --options                 Specify a js option file that should be loaded. If not specified TypeDoc will look for 'typedoc.js' in the current directory.
 --out DIRECTORY           Specifies the location the documentation should be written to.
 --plugin                  Specify the npm plugins that should be loaded. Omit to load all installed plugins, set to 'none' to load no plugins.
 --readme                  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.
 --theme                   Specify the path to the theme that should be used or 'default' or 'minimal' to use built-in themes.
 --toc                     Specifies the top level table of contents.
 --tsconfig                Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.
 -v, --version             Print the TypeDoc's version.

TypeScript options:
See https://www.typescriptlang.org/docs/handbook/compiler-options.html

options

$ typedoc --options <filename>

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

out

$ typedoc --out <path/to/documentation/>

Specifies the location the documentation should be written to.

json

$ typedoc --json <path/to/out-file.json/>

Specifies the location to output a JSON file containing all of the reflection data.

mode

$ typedoc --mode <file|modules>

Specifies the output mode the project is used to be compiled with.

name

$ typedoc --name <Documentation title>

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

readme

$ typedoc --readme <path/to/readme|none>

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.

exclude

$ typedoc --exclude <pattern>

Exclude files by the given pattern when a path is provided as source. Supports minimatch patterns. In typedoc.json configuration files, this option accepts an array of patterns.

Example

$ typedoc --exclude "**/*+(index|.spec|.e2e).ts"

theme

$ typedoc --theme <default|minimal|path/to/theme>

Specify the path to the theme that should be used. TypeDoc includes the default and minimal themes.

includeDeclarations

$ typedoc --includeDeclarations

Turn on parsing of .d.ts declaration files.

excludeExternals

$ typedoc --excludeExternals

Prevent externally resolved TypeScript files from being documented.

externalPattern

$ typedoc --externalPattern <pattern>

Define a pattern for files that should be considered being external.

categorizeByGroup

$ typedoc --categorizeByGroup=false

This flag categorizes reflections by group (within properties, methods, etc). To allow methods and properties of the same category to be grouped together, set this flag to false. Defaults to true

defaultCategory

$ typedoc --defaultCategory="Category Name"

Sets the name for the default category (which is used when some elements of the page are categorized). Defaults to ‘Other’

categoryOrder

{
  "categoryOrder": ["Category Name", "Other Category", "*"]
}

Array option (available via json configuration) which allows overriding the order categories display in. A string of * indicates where categories that are not in the list should appear.

By default, categories are displayed alphabetically. If unknown categories are found, they will be listed at the end by default.

gaID

$ typedoc --gaID

Set the Google Analytics tracking ID and activate tracking code.

gaSite

$ typedoc --gaSite <site>

Set the site name for Google Analytics. Defaults to auto.

hideGenerator

$ typedoc --hideGenerator

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

gitRevision

$ typedoc --gitRevision <revision|branch>

Use specified revision or branch instead of the last revision for linking to GitHub source files.

ignoreCompilerErrors

$ typedoc --ignoreCompilerErrors

Generates documentation, even if the project does not TypeScript compile.

toc

$ typedoc --toc EntryClass,ImportantInterface
{
  "toc": [
    "EntryClass",
    "ImportantInterface"
  ]
}

Overrides the “globals” navigation sidebar to only include the types provided in the “toc” whitelist. This is useful in large projects where there may be an unwieldy number of Globals in the sidebar.