Interface BuildWikiOptions

interface BuildWikiOptions {
    crossnoteBuildDirectory?: string;
    directories: string[];
    globalConfigDirectory?: string;
    onProgress?: (
        info: { rendered: number; root: string; total: number },
    ) => void;
    vscode?: boolean;
    vscodeSettingsPath?: string;
}

Properties

crossnoteBuildDirectory?: string

Override the crossnote build directory (tests).

directories: string[]

Directories to include — like a VS Code multi-root workspace, each keeps its own .crossnote config while the global config layer is shared.

globalConfigDirectory?: string

Override the global config directory (tests).

onProgress?: (info: { rendered: number; root: string; total: number }) => void

Progress callback, called after each rendered note. rendered/total count the notes of the root currently being processed.

vscode?: boolean

Load config from VS Code user settings on top of the global config.

vscodeSettingsPath?: string

Path to the VS Code user settings.json (auto-detected by default).