Skip to content
wtf project

Function: typedocConfig()

Documentation / @wtf/project-typedoc / config / typedocConfig

function typedocConfig(__namedParameters): TypedocConfig;

Defined in: packages/project-typedoc/src/config.ts:148

The TypeDoc config of a docs package, packages/docs, of the packages of its workspace, each a module of its own (entryPointStrategy: 'packages'):

  • the reference in markdown, in api/, with its llms.txt of llms-template.md, as typedoc-plugin-markdown and typedoc-plugin-llms-txt write them, and no file copied beside it; the folder written whole (cleanOutputDir), so it holds what this build wrote and no page of a build before;
  • each “Defined in:” linked to its file in the repository, at the revision of gitRevisionOf, with git off, so a git worktree links the same, and only a file git tracks linked;
  • the caller’s own plugins, after the preset’s;
  • a warning is an error, an invalid link among them, so a reference that names what is not there fails its build;
  • private, protected and internal members left out.

Each other option given is TypeDoc’s, laid over the preset’s, as llmsTxtHeader, llmsTxtDeclarations and llmsTxtQuickReference; packageOptions, each package’s own, are laid over the preset’s of each, which repeat what does not reach a package’s conversion of itself.

Parameters

ParameterType
__namedParametersTypedocOptions

Returns

TypedocConfig