Interface: TypeDocPluginOptions

Properties

enabled

optional

enabled: boolean

Enable TypeDoc API documentation generation

entryPoints

optional

entryPoints: string[]

Entry points for TypeDoc (source files or directories)

tsconfig

optional

tsconfig: string

Path to tsconfig.json

out

optional

out: string

Output directory for generated markdown files (relative to srcDir)

readme

optional

readme: string

Include README in the API docs

plugin

optional

plugin: string[]

Plugin options passed to TypeDoc

exclude

optional

exclude: string[]

Exclude patterns

excludeExternals

optional

excludeExternals: boolean

Exclude external modules

excludePrivate

optional

excludePrivate: boolean

Exclude private members

excludeProtected

optional

excludeProtected: boolean

Exclude protected members

excludeInternal

optional

excludeInternal: boolean

Exclude internal members (marked with @internal)

sort

optional

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

Sort order for members

categoryOrder

optional

categoryOrder: string[]

Category order for organizing API docs

groupOrder

optional

groupOrder: string[]

Group order for organizing API docs

watch

optional

watch: boolean

Watch mode for development

sidebar

optional

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

Custom sidebar configuration for API docs

markdown

optional

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

Transform options for generated markdown

contentDir

optional

contentDir: string

Content directory where markdown files are stored

runOnBuild

optional

runOnBuild: boolean

Run TypeDoc on every build

runOnStart

optional

runOnStart: boolean

Run TypeDoc on startup

Source

typedoc/vite-plugin.ts

← TypeDocConfig | WarningProps →