Type Alias: TypedocOptions

type TypedocOptions = TypedocConfig & object;

What a docs package gives typedocConfig, and any option of TypeDoc over the preset’s.

Type Declaration

Name	Type	Description	Defined in
`categories?`	readonly `string`[]	The folders of hand-written docs in the docs package, `['guides']` by default: a link of a README into one is rewritten to it from `api/`, and none of its files is copied into `api/`.	packages/project-typedoc/src/config.ts:52
`docs`	`string` \| `URL`	The docs package: the URL of its typedoc.config.mjs, `import.meta.url`, or its folder. The repo’s root is the folder two up from it, as the docs package is `packages/docs`.	packages/project-typedoc/src/config.ts:40
`entryPoints`	`string`[]	The packages to document, each by its folder from the docs package: `['../core', '../cli']`.	packages/project-typedoc/src/config.ts:47
`plugins?`	readonly (`TypedocPlugin` \| `string`)[]	Plugins of TypeDoc of the caller’s own, each a function of the application, as TypedocPlugin, or a module by its name: run after the preset’s own plugins, and before typedoc-plugin-llms-txt and typedoc-plugin-markdown. None by default.	packages/project-typedoc/src/config.ts:58
`repository`	`string`	The repository on GitLab, as its web page is, `https://gitlab.com/wetryfun/project/project`: each source links to its file there, at the revision of gitRevisionOf.	packages/project-typedoc/src/config.ts:45