Interface HumanDocsOptions

Generate the human-facing documentation site using TypeDoc.

TypeDoc plays the same role for doc-weaver that MkDocs plays for doc-forge: it renders the compiled model into a browsable site. The machine-facing output (MCP JSON) is produced separately.

interface HumanDocsOptions {
    entryPoints: string[];
    entryPointStrategy?: "resolve" | "expand" | "merge" | "packages";
    name?: string;
    options?: string;
    out: string;
    plugin?: string[];
    skipErrorChecking?: boolean;
    tsconfig?: string;
}

Properties

entryPoints entryPointStrategy? name? options? out plugin? skipErrorChecking? tsconfig?

Properties

entryPoints

entryPoints: string[]

OptionalentryPointStrategy

entryPointStrategy?: "resolve" | "expand" | "merge" | "packages"

TypeDoc entry-point strategy. Defaults to 'resolve'.

Optionalname

name?: string

Optionaloptions

options?: string

Optional path to a typedoc.json config.

out

out: string

Optionalplugin

plugin?: string[]

Optional TypeDoc plugins (e.g. typedoc-plugin-markdown).

OptionalskipErrorChecking

skipErrorChecking?: boolean

Skip TypeScript error checking. Defaults to true.

Optionaltsconfig

tsconfig?: string

Settings

Member Visibility

On This Page

Properties