Optional
always Create Entry Point Module alwaysCreateEntryPointModule ?: boolean
Optional
base Path basePath ?: string
blockTags ?: ` @ ${ string } ` []
Optional
cache Bust cacheBust ?: boolean
cascadedModifierTags ?: ` @ ${ string } ` []
Optional
categorize By Group categorizeByGroup ?: boolean
Optional
category Order categoryOrder ?: string []
Optional
clean Output Dir cleanOutputDir ?: boolean
Optional
cname cname ?: string
commentStyle ?: | "jsdoc" | "block" | "line" | "all" | "All" | "JSDoc" | "Block" | "Line"
Optional
compiler Options compilerOptions ?: unknown
Optional
custom Css customCss ?: string
customFooterHtml ?: string
customFooterHtmlDisableWrapper ?: boolean
Optional
custom Js customJs ?: string
Optional
dark Highlight Theme darkHighlightTheme ?: BundledTheme
Optional
default Category defaultCategory ?: string
Optional
disable Git disableGit ?: boolean
Optional
disable Sources disableSources ?: boolean
Optional
emit emit ?: "none" | "both" | "docs"
Optional
entry Points entryPoints ?: string []
Optional
entry Point Strategy entryPointStrategy ?: | "Expand" | "expand" | "resolve" | "packages" | "merge" | "Resolve" | "Packages" | "Merge"
Optional
exclude exclude ?: string []
Optional
exclude Categories excludeCategories ?: string []
Optional
exclude Externals excludeExternals ?: boolean
Optional
exclude Internal excludeInternal ?: boolean
Optional
exclude Not Documented excludeNotDocumented ?: boolean
Optional
exclude Not Documented Kinds Optional
exclude Private excludePrivate ?: boolean
Optional
exclude Protected excludeProtected ?: boolean
Optional
exclude References excludeReferences ?: boolean
excludeTags ?: ` @ ${ string } ` []
Optional
external Pattern externalPattern ?: string []
Optional
external Symbol Link Mappings externalSymbolLinkMappings ?: Record < string , Record < string , string > >
Optional
favicon favicon ?: string
Optional
github Pages githubPages ?: boolean
Optional
git Remote gitRemote ?: string
Optional
git Revision gitRevision ?: string
Optional
group Order groupOrder ?: string []
Optional
group References By Type groupReferencesByType ?: boolean
Optional
headings headings ?: boolean | Partial < { document : boolean ; readme : boolean } >
Optional
help help ?: boolean
Optional
hide Generator hideGenerator ?: boolean
Optional
highlight Languages highlightLanguages ?: string []
Optional
hosted Base Url hostedBaseUrl ?: string
Optional
html html ?: string
Optional
ignored Highlight Languages ignoredHighlightLanguages ?: string []
Optional
include Hierarchy Summary includeHierarchySummary ?: boolean
Optional
include Version includeVersion ?: boolean
inlineTags ?: ` @ ${ string } ` []
Optional
intentionally Not Documented intentionallyNotDocumented ?: string []
Optional
intentionally Not Exported intentionallyNotExported ?: string []
Optional
js Doc Compatibility Optional
json json ?: string
Optional
lang lang ?: string
Optional
light Highlight Theme lightHighlightTheme ?: BundledTheme
Optional
locales locales ?: Record < string , Record < string , string > >
Optional
markdown It Loader markdownItLoader ?: ( parser : any ) => void
Optional
markdown It Options markdownItOptions ?: Record < string , unknown >
Optional
markdown Link External markdownLinkExternal ?: boolean
Optional
max Type Conversion Depth maxTypeConversionDepth ?: number
modifierTags ?: ` @ ${ string } ` []
Optional
name name ?: string
Optional
navigation navigation ?: | boolean | Partial < { compactFolders : boolean ; excludeReferences : boolean ; includeCategories : boolean ; includeFolders : boolean ; includeGroups : boolean ; } , >
Optional
navigation Leaves navigationLeaves ?: string []
Optional
navigation Links navigationLinks ?: Record < string , string >
notRenderedTags ?: ` @ ${ string } ` []
Optional
options options ?: string
Optional
packages Requiring Documentation packagesRequiringDocumentation ?: string []
Optional
plugin plugin ?: string []
Optional
preserve Link Text preserveLinkText ?: boolean
Optional
preserve Watch Output preserveWatchOutput ?: boolean
Optional
pretty pretty ?: boolean
Optional
project Documents projectDocuments ?: string []
Optional
readme readme ?: string
Optional
required To Be Documented Optional
router router ?: string
Optional
search Category Boosts searchCategoryBoosts ?: Record < string , number >
Optional
search Group Boosts searchGroupBoosts ?: Record < string , number >
searchInComments ?: boolean
Optional
search In Documents searchInDocuments ?: boolean
Optional
show Config showConfig ?: boolean
sidebarLinks ?: Record < string , string >
Optional
skip Error Checking skipErrorChecking ?: boolean
Optional
slugger Configuration sluggerConfiguration ?: boolean | Partial < { lowercase : boolean } >
Optional
sort sort ?: ( | "kind" | "source-order" | "alphabetical" | "alphabetical-ignoring-documents" | "enum-value-ascending" | "enum-value-descending" | "enum-member-source-order" | "static-first" | "instance-first" | "visibility" | "required-first" | "external-last" | "documents-first" | "documents-last" )[]
Optional
sort Entry Points sortEntryPoints ?: boolean
Optional
source Link External sourceLinkExternal ?: boolean
Optional
source Link Template sourceLinkTemplate ?: string
suppressCommentWarningsInDeclarationFiles ?: boolean
Optional
theme theme ?: string
Optional
title Link titleLink ?: string
Optional
treat Validation Warnings As Errors treatValidationWarningsAsErrors ?: boolean
Optional
treat Warnings As Errors treatWarningsAsErrors ?: boolean
Optional
tsconfig tsconfig ?: string
Optional
type Print Width typePrintWidth ?: number
useFirstParagraphOfCommentAsSummary ?: boolean
Optional
use Hosted Base Url For Absolute Links useHostedBaseUrlForAbsoluteLinks ?: boolean
Optional
use Ts Link Resolution useTsLinkResolution ?: boolean
Optional
version version ?: boolean
Optional
visibility Filters visibilityFilters ?: { external ?: boolean ; inherited ?: boolean ; private ?: boolean ; protected ?: boolean ; [ tag : ` @ ${ string } ` ]: boolean ; }
Optional
watch watch ?: boolean
An interface describing all TypeDoc specific options. Generated from a map which contains more information about each option for better types when defining said options.