@alauda/doom/lib/types.d.ts

Doctor Doom making docs.

import type { Options } from '@cspell/eslint-plugin';
import type { serve } from '@rspress/core';
import type { ApiPluginOptions, AutoSidebarPluginOptions, PermissionPluginOptions, ReferenceItem, ReleaseNotesOptions } from './plugins/index.js';
import type { DoomSite } from './shared/index.js';
export type BaseServeOptions = Parameters<typeof serve>[0];
export type ServeOptions = Omit<BaseServeOptions, 'config'>;
export interface GlobalCliOptions {
    config?: string;
    base?: string;
    prefix?: string;
    v?: string;
    download?: boolean;
    export?: boolean;
    ignore?: boolean;
    force?: boolean;
    open?: boolean;
    lazy?: boolean;
    include?: string[];
    exclude?: string[];
    outDir?: string;
    redirect?: 'auto' | 'never' | 'only-default-lang';
    editRepo?: boolean | string;
    algolia?: boolean | 'alauda';
    siteUrl?: boolean;
}
export interface TranslateOptions {
    systemPrompt?: string;
    userPrompt?: string;
}
export interface LintOptions {
    cspellOptions?: Partial<Options>;
}
export interface AlgoliaOptions {
    appId: string;
    apiKey: string;
    indexName: string;
}
export interface ExportItem {
    name?: string;
    scope: string | string[];
    flattenScope?: string[];
    onlyInclude?: string[];
    exclude?: string[];
}
declare module '@rspress/shared' {
    interface UserConfig {
        prefix?: string;
        userBase?: string;
        api?: Omit<ApiPluginOptions, 'localBasePath'>;
        sites?: DoomSite[];
        permission?: Omit<PermissionPluginOptions, 'localBasePath'>;
        reference?: ReferenceItem[];
        sidebar?: Omit<AutoSidebarPluginOptions, 'download' | 'excludeRoutes'>;
        releaseNotes?: ReleaseNotesOptions;
        onlyIncludeRoutes?: string[];
        internalRoutes?: string[];
        translate?: TranslateOptions;
        editRepoBaseUrl?: string;
        lint?: LintOptions;
        algolia?: AlgoliaOptions;
        siteUrl?: string;
        export?: ExportItem[];
    }
    interface SiteData {
        originalTitle?: string;
    }
}
export type ContentProcessor = {
    type: 'ejsTemplate';
    data?: Record<string, unknown>;
};