@farming-labs/docs 0.0.38 → 0.0.44

package/dist/types-Cg_hJBKj.d.mts

@@ -0,0 +1,1330 @@
+//#region src/types.d.ts
+/**
+ * Theme / UI configuration types for the docs framework.
+ * Inspired by Fumadocs: https://github.com/fuma-nama/fumadocs
+ */
+/**
+ * Fine-grained UI configuration for docs themes.
+ *
+ * Theme authors define defaults for these values in their `createTheme` call.
+ * End users can override any value when calling the theme factory.
+ *
+ * @example
+ * ```ts
+ * const myTheme = createTheme({
+ *   name: "my-theme",
+ *   ui: {
+ *     colors: { primary: "#6366f1", background: "#0a0a0a" },
+ *     radius: "0px",
+ *     codeBlock: { showLineNumbers: true, theme: "github-dark" },
+ *     sidebar: { width: 280, style: "bordered" },
+ *   },
+ * });
+ * ```
+ */
+/**
+ * Font style configuration for a single text element (heading, body, etc.).
+ *
+ * @example
+ * ```ts
+ * h1: { size: "2.25rem", weight: 700, lineHeight: "1.2", letterSpacing: "-0.02em" }
+ * ```
+ */
+interface FontStyle {
+  /** CSS `font-size` value (e.g. "2.25rem", "36px", "clamp(1.8rem, 3vw, 2.5rem)") */
+  size?: string;
+  /** CSS `font-weight` value (e.g. 700, "bold", "600") */
+  weight?: string | number;
+  /** CSS `line-height` value (e.g. "1.2", "1.5", "28px") */
+  lineHeight?: string;
+  /** CSS `letter-spacing` value (e.g. "-0.02em", "0.05em") */
+  letterSpacing?: string;
+}
+/**
+ * Typography configuration for the docs.
+ *
+ * @example
+ * ```ts
+ * typography: {
+ *   font: {
+ *     style: { sans: "Inter, sans-serif", mono: "JetBrains Mono, monospace" },
+ *     h1: { size: "2.25rem", weight: 700, letterSpacing: "-0.02em" },
+ *     h2: { size: "1.75rem", weight: 600 },
+ *     body: { size: "1rem", lineHeight: "1.75" },
+ *   },
+ * }
+ * ```
+ */
+interface TypographyConfig {
+  /**
+   * Font configuration.
+   */
+  font?: {
+    /**
+     * Font family definitions.
+     */
+    style?: {
+      /** Sans-serif font family — used for body text, headings, and UI elements. */sans?: string; /** Monospace font family — used for code blocks, inline code, and terminal output. */
+      mono?: string;
+    }; /** Heading 1 (`<h1>`) style overrides */
+    h1?: FontStyle; /** Heading 2 (`<h2>`) style overrides */
+    h2?: FontStyle; /** Heading 3 (`<h3>`) style overrides */
+    h3?: FontStyle; /** Heading 4 (`<h4>`) style overrides */
+    h4?: FontStyle; /** Body text style */
+    body?: FontStyle; /** Small text style (captions, meta text) */
+    small?: FontStyle;
+  };
+}
+interface UIConfig {
+  /**
+   * Theme color tokens.
+   *
+   * These are mapped to `--color-fd-*` CSS variables at runtime.
+   * Accepts any valid CSS color value (hex, rgb, oklch, hsl, etc.).
+   *
+   * @example
+   * ```ts
+   * colors: {
+   *   primary: "oklch(0.72 0.19 149)",       // green primary
+   *   primaryForeground: "#ffffff",           // white text on primary
+   *   accent: "hsl(220 80% 60%)",            // blue accent
+   * }
+   * ```
+   */
+  colors?: {
+    primary?: string;
+    primaryForeground?: string;
+    background?: string;
+    foreground?: string;
+    muted?: string;
+    mutedForeground?: string;
+    border?: string;
+    card?: string;
+    cardForeground?: string;
+    accent?: string;
+    accentForeground?: string;
+    secondary?: string;
+    secondaryForeground?: string;
+    popover?: string;
+    popoverForeground?: string;
+    ring?: string;
+  };
+  /**
+   * Typography settings — font families, heading sizes, weights, etc.
+   *
+   * @example
+   * ```ts
+   * typography: {
+   *   font: {
+   *     style: { sans: "Inter, sans-serif", mono: "JetBrains Mono, monospace" },
+   *     h1: { size: "2.25rem", weight: 700, letterSpacing: "-0.02em" },
+   *     body: { size: "1rem", lineHeight: "1.75" },
+   *   },
+   * }
+   * ```
+   */
+  typography?: TypographyConfig;
+  /**
+   * Global border-radius. Maps to CSS `--radius`.
+   * Use "0px" for sharp corners, "0.5rem" for rounded, etc.
+   */
+  radius?: string;
+  /** Layout dimensions */
+  layout?: {
+    contentWidth?: number;
+    sidebarWidth?: number;
+    tocWidth?: number;
+    toc?: {
+      enabled?: boolean;
+      depth?: number;
+      /**
+       * Visual style of the TOC indicator.
+       * - `"default"` — highlight active link text color only
+       * - `"directional"` — animated thumb bar that tracks active headings (fumadocs style)
+       * @default "default"
+       */
+      style?: "default" | "directional";
+    };
+    header?: {
+      height?: number;
+      sticky?: boolean;
+    };
+  };
+  /** Code block rendering config */
+  codeBlock?: {
+    /** Show line numbers in code blocks @default false */showLineNumbers?: boolean; /** Show copy button @default true */
+    showCopyButton?: boolean; /** Shiki theme name for syntax highlighting */
+    theme?: string; /** Dark mode shiki theme (for dual-theme setups) */
+    darkTheme?: string;
+  };
+  /** Sidebar styling hints (consumed by theme CSS) */
+  sidebar?: {
+    /**
+     * Visual style of the sidebar.
+     * - "default" — standard fumadocs sidebar
+     * - "bordered" — visible bordered sections (like better-auth)
+     * - "floating" — floating card sidebar
+     */
+    style?: "default" | "bordered" | "floating"; /** Background color override */
+    background?: string; /** Border color override */
+    borderColor?: string;
+  };
+  /** Card styling */
+  card?: {
+    /** Whether cards have visible borders @default true */bordered?: boolean; /** Card background color override */
+    background?: string;
+  };
+  /** Default props/variants for MDX components (Callout, CodeBlock, Tabs, etc.) */
+  components?: {
+    [key: string]: Record<string, unknown> | ((defaults: unknown) => unknown);
+  };
+}
+/**
+ * A docs theme configuration.
+ *
+ * Theme authors create these with `createTheme()`. The `name` identifies the
+ * theme (useful for CSS scoping, debugging, analytics). The `ui` object holds
+ * all visual configuration.
+ *
+ * @example
+ * ```ts
+ * import { createTheme } from "@farming-labs/docs";
+ *
+ * export const myTheme = createTheme({
+ *   name: "my-theme",
+ *   ui: {
+ *     colors: { primary: "#ff4d8d" },
+ *     radius: "0px",
+ *   },
+ * });
+ * ```
+ */
+interface DocsTheme {
+  /** Unique name for this theme (used for CSS scoping and debugging) */
+  name?: string;
+  /** UI configuration — colors, typography, layout, components */
+  ui?: UIConfig;
+  /**
+   * @internal
+   * User-provided color overrides tracked by `createTheme`.
+   * Only these colors are emitted as inline CSS variables at runtime.
+   * Preset defaults stay in the theme's CSS file.
+   */
+  _userColorOverrides?: Record<string, string>;
+}
+interface DocsMetadata {
+  titleTemplate?: string;
+  description?: string;
+  twitterCard?: "summary" | "summary_large_image";
+}
+interface OGConfig {
+  enabled?: boolean;
+  type?: "static" | "dynamic";
+  endpoint?: string;
+  defaultImage?: string;
+}
+/** Single image entry for Open Graph (frontmatter or Next metadata). */
+interface OpenGraphImage {
+  url: string;
+  width?: number;
+  height?: number;
+}
+/** Open Graph block in page frontmatter. When present, used as-is for metadata (replaces generated OG). */
+interface PageOpenGraph {
+  images?: OpenGraphImage[];
+  title?: string;
+  description?: string;
+}
+/** Twitter card block in page frontmatter. When present, used as-is for metadata (replaces generated twitter). */
+interface PageTwitter {
+  card?: "summary" | "summary_large_image";
+  images?: string[];
+  title?: string;
+  description?: string;
+}
+interface PageFrontmatter {
+  title: string;
+  description?: string;
+  tags?: string[];
+  icon?: string;
+  /** Path to custom OG image for this page (shorthand). Ignored if `openGraph` is set. */
+  ogImage?: string;
+  /** Full Open Graph object. When set, replaces any generated OG from config (e.g. dynamic endpoint). */
+  openGraph?: PageOpenGraph;
+  /** Full Twitter card object. When set, replaces any generated twitter from config. */
+  twitter?: PageTwitter;
+  /** Sort order in the sidebar. Lower numbers appear first. Pages without `order` are sorted alphabetically after ordered pages. */
+  order?: number;
+}
+interface DocsNav {
+  /**
+   * Sidebar title — a plain string or a React element (e.g. a div with an icon).
+   *
+   * @example
+   * ```tsx
+   * // Simple string
+   * nav: { title: "My Docs" }
+   *
+   * // React element with icon
+   * nav: {
+   *   title: <div style={{ display: "flex", alignItems: "center", gap: 8 }}>
+   *     <Rocket size={18} /> Example Docs
+   *   </div>
+   * }
+   * ```
+   */
+  title?: unknown;
+  /** URL the title links to. Defaults to `/{entry}`. */
+  url?: string;
+}
+interface ThemeToggleConfig {
+  /**
+   * Whether to show the light/dark theme toggle in the sidebar.
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * The default / forced theme when the toggle is hidden.
+   * Only applies when `enabled` is `false`.
+   * @default "system"
+   *
+   * @example
+   * ```ts
+   * // Hide toggle, force dark mode
+   * themeToggle: { enabled: false, default: "dark" }
+   * ```
+   */
+  default?: "light" | "dark" | "system";
+  /**
+   * Toggle mode — show only light/dark, or include a system option.
+   * @default "light-dark"
+   */
+  mode?: "light-dark" | "light-dark-system";
+}
+interface BreadcrumbConfig {
+  /**
+   * Whether to show the breadcrumb navigation above page content.
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * Custom breadcrumb component. Receives the default breadcrumb as children
+   * so you can wrap/modify it.
+   *
+   * @example
+   * ```tsx
+   * breadcrumb: {
+   *   component: ({ items }) => <MyBreadcrumb items={items} />,
+   * }
+   * ```
+   */
+  component?: unknown;
+}
+/**
+ * A leaf page in the sidebar tree.
+ */
+interface SidebarPageNode {
+  type: "page";
+  name: string;
+  url: string;
+  icon?: unknown;
+}
+/**
+ * A folder (group) in the sidebar tree. May contain child pages
+ * and nested folders, forming a recursive hierarchy.
+ */
+interface SidebarFolderNode {
+  type: "folder";
+  name: string;
+  icon?: unknown;
+  /** Index page for this folder (the folder's own landing page). */
+  index?: SidebarPageNode;
+  /** Child pages and sub-folders. */
+  children: SidebarNode[];
+  /** Whether this folder section is collapsible. */
+  collapsible?: boolean;
+  /** Whether this folder starts open. */
+  defaultOpen?: boolean;
+}
+/** A node in the sidebar tree — either a page or a folder. */
+type SidebarNode = SidebarPageNode | SidebarFolderNode;
+/** The full sidebar tree passed to custom sidebar components. */
+interface SidebarTree {
+  name: string;
+  children: SidebarNode[];
+}
+/**
+ * Props passed to a custom sidebar component.
+ *
+ * Contains all the information needed to build a fully custom sidebar:
+ * the complete page tree with parent-child relationships, and the
+ * current sidebar configuration.
+ */
+interface SidebarComponentProps {
+  /** Full page tree with all parent-child-folder relationships. */
+  tree: SidebarTree;
+  /** Whether folders are collapsible. */
+  collapsible: boolean;
+  /** Whether folders are rendered flat (Mintlify-style). */
+  flat: boolean;
+}
+interface SidebarConfig {
+  /**
+   * Whether to show the sidebar.
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * Custom sidebar component to replace the default navigation.
+   *
+   * **Next.js** — Pass a render function that receives `SidebarComponentProps`:
+   * ```tsx
+   * sidebar: {
+   *   component: ({ tree, collapsible, flat }) => (
+   *     <MySidebar tree={tree} />
+   *   ),
+   * }
+   * ```
+   *
+   * **Astro** — Use the `sidebar` named slot on `<DocsLayout>`:
+   * ```astro
+   * <DocsLayout tree={tree} config={config}>
+   *   <MySidebar slot="sidebar" tree={tree} />
+   *   <slot />
+   * </DocsLayout>
+   * ```
+   *
+   * **SvelteKit** — Use the `sidebar` snippet on `<DocsLayout>`:
+   * ```svelte
+   * <DocsLayout {tree} {config}>
+   *   {#snippet sidebar({ tree, isActive })}
+   *     <MySidebarNav {tree} {isActive} />
+   *   {/snippet}
+   *   {@render children()}
+   * </DocsLayout>
+   * ```
+   *
+   * **Nuxt / Vue** — Use the `#sidebar` scoped slot on `<DocsLayout>`:
+   * ```vue
+   * <DocsLayout :tree="tree" :config="config">
+   *   <template #sidebar="{ tree, isActive }">
+   *     <MySidebarNav :tree="tree" :is-active="isActive" />
+   *   </template>
+   *   <DocsContent />
+   * </DocsLayout>
+   * ```
+   */
+  component?: (props: SidebarComponentProps) => unknown;
+  /**
+   * Sidebar footer content (rendered below navigation items).
+   */
+  footer?: unknown;
+  /**
+   * Sidebar banner content (rendered above navigation items).
+   */
+  banner?: unknown;
+  /**
+   * Whether the sidebar is collapsible on desktop.
+   * @default true
+   */
+  collapsible?: boolean;
+  /**
+   * When true, all folder children are rendered flat in the sidebar
+   * (no collapsible sections). Folder index pages appear as category
+   * headings with all children listed directly below them.
+   *
+   * This creates a Mintlify-style sidebar where all navigation items
+   * are always visible.
+   *
+   * @default false
+   */
+  flat?: boolean;
+}
+/**
+ * A single "Open in …" provider shown in the Open dropdown.
+ *
+ * @example
+ * ```ts
+ * { name: "Claude", icon: <ClaudeIcon />, urlTemplate: "https://claude.ai?url={url}" }
+ * ```
+ */
+interface OpenDocsProvider {
+  /** Display name (e.g. "ChatGPT", "Claude", "Cursor") */
+  name: string;
+  /** Icon element rendered next to the name */
+  icon?: unknown;
+  /**
+   * URL template. Placeholders:
+   * - `{url}` — current page URL (encoded).
+   * - `{mdxUrl}` — page URL with `.mdx` suffix (encoded).
+   * - `{githubUrl}` — GitHub edit URL for the current page (same as "Edit on GitHub"). Requires `github` in config.
+   *
+   * @example "https://claude.ai/new?q=Read+this+doc:+{url}"
+   * @example "{githubUrl}" — open current page file on GitHub (edit view)
+   */
+  urlTemplate: string;
+}
+/**
+ * Configuration for the "Open in …" dropdown that lets users
+ * send the current page to an LLM or external tool.
+ *
+ * @example
+ * ```ts
+ * openDocs: {
+ *   enabled: true,
+ *   providers: [
+ *     { name: "ChatGPT", icon: <ChatGPTIcon />, urlTemplate: "https://chatgpt.com/?q={url}" },
+ *     { name: "Claude", icon: <ClaudeIcon />, urlTemplate: "https://claude.ai/new?q={url}" },
+ *   ],
+ * }
+ * ```
+ */
+interface OpenDocsConfig {
+  /** Whether to show the "Open" dropdown. @default false */
+  enabled?: boolean;
+  /**
+   * List of LLM / tool providers to show in the dropdown.
+   * If not provided, a sensible default list is used.
+   */
+  providers?: OpenDocsProvider[];
+}
+/**
+ * Configuration for the "Copy Markdown" button that copies
+ * the current page's content as Markdown to the clipboard.
+ */
+interface CopyMarkdownConfig {
+  /** Whether to show the "Copy Markdown" button. @default false */
+  enabled?: boolean;
+}
+/**
+ * Page-level action buttons shown above the page content
+ * (e.g. "Copy Markdown", "Open in …" dropdown).
+ *
+ * @example
+ * ```ts
+ * pageActions: {
+ *   copyMarkdown: { enabled: true },
+ *   openDocs: {
+ *     enabled: true,
+ *     providers: [
+ *       { name: "Claude", urlTemplate: "https://claude.ai/new?q={url}" },
+ *     ],
+ *   },
+ * }
+ * ```
+ */
+interface PageActionsConfig {
+  /** "Copy Markdown" button */
+  copyMarkdown?: boolean | CopyMarkdownConfig;
+  /** "Open in …" dropdown with LLM / tool providers */
+  openDocs?: boolean | OpenDocsConfig;
+  /**
+   * Where to render the page action buttons relative to the page title.
+   *
+   * - `"below-title"` — render below the first `<h1>` heading (default)
+   * - `"above-title"` — render above the page title / content
+   *
+   * @default "below-title"
+   */
+  position?: "above-title" | "below-title";
+  /**
+   * Horizontal alignment of page action buttons.
+   *
+   * - `"left"` — align to the left (default)
+   * - `"right"` — align to the right
+   *
+   * @default "left"
+   */
+  alignment?: "left" | "right";
+}
+/**
+ * Configuration for the "Last updated" date display.
+ *
+ * @example
+ * ```ts
+ * lastUpdated: { position: "below-title" }
+ * ```
+ */
+/**
+ * Configuration for auto-generated `/llms.txt` and `/llms-full.txt` routes.
+ *
+ * @see https://llmstxt.org
+ */
+interface LlmsTxtConfig {
+  /**
+   * Whether to enable llms.txt generation.
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * Base URL for your docs site (used to build absolute links in llms.txt).
+   * @example "https://docs.example.com"
+   */
+  baseUrl?: string;
+  /**
+   * Site title shown at the top of llms.txt.
+   * Falls back to `nav.title` if not set.
+   */
+  siteTitle?: string;
+  /**
+   * Site description shown below the title.
+   */
+  siteDescription?: string;
+}
+interface LastUpdatedConfig {
+  /**
+   * Whether to show the "Last updated" date.
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * Where to render the "Last updated" date.
+   *
+   * - `"footer"` — next to the "Edit on GitHub" link at the bottom (default)
+   * - `"below-title"` — below the page title/description, above the content
+   *
+   * @default "footer"
+   */
+  position?: "footer" | "below-title";
+}
+/**
+ * GitHub repository configuration for "Edit on GitHub" links
+ * and source file references.
+ *
+ * @example
+ * ```ts
+ * // Simple repo (not a monorepo)
+ * github: {
+ *   url: "https://github.com/Kinfe123/my-docs",
+ * }
+ *
+ * // Monorepo — docs site lives in "website/" subdirectory
+ * github: {
+ *   url: "https://github.com/farming-labs/docs",
+ *   directory: "website",
+ *   branch: "main",
+ * }
+ * ```
+ *
+ * Or as a simple string (branch defaults to "main", no directory prefix):
+ * ```ts
+ * github: "https://github.com/Kinfe123/my-docs"
+ * ```
+ */
+interface GithubConfig {
+  /** Repository URL (e.g. "https://github.com/farming-labs/docs") */
+  url: string;
+  /** Branch name. @default "main" */
+  branch?: string;
+  /**
+   * Subdirectory inside the repo where the docs site lives.
+   * Use this for monorepos where the docs app is not at the repo root.
+   *
+   * @example "website" → links point to `website/app/docs/…/page.mdx`
+   */
+  directory?: string;
+}
+/**
+ * Configuration for "Ask AI" — a RAG-powered chat that lets users
+ * ask questions about the documentation content.
+ *
+ * The AI handler searches relevant doc pages, builds context, and
+ * streams a response from an LLM (OpenAI-compatible API).
+ *
+ * The API key is **never** stored in the config. It is read from the
+ * `OPENAI_API_KEY` environment variable at runtime on the server.
+ *
+ * @example
+ * ```ts
+ * ai: {
+ *   enabled: true,
+ *   model: "gpt-4o-mini",
+ *   systemPrompt: "You are a helpful assistant for our developer docs.",
+ * }
+ * ```
+ */
+interface AIConfig {
+  /**
+   * Whether to enable "Ask AI" functionality.
+   * When enabled, the unified `/api/docs` route handler will accept
+   * POST requests for AI chat.
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * How the AI chat UI is presented.
+   *
+   * - `"search"` — AI tab integrated into the Cmd+K search dialog (default)
+   * - `"floating"` — A floating chat widget (bubble button + slide-out panel)
+   *
+   * @default "search"
+   *
+   * @example
+   * ```ts
+   * // Floating chat bubble in the bottom-right corner
+   * ai: {
+   *   enabled: true,
+   *   mode: "floating",
+   *   position: "bottom-right",
+   * }
+   * ```
+   */
+  mode?: "search" | "floating" | "sidebar-icon";
+  /**
+   * Position of the floating chat button on screen.
+   * Only used when `mode` is `"floating"`.
+   *
+   * - `"bottom-right"` — bottom-right corner (default)
+   * - `"bottom-left"` — bottom-left corner
+   * - `"bottom-center"` — bottom center
+   *
+   * @default "bottom-right"
+   */
+  position?: "bottom-right" | "bottom-left" | "bottom-center";
+  /**
+   * Visual style of the floating chat when opened.
+   * Only used when `mode` is `"floating"`.
+   *
+   * - `"panel"` — A tall panel that slides up from the button position (default).
+   *   Stays anchored near the floating button. No backdrop overlay.
+   *
+   * - `"modal"` — A centered modal dialog with a backdrop overlay,
+   *   similar to the Cmd+K search dialog. Feels more focused and immersive.
+   *
+   * - `"popover"` — A compact popover near the button. Smaller than the
+   *   panel, suitable for quick questions without taking much screen space.
+   *
+   * - `"full-modal"` — A full-screen immersive overlay (inspired by better-auth).
+   *   Messages scroll in the center, input is pinned at the bottom.
+   *   Suggested questions appear as horizontal pills. Best for
+   *   documentation-heavy sites that want a premium AI experience.
+   *
+   * @default "panel"
+   *
+   * @example
+   * ```ts
+   * ai: {
+   *   enabled: true,
+   *   mode: "floating",
+   *   position: "bottom-right",
+   *   floatingStyle: "full-modal",
+   * }
+   * ```
+   */
+  floatingStyle?: "panel" | "modal" | "popover" | "full-modal";
+  /**
+   * Custom trigger component for the floating chat button (Next.js only).
+   * Only used when `mode` is `"floating"`.
+   *
+   * The click handler is attached automatically by the wrapper.
+   *
+   * - **Next.js**: Pass a JSX element via this config option.
+   * - **SvelteKit**: Use the `aiTrigger` snippet on `<DocsLayout>`.
+   * - **Nuxt / Vue**: Use the `ai-trigger` slot on `<DocsLayout>`.
+   * - **Astro**: Use `<MyTrigger slot="ai-trigger" />` on `<DocsLayout>`.
+   *
+   * @example
+   * ```tsx
+   * // Next.js — pass JSX directly in config
+   * triggerComponent: <button className="my-chat-btn">Ask AI</button>,
+   * ```
+   *
+   * ```svelte
+   * <!-- SvelteKit — use snippet in layout -->
+   * <DocsLayout {tree} {config}>
+   *   {#snippet aiTrigger()}<AskAITrigger />{/snippet}
+   *   {@render children()}
+   * </DocsLayout>
+   * ```
+   *
+   * ```vue
+   * <!-- Nuxt / Vue — use named slot in layout -->
+   * <DocsLayout :tree="tree" :config="config">
+   *   <template #ai-trigger><AskAITrigger /></template>
+   *   <DocsContent />
+   * </DocsLayout>
+   * ```
+   *
+   * ```astro
+   * <!-- Astro — use named slot in layout -->
+   * <DocsLayout tree={tree} config={config}>
+   *   <AskAITrigger slot="ai-trigger" />
+   *   <DocsContent />
+   * </DocsLayout>
+   * ```
+   */
+  triggerComponent?: unknown;
+  /**
+   * The LLM model configuration.
+   *
+   * **Simple** — pass a plain string for a single model:
+   * ```ts
+   * model: "gpt-4o-mini"
+   * ```
+   *
+   * **Advanced** — pass an object with multiple selectable models and an
+   * optional `provider` key that references a named provider in `providers`:
+   * ```ts
+   * model: {
+   *   models: [
+   *     { id: "gpt-4o-mini", label: "GPT-4o mini (fast)", provider: "openai" },
+   *     { id: "llama-3.3-70b-versatile", label: "Llama 3.3 70B", provider: "groq" },
+   *   ],
+   *   defaultModel: "gpt-4o-mini",
+   * }
+   * ```
+   *
+   * When an object is provided, a model selector dropdown appears in the
+   * AI chat interface.
+   *
+   * @default "gpt-4o-mini"
+   */
+  model?: string | {
+    models: {
+      id: string;
+      label: string;
+      provider?: string;
+    }[];
+    defaultModel?: string;
+  };
+  /**
+   * Named provider configurations for multi-provider setups.
+   *
+   * Each key is a provider name referenced by `model.models[].provider`.
+   * Each value contains a `baseUrl` and optional `apiKey`.
+   *
+   * @example
+   * ```ts
+   * providers: {
+   *   openai: {
+   *     baseUrl: "https://api.openai.com/v1",
+   *     apiKey: process.env.OPENAI_API_KEY,
+   *   },
+   *   groq: {
+   *     baseUrl: "https://api.groq.com/openai/v1",
+   *     apiKey: process.env.GROQ_API_KEY,
+   *   },
+   * }
+   * ```
+   */
+  providers?: Record<string, {
+    baseUrl: string;
+    apiKey?: string;
+  }>;
+  /**
+   * Custom system prompt prepended to the AI conversation.
+   * The documentation context is automatically appended after this prompt.
+   *
+   * @default "You are a helpful documentation assistant. Answer questions
+   * based on the provided documentation context. Be concise and accurate.
+   * If the answer is not in the context, say so honestly."
+   */
+  systemPrompt?: string;
+  /**
+   * Default base URL for an OpenAI-compatible API endpoint.
+   * Used when no per-model `provider` is configured.
+   * @default "https://api.openai.com/v1"
+   */
+  baseUrl?: string;
+  /**
+   * Default API key for the LLM provider.
+   * Used when no per-model `provider` is configured.
+   * Falls back to `process.env.OPENAI_API_KEY` if not set.
+   *
+   * @default process.env.OPENAI_API_KEY
+   *
+   * @example
+   * ```ts
+   * // Default — reads OPENAI_API_KEY automatically
+   * ai: { enabled: true }
+   *
+   * // Custom provider key
+   * ai: {
+   *   enabled: true,
+   *   apiKey: process.env.GROQ_API_KEY,
+   * }
+   * ```
+   */
+  apiKey?: string;
+  /**
+   * Maximum number of search results to include as context for the AI.
+   * More results = more context but higher token usage.
+   * @default 5
+   */
+  maxResults?: number;
+  /**
+   * Pre-filled suggested questions shown in the AI chat when empty.
+   * When a user clicks one, it fills the input and submits automatically.
+   *
+   * @example
+   * ```ts
+   * ai: {
+   *   enabled: true,
+   *   suggestedQuestions: [
+   *     "How do I install this?",
+   *     "What themes are available?",
+   *     "How do I create a custom component?",
+   *   ],
+   * }
+   * ```
+   */
+  suggestedQuestions?: string[];
+  /**
+   * Display name for the AI assistant in the chat UI.
+   * Shown as the message label, header title, and passed to the loading component.
+   *
+   * @default "AI"
+   *
+   * @example
+   * ```ts
+   * ai: {
+   *   enabled: true,
+   *   aiLabel: "DocsBot",
+   * }
+   * ```
+   */
+  aiLabel?: string;
+  /**
+   * The npm package name used in import examples.
+   * The AI will use this in code snippets instead of generic placeholders.
+   *
+   * @example
+   * ```ts
+   * ai: {
+   *   enabled: true,
+   *   packageName: "@farming-labs/docs",
+   * }
+   * ```
+   */
+  packageName?: string;
+  /**
+   * The public URL of the documentation site.
+   * The AI will use this for links instead of relative paths.
+   *
+   * @example
+   * ```ts
+   * ai: {
+   *   enabled: true,
+   *   docsUrl: "https://docs.farming-labs.dev",
+   * }
+   * ```
+   */
+  docsUrl?: string;
+  /**
+   * Loading indicator variant shown while the AI generates a response.
+   *
+   * - `"shimmer-dots"` — shimmer text + typing dots (default)
+   * - `"circular"` — spinning ring
+   * - `"dots"` — bouncing dots
+   * - `"typing"` — typing dots
+   * - `"wave"` — wave bars
+   * - `"bars"` — thick wave bars
+   * - `"pulse"` — pulsing ring
+   * - `"pulse-dot"` — pulsing dot
+   * - `"terminal"` — blinking terminal cursor
+   * - `"text-blink"` — blinking text
+   * - `"text-shimmer"` — shimmer text only
+   * - `"loading-dots"` — "Thinking..." with animated dots
+   *
+   * @default "shimmer-dots"
+   *
+   * @example
+   * ```ts
+   * ai: {
+   *   enabled: true,
+   *   loader: "wave",
+   * }
+   * ```
+   */
+  loader?: "shimmer-dots" | "circular" | "dots" | "typing" | "wave" | "bars" | "pulse" | "pulse-dot" | "terminal" | "text-blink" | "text-shimmer" | "loading-dots";
+  /**
+   * Custom loading indicator that overrides the built-in `loader` variant.
+   * Receives `{ name }` (the `aiLabel` value) and returns a React element.
+   *
+   * Only works in Next.js. For other frameworks, use the `loader` option.
+   *
+   * @example
+   * ```tsx
+   * ai: {
+   *   enabled: true,
+   *   aiLabel: "Sage",
+   *   loadingComponent: ({ name }) => (
+   *     <div className="flex items-center gap-2 text-sm text-zinc-400">
+   *       <span className="animate-pulse">🤔</span>
+   *       <span>{name} is thinking...</span>
+   *     </div>
+   *   ),
+   * }
+   * ```
+   */
+  loadingComponent?: (props: {
+    name: string;
+  }) => unknown;
+}
+/**
+ * A single item in the slug-based sidebar ordering.
+ *
+ * @example
+ * ```ts
+ * ordering: [
+ *   { slug: "installation" },
+ *   { slug: "cli" },
+ *   { slug: "themes", children: [
+ *     { slug: "default" },
+ *     { slug: "darksharp" },
+ *     { slug: "pixel-border" },
+ *     { slug: "creating-themes" },
+ *   ]},
+ *   { slug: "reference" },
+ * ]
+ * ```
+ */
+interface OrderingItem {
+  /** Folder name (not the full path, just the directory name at this level) */
+  slug: string;
+  /** Ordering for child pages within this folder */
+  children?: OrderingItem[];
+}
+/**
+ * Data passed to the `onCopyClick` callback when the user clicks the copy button
+ * on a code block in the docs.
+ */
+interface CodeBlockCopyData {
+  /** Title of the code block (e.g. from the fenced code block meta string), if present */
+  title?: string;
+  /** Raw code content (the text that was copied to the clipboard) */
+  content: string;
+  /** Current page URL at the time of copy */
+  url: string;
+  /** Language / syntax hint (e.g. "tsx", "bash"), if present */
+  language?: string;
+}
+interface DocsI18nConfig {
+  /** Supported locale identifiers (e.g. ["en", "fr"]). */
+  locales: string[];
+  /** Default locale when `?lang=` is missing or invalid. Defaults to first locale. */
+  defaultLocale?: string;
+}
+interface ApiReferenceConfig {
+  /**
+   * Whether to enable generated API reference pages.
+   * The initial implementation is wired for Next.js route handlers.
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * URL path where the generated API reference lives.
+   * Example: `"api-reference"` → `/api-reference`
+   * @default "api-reference"
+   */
+  path?: string;
+  /**
+   * Filesystem route root to scan for API handlers.
+   *
+   * For Next.js this defaults to the App Router convention:
+   * `app/api` or `src/app/api`.
+   *
+   * You can override it with a project-relative path like `"app/v1"` or
+   * `"src/app/internal-api"`. If you pass a bare segment like `"api"` or
+   * `"v1"`, it will be resolved inside the detected app directory.
+   */
+  routeRoot?: string;
+  /**
+   * Route entries to exclude from the generated API reference.
+   *
+   * Accepts either URL-style paths like `"/api/hello"` or route-root-relative
+   * entries like `"hello"` / `"hello/route.ts"`.
+   */
+  exclude?: string[];
+}
+interface DocsConfig {
+  /** Entry folder for docs (e.g. "docs" → /docs) */
+  entry: string;
+  /** Path to the content directory. Defaults to `entry` value. */
+  contentDir?: string;
+  /**
+   * Internationalization (i18n) configuration.
+   * When set, docs content is expected under `${contentDir}/{locale}` and
+   * the active locale is selected by `?lang=<locale>` in the URL.
+   */
+  i18n?: DocsI18nConfig;
+  /**
+   * Set to `true` when building for full static export (e.g. Cloudflare Pages).
+   * When using `output: 'export'` in Next.js, the `/api/docs` route is not generated.
+   * Set `ai.enabled: false` and optionally rely on client-side search or leave search disabled.
+   */
+  staticExport?: boolean;
+  /** Theme configuration - single source of truth for UI */
+  theme?: DocsTheme;
+  /**
+   * GitHub repository URL or config. Enables "Edit on GitHub" links
+   * on each docs page footer, pointing to the source `.mdx` file.
+   *
+   * @example
+   * ```ts
+   * // Simple — branch defaults to "main"
+   * github: "https://github.com/Kinfe123/my-docs"
+   *
+   * // Monorepo — docs site lives in "website/" subdirectory
+   * github: {
+   *   url: "https://github.com/farming-labs/docs",
+   *   directory: "website",
+   * }
+   *
+   * // Custom branch
+   * github: {
+   *   url: "https://github.com/Kinfe123/my-docs",
+   *   branch: "develop",
+   * }
+   * ```
+   */
+  github?: string | GithubConfig;
+  /**
+   * Sidebar navigation header.
+   * Customise the title shown at the top of the sidebar.
+   */
+  nav?: DocsNav;
+  /**
+   * Theme toggle (light/dark mode switcher) in the sidebar.
+   *
+   * - `true` or `undefined` → toggle is shown (default)
+   * - `false` → toggle is hidden, defaults to system theme
+   * - `{ enabled: false, default: "dark" }` → toggle hidden, force dark
+   *
+   * @example
+   * ```ts
+   * // Hide toggle, force dark mode
+   * themeToggle: { enabled: false, default: "dark" }
+   *
+   * // Show toggle with system option
+   * themeToggle: { mode: "light-dark-system" }
+   * ```
+   */
+  themeToggle?: boolean | ThemeToggleConfig;
+  /**
+   * Breadcrumb navigation above page content.
+   *
+   * - `true` or `undefined` → breadcrumb is shown (default)
+   * - `false` → breadcrumb is hidden
+   * - `{ enabled: false }` → breadcrumb is hidden
+   * - `{ component: MyBreadcrumb }` → custom breadcrumb component
+   */
+  breadcrumb?: boolean | BreadcrumbConfig;
+  /**
+   * Sidebar customisation.
+   *
+   * - `true` or `undefined` → default sidebar
+   * - `false` → sidebar is hidden
+   * - `{ component: MySidebar }` → custom sidebar component
+   * - `{ footer: <MyFooter />, banner: <MyBanner /> }` → add footer/banner
+   */
+  sidebar?: boolean | SidebarConfig;
+  /**
+   * Custom MDX component overrides.
+   *
+   * Pass your own React components to replace defaults (e.g. Callout, CodeBlock).
+   * Components must match the expected props interface.
+   *
+   * @example
+   * ```ts
+   * import { MyCallout } from "./components/my-callout";
+   *
+   * export default defineDocs({
+   *   entry: "docs",
+   *   theme: fumadocs(),
+   *   components: {
+   *     Callout: MyCallout,
+   *   },
+   * });
+   * ```
+   */
+  components?: Record<string, unknown>;
+  /**
+   * Callback fired when the user clicks the copy button on a code block.
+   * Called in addition to the default copy-to-clipboard behavior.
+   * Use it for analytics, logging, or custom behavior.
+   *
+   * @example
+   * ```ts
+   * export default defineDocs({
+   *   entry: "docs",
+   *   theme: fumadocs(),
+   *   onCopyClick(data) {
+   *     console.log("Code copied", data.title, data.language, data.url);
+   *     analytics.track("code_block_copy", { title: data.title, url: data.url });
+   *   },
+   * });
+   * ```
+   */
+  onCopyClick?: (data: CodeBlockCopyData) => void;
+  /**
+   * Icon registry for sidebar items.
+   *
+   * Map string labels to React elements. Reference them in page frontmatter
+   * with `icon: "label"` and the matching icon renders in the sidebar.
+   *
+   * @example
+   * ```tsx
+   * import { Book, Terminal, Rocket } from "lucide-react";
+   *
+   * export default defineDocs({
+   *   entry: "docs",
+   *   theme: fumadocs(),
+   *   icons: {
+   *     book: <Book />,
+   *     terminal: <Terminal />,
+   *     rocket: <Rocket />,
+   *   },
+   * });
+   * ```
+   *
+   * Then in `page.mdx` frontmatter:
+   * ```yaml
+   * ---
+   * title: "CLI Reference"
+   * icon: "terminal"
+   * ---
+   * ```
+   */
+  icons?: Record<string, unknown>;
+  /**
+   * Page action buttons shown above the content area.
+   * Includes "Copy Markdown" and "Open in …" (LLM dropdown).
+   *
+   * @example
+   * ```ts
+   * pageActions: {
+   *   copyMarkdown: { enabled: true },
+   *   openDocs: {
+   *     enabled: true,
+   *     providers: [
+   *       { name: "ChatGPT", urlTemplate: "https://chatgpt.com/?q={url}" },
+   *       { name: "Claude", urlTemplate: "https://claude.ai/new?q={url}" },
+   *     ],
+   *   },
+   * }
+   * ```
+   */
+  pageActions?: PageActionsConfig;
+  /**
+   * Configuration for the "Last updated" date display.
+   *
+   * - `true` or `undefined` → shown in footer next to "Edit on GitHub" (default)
+   * - `false` → hidden
+   * - `{ position: "below-title" }` → shown below the page title
+   * - `{ position: "footer" }` → shown next to "Edit on GitHub" (default)
+   *
+   * @example
+   * ```ts
+   * // Show below title (Mintlify style)
+   * lastUpdated: { position: "below-title" }
+   *
+   * // Hide entirely
+   * lastUpdated: false
+   * ```
+   */
+  lastUpdated?: boolean | LastUpdatedConfig;
+  /**
+   * AI-powered "Ask AI" chat for documentation.
+   *
+   * When enabled, the unified API route handler (`/api/docs`) accepts
+   * POST requests for AI chat. The handler uses RAG (Retrieval-Augmented
+   * Generation) — it searches relevant docs, builds context, and streams
+   * a response from an LLM.
+   *
+   * The API key defaults to `process.env.OPENAI_API_KEY`. For other providers,
+   * pass the key via `apiKey: process.env.YOUR_KEY`.
+   *
+   * @example
+   * ```ts
+   * // Enable with defaults (gpt-4o-mini, OPENAI_API_KEY)
+   * ai: { enabled: true }
+   *
+   * // Custom model + system prompt
+   * ai: {
+   *   enabled: true,
+   *   model: "gpt-4o",
+   *   systemPrompt: "You are an expert on our SDK. Be concise.",
+   * }
+   *
+   * // Use a different provider (e.g. Groq)
+   * ai: {
+   *   enabled: true,
+   *   baseUrl: "https://api.groq.com/openai/v1",
+   *   apiKey: process.env.GROQ_API_KEY,
+   *   model: "llama-3.1-70b-versatile",
+   * }
+   * ```
+   */
+  ai?: AIConfig;
+  /**
+   * Sidebar ordering strategy.
+   *
+   * - `"alphabetical"` — sort pages alphabetically by folder name (default)
+   * - `"numeric"` — sort by frontmatter `order` field (lower first, unset pages last)
+   * - `OrderingItem[]` — explicit slug-based ordering with nested children
+   *
+   * @default "alphabetical"
+   *
+   * @example
+   * ```ts
+   * // Alphabetical (default)
+   * ordering: "alphabetical",
+   *
+   * // Use frontmatter `order: 1`, `order: 2`, etc.
+   * ordering: "numeric",
+   *
+   * // Explicit slug-based ordering
+   * ordering: [
+   *   { slug: "installation" },
+   *   { slug: "cli" },
+   *   { slug: "configuration" },
+   *   { slug: "themes", children: [
+   *     { slug: "default" },
+   *     { slug: "darksharp" },
+   *     { slug: "pixel-border" },
+   *     { slug: "creating-themes" },
+   *   ]},
+   *   { slug: "customization" },
+   *   { slug: "reference" },
+   * ]
+   * ```
+   */
+  ordering?: "alphabetical" | "numeric" | OrderingItem[];
+  /**
+   * Auto-generate `/llms.txt` and `/llms-full.txt` routes for LLM-friendly
+   * documentation. These files let AI tools quickly understand your docs.
+   *
+   * @example
+   * ```ts
+   * llmsTxt: {
+   *   enabled: true,
+   *   baseUrl: "https://docs.example.com",
+   * }
+   * ```
+   *
+   * @see https://llmstxt.org
+   */
+  llmsTxt?: boolean | LlmsTxtConfig;
+  /**
+   * Generated API reference pages from framework route conventions.
+   *
+   * The first implementation targets Next.js route handlers under `app/api/<segments>/route.ts`.
+   *
+   * @example
+   * ```ts
+   * apiReference: {
+   *   enabled: true,
+   *   path: "api-reference",
+   *   routeRoot: "api",
+   * }
+   * ```
+   */
+  apiReference?: boolean | ApiReferenceConfig;
+  /** SEO metadata - separate from theme */
+  metadata?: DocsMetadata;
+  /** Open Graph image handling */
+  og?: OGConfig;
+}
+//#endregion
+export { ThemeToggleConfig as A, PageTwitter as C, SidebarNode as D, SidebarFolderNode as E, UIConfig as M, SidebarPageNode as O, PageOpenGraph as S, SidebarConfig as T, OpenDocsProvider as _, CopyMarkdownConfig as a, PageActionsConfig as b, DocsMetadata as c, FontStyle as d, GithubConfig as f, OpenDocsConfig as g, OGConfig as h, CodeBlockCopyData as i, TypographyConfig as j, SidebarTree as k, DocsNav as l, LlmsTxtConfig as m, ApiReferenceConfig as n, DocsConfig as o, LastUpdatedConfig as p, BreadcrumbConfig as r, DocsI18nConfig as s, AIConfig as t, DocsTheme as u, OpenGraphImage as v, SidebarComponentProps as w, PageFrontmatter as x, OrderingItem as y };