Usage
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, it will .
In order to create a documentation for an entire project you simply type:
$ typedoc --out path/to/documentation/ path/to/typescript/project/
out
$ typedoc --out <path/to/documentation/>
Specifies the location the documentation should be written to.
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.
module
$ typedoc --module <commonjs or amd>
Specify module code generation: “commonjs” or “amd”
target
$ typedoc --target <ES3 or ES5>
Specify ECMAScript target version: “ES3” (default), or “ES5”
exclude
$ typedoc --exclude <pattern>
Exclude files by the given pattern when a path is provided as source
theme
$ typedoc --theme <path/to/theme>
Specify the path to the theme that should be used
includeDeclarations
$ typedoc --includeDeclarations
Turn on parsing of .d.ts declaration files.
externalPattern
$ typedoc --externalPattern <pattern>
Define a pattern for files that should be considered being external.
excludeExternals
$ typedoc --excludeExternals
Prevent externally resolved TypeScript files from being documented.
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.
verbose
$ typedoc --verbose
Print more information while TypeDoc is running.