Skip to content
CtrlK

LlmsConfig

On this page
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

NameTypeRequiredDescription
indexFileNamestringNoFile name for the concise LLM documentation index.
fullFileNamestringNoFile name for the full LLM documentation export.
includeFullbooleanNoGenerate the full documentation export next to the concise index.
titlestringNoOverride the generated document title. Defaults to the site title.
descriptionstringNoOverride the generated document summary. Defaults to the site description.