always Create Entry Point Module always Create Entry Point Module : boolean
block Tags block Tags : ` @ ${ string } ` []
cache Bust cache Bust : boolean
cascaded Modifier Tags cascaded Modifier Tags : ` @ ${ string } ` []
categorize By Group categorize By Group : boolean
category Order category Order : string []
clean Output Dir clean Output Dir : boolean
comment Style comment Style : | "all" | "line" | "jsdoc" | "block"
compiler Options compiler Options : unknown
custom Css custom Css : string
custom Footer Html custom Footer Html : string
custom Footer Html Disable Wrapper custom Footer Html Disable Wrapper : boolean
dark Highlight Theme dark Highlight Theme : BundledTheme
default Category default Category : string
disable Git disable Git : boolean
disable Sources disable Sources : boolean
emit emit : "none" | "both" | "docs"
entry Points entry Points : string []
entry Point Strategy entry Point Strategy : | "expand" | "resolve" | "packages" | "merge"
exclude Categories exclude Categories : string []
exclude Externals exclude Externals : boolean
exclude Internal exclude Internal : boolean
exclude Not Documented exclude Not Documented : boolean
exclude Not Documented Kinds exclude Private exclude Private : boolean
exclude Protected exclude Protected : boolean
exclude References exclude References : boolean
exclude Tags exclude Tags : ` @ ${ string } ` []
external Pattern external Pattern : string []
external Symbol Link Mappings external Symbol Link Mappings : Record < string , Record < string , string > >
github Pages github Pages : boolean
git Remote git Remote : string
git Revision git Revision : string
group Order group Order : string []
headings headings : { document : boolean ; readme : boolean ; }
hide Generator hide Generator : boolean
hide Parameter Types In Title hide Parameter Types In Title : boolean
highlight Languages highlight Languages : string []
hosted Base Url hosted Base Url : string
include Version include Version : boolean
inline Tags inline Tags : ` @ ${ string } ` []
intentionally Not Exported intentionally Not Exported : string []
light Highlight Theme light Highlight Theme : BundledTheme
locales locales : Record < string , Record < string , string > >
markdown It Loader markdown It Loader : ( ( parser : any ) => void )
markdown It Options markdown It Options : Record < string , unknown >
markdown Link External markdown Link External : boolean
max Type Conversion Depth max Type Conversion Depth : number
modifier Tags modifier Tags : ` @ ${ string } ` []
navigation navigation : { compactFolders : boolean ; excludeReferences : boolean ; includeCategories : boolean ; includeFolders : boolean ; includeGroups : boolean ; }
navigation Leaves navigation Leaves : string []
navigation Links navigation Links : Record < string , string >
preserve Link Text preserve Link Text : boolean
preserve Watch Output preserve Watch Output : boolean
project Documents project Documents : string []
search Category Boosts search Category Boosts : Record < string , number >
search Group Boosts search Group Boosts : Record < string , number >
search In Comments search In Comments : boolean
search In Documents search In Documents : boolean
show Config show Config : boolean
sidebar Links sidebar Links : Record < string , string >
skip Error Checking skip Error Checking : boolean
sort sort : ( | "kind" | "instance-first" | "alphabetical" | "source-order" | "alphabetical-ignoring-documents" | "enum-value-ascending" | "enum-value-descending" | "enum-member-source-order" | "static-first" | "visibility" | "required-first" | "external-last" | "documents-first" | "documents-last" ) []
sort Entry Points sort Entry Points : boolean
source Link External source Link External : boolean
source Link Template source Link Template : string
suppress Comment Warnings In Declaration Files suppress Comment Warnings In Declaration Files : boolean
title Link title Link : string
treat Validation Warnings As Errors treat Validation Warnings As Errors : boolean
treat Warnings As Errors treat Warnings As Errors : boolean
use Hosted Base Url For Absolute Links use Hosted Base Url For Absolute Links : boolean
use Ts Link Resolution use Ts Link Resolution : boolean
visibility Filters visibility Filters : { external ?: boolean ; inherited ?: boolean ; private ?: boolean ; protected ?: boolean ; [tag : ` @ ${ string } ` ]: boolean ; }
Describes all TypeDoc specific options as returned by Options.getValue, this is slightly more restrictive than the TypeDocOptions since it does not allow both keys and values for mapped option types, and does not allow partials of flag values.