LlmsConfig

Auf dieser Seite

Diese API-Referenz wird aus den englischen TypeScript-Quellkommentaren erzeugt. Namen, Signaturen und Beispiele entsprechen dem veröffentlichten Paket.

import type { LlmsConfig } from "ardo/config"

type LlmsConfig = {
    /** File name for the concise LLM documentation index. */
    indexFileName?: string;
    /** File name for the full LLM documentation export. */
    fullFileName?: string;
    /** Generate the full documentation export next to the concise index. */
    includeFull?: boolean;
    /** Override the generated document title. Defaults to the site title. */
    title?: string;
    /** Override the generated document summary. Defaults to the site description. */
    description?: string;
};

Properties

Name	Type	Required	Description
`indexFileName`	`string`	No	File name for the concise LLM documentation index.
`fullFileName`	`string`	No	File name for the full LLM documentation export.
`includeFull`	`boolean`	No	Generate the full documentation export next to the concise index.
`title`	`string`	No	Override the generated document title. Defaults to the site title.
`description`	`string`	No	Override the generated document summary. Defaults to the site description.