Interface: TypeDocConfig

Properties

enabled

optional

enabled: boolean

entryPoints

entryPoints: string[]

tsconfig

optional

tsconfig: string

out

optional

out: string

readme

optional

readme: string

plugin

optional

plugin: string[]

exclude

optional

exclude: string[]

excludeExternals

optional

excludeExternals: boolean

excludePrivate

optional

excludePrivate: boolean

excludeProtected

optional

excludeProtected: boolean

excludeInternal

optional

excludeInternal: boolean

sort

optional

sort: ("source-order" | "alphabetical" | "enum-value-ascending" | "enum-value-descending" | "required-first" | "visibility")[]

categoryOrder

optional

categoryOrder: string[]

groupOrder

optional

groupOrder: string[]

watch

optional

watch: boolean

sidebar

optional

sidebar: { title?: string; position?: number; collapsed?: boolean }

markdown

optional

markdown: { breadcrumbs?: boolean; hierarchy?: boolean; sourceLinks?: boolean; sourceBaseUrl?: string; codeBlocks?: boolean }

Source

config/types.ts


← TOCItem | TypeDocPluginOptions →