Options

All command line arguments that are passed in without a flag will be parsed as input files. Any options passed on the command line will override options set in a configuration file.

$ typedoc --out path/to/documentation/ path/to/typescript/project/index.ts

Configuration Options

Options which control what files TypeDoc reads.

• options
• tsconfig
• compilerOptions
• plugin

Input Options

Options which control how input is converted into a project.

• entryPoints
• entryPointStrategy
• exclude
• externalPattern
• excludeExternals
• excludeNotDocumented
• excludeNotDocumentedKinds
• excludeInternal
• excludePrivate
• excludeProtected
• excludeReferences
• excludeCategories
• name
• includeVersion
• disableSources
• sourceLinkTemplate
• gitRevision
• gitRemote
• disablegit
• readme
• stripYamlFrontmatter

Output Options

Options which control TypeDoc's output.

• out
• json
• pretty
• emit
• theme
• lightHighlightTheme
• darkHighlightTheme
• customCss
• markedOptions
• basePath
• cname
• sourceLinkExternal
• htmlLang
• githubPages
• cacheBust
• gaID
• hideGenerator
• searchInComments
• cleanOutputDir
• titleLink
• navigationLinks
• navigation
• navigationLeaves
• sidebarLinks
• visibilityFilters
• searchCategoryBoosts
• searchGroupBoosts

Comment Options

Options which control how TypeDoc parses comments.

• commentStyle
• useTsLinkResolution
• preserveLinkText
• jsDocCompatibility
• blockTags
• inlineTags
• modifierTags
• excludeTags
• externalSymbolLinkMappings
• media
• includes

Organization Options

• categorizeByGroup
• defaultCategory
• categoryOrder
• groupOrder
• sort
• sortEntryPoints
• kindSortOrder

Validation Options

• validation
• treatWarningsAsErrors
• treatValidationWarningsAsErrors
• intentionallyNotExported
• requiredToBeDocumented

General Options

• watch
• preserveWatchOutput
• help
• version
• showConfig
• logLevel
• skipErrorChecking