boltdocs 1.0.0

package/dist/client/index.d.mts

@@ -0,0 +1,298 @@
+import { B as BoltdocsConfig } from '../config-D2XmHJYe.mjs';
+export { a as BoltdocsThemeConfig } from '../config-D2XmHJYe.mjs';
+import { C as ComponentRoute } from '../index-CRQKWAeo.mjs';
+export { a as CreateBoltdocsAppOptions, c as createBoltdocsApp } from '../index-CRQKWAeo.mjs';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import 'vite';
+
+/**
+ * The top navigation bar of the documentation site.
+ */
+declare function Navbar({ config, routes, allRoutes, currentLocale, currentVersion, }: {
+    config: BoltdocsConfig;
+    routes?: ComponentRoute[];
+    allRoutes?: ComponentRoute[];
+    currentLocale?: string;
+    currentVersion?: string;
+}): react_jsx_runtime.JSX.Element;
+
+interface RouteItem {
+    path: string;
+    title: string;
+    group?: string;
+    groupTitle?: string;
+    sidebarPosition?: number;
+    badge?: string | {
+        text: string;
+        expires?: string;
+    };
+}
+/**
+ * The sidebar navigation component.
+ * Groups documentation routes logically based on the `group` property.
+ * Highlights the active link based on the current URL path.
+ *
+ * @param routes - Array of all generated routes to be displayed
+ * @param config - Global configuration (which can contain sidebar overrides)
+ */
+declare function Sidebar({ routes, config, onCollapse, }: {
+    routes: RouteItem[];
+    config: BoltdocsConfig;
+    onCollapse?: () => void;
+}): react_jsx_runtime.JSX.Element;
+
+interface TocHeading {
+    id: string;
+    text: string;
+    level: number;
+}
+declare function OnThisPage({ headings, editLink, communityHelp, filePath, }: {
+    headings?: TocHeading[];
+    editLink?: string;
+    communityHelp?: string;
+    filePath?: string;
+}): react_jsx_runtime.JSX.Element | null;
+
+interface HeadProps {
+    siteTitle: string;
+    siteDescription?: string;
+    routes: Array<{
+        path: string;
+        title: string;
+        description?: string;
+    }>;
+}
+declare function Head({ siteTitle, siteDescription, routes }: HeadProps): null;
+
+interface BreadcrumbsProps {
+    routes: ComponentRoute[];
+    config: BoltdocsConfig;
+}
+declare function Breadcrumbs({ routes, config }: BreadcrumbsProps): react_jsx_runtime.JSX.Element | null;
+
+declare function BackgroundGradient(): react_jsx_runtime.JSX.Element;
+
+interface ThemeLayoutProps {
+    config: BoltdocsConfig;
+    routes: ComponentRoute[];
+    children: React.ReactNode;
+    /** Custom navbar component (slots) */
+    navbar?: React.ReactNode;
+    /** Custom sidebar component (slots) */
+    sidebar?: React.ReactNode;
+    /** Custom table of contents (OnThisPage) component (slots) */
+    toc?: React.ReactNode;
+    /** Custom background component (slots) */
+    background?: React.ReactNode;
+    /** Custom head/metadata component (slots) */
+    head?: React.ReactNode;
+    /** Custom breadcrumbs component (slots) */
+    breadcrumbs?: React.ReactNode;
+    /** Custom class name for the root layout element */
+    className?: string;
+    /** Custom styles for the root layout element */
+    style?: React.CSSProperties;
+}
+/**
+ * The main structural layout for documentation pages.
+ * Integrates the Navbar, Sidebar, and OnThisPage components into a cohesive shell.
+ * It also manages mobile interaction states like the sidebar overlay toggle.
+ *
+ * @param config - The global Boltdocs configuration object
+ * @param routes - The array of available doc routes (used to render the sidebar)
+ */
+declare function ThemeLayout({ config, routes, children, navbar, sidebar, toc, background, head, breadcrumbs, className, style, }: ThemeLayoutProps): react_jsx_runtime.JSX.Element;
+
+interface PlaygroundProps {
+    code?: string;
+    children?: string | React.ReactNode;
+    scope?: Record<string, any>;
+    readonly?: boolean;
+}
+/**
+ * A live React playground component.
+ * Features a split layout with a live editor and a preview section.
+ */
+declare function Playground({ code, children, scope, readonly, }: PlaygroundProps): react_jsx_runtime.JSX.Element;
+
+declare function NotFound(): react_jsx_runtime.JSX.Element;
+
+declare function Loading(): react_jsx_runtime.JSX.Element;
+
+interface CodeBlockProps {
+    children?: React.ReactNode;
+    className?: string;
+    [key: string]: any;
+}
+/**
+ * A specialized wrapper for code snippets compiled from MDX blocks.
+ * Provides syntax highlighting styling scaffolding and a "Copy to Clipboard" button.
+ */
+declare function CodeBlock({ children, ...props }: CodeBlockProps): react_jsx_runtime.JSX.Element;
+
+interface VideoProps {
+    /** Video source URL */
+    src?: string;
+    /** Poster/thumbnail image URL */
+    poster?: string;
+    /** Alt text for accessibility */
+    alt?: string;
+    /** Show native video controls (default: true) */
+    controls?: boolean;
+    /** Preload strategy (default: 'none') */
+    preload?: string;
+    /** Children (e.g. <source> elements) */
+    children?: React.ReactNode;
+    /** Allow any additional HTML video attributes */
+    [key: string]: any;
+}
+/**
+ * Optimized video component with lazy loading via IntersectionObserver.
+ * The `<video>` element is only rendered once it enters the viewport,
+ * preventing unnecessary network downloads on initial page load.
+ *
+ * Usage in MDX:
+ * ```mdx
+ * <video src="/demo.mp4" poster="/demo-thumb.jpg" />
+ * ```
+ */
+declare function Video({ src, poster, alt, children, controls, preload, ...rest }: VideoProps): react_jsx_runtime.JSX.Element;
+
+type ButtonProps = React.AnchorHTMLAttributes<HTMLAnchorElement> & React.ButtonHTMLAttributes<HTMLButtonElement> & {
+    /** Visual variant */
+    variant?: "primary" | "secondary" | "outline" | "ghost";
+    /** Size */
+    size?: "sm" | "md" | "lg";
+    /** If provided, renders as a link */
+    href?: string;
+    children: React.ReactNode;
+};
+/**
+ * A versatile button/link component for use in MDX pages and the home page.
+ *
+ * ```mdx
+ * <Button variant="primary" href="/docs/getting-started">Get Started →</Button>
+ * <Button variant="secondary" href="https://github.com">GitHub</Button>
+ * ```
+ */
+declare function Button({ variant, size, href, children, className, ...rest }: ButtonProps): react_jsx_runtime.JSX.Element;
+
+interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
+    /** Color variant */
+    variant?: "default" | "primary" | "success" | "warning" | "danger" | "info";
+    children: React.ReactNode;
+}
+/**
+ * Inline badge / pill for labels, statuses, or tags.
+ *
+ * ```mdx
+ * <Badge variant="success">Stable</Badge>
+ * <Badge variant="warning">Beta</Badge>
+ * ```
+ */
+declare function Badge({ variant, children, className, ...rest }: BadgeProps): react_jsx_runtime.JSX.Element;
+
+interface CardsProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Number of columns (defaults to 3) */
+    cols?: 1 | 2 | 3 | 4;
+    children: React.ReactNode;
+}
+/**
+ * Grid wrapper for `<Card>` components.
+ *
+ * ```mdx
+ * <Cards cols={3}>
+ *   <Card title="Fast" icon="⚡">Instant HMR.</Card>
+ *   <Card title="Simple" icon="📁">File-system routing.</Card>
+ * </Cards>
+ * ```
+ */
+declare function Cards({ cols, children, className, ...rest }: CardsProps): react_jsx_runtime.JSX.Element;
+interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Card heading */
+    title?: string;
+    /** Emoji or icon string displayed above the title */
+    icon?: React.ReactNode;
+    /** If provided, the entire card becomes a link */
+    href?: string;
+    children?: React.ReactNode;
+}
+/**
+ * Individual feature/info card.
+ */
+declare function Card({ title, icon, href, children, className, ...rest }: CardProps): react_jsx_runtime.JSX.Element;
+
+interface TabProps {
+    /** The label shown in the tab bar */
+    label: string;
+    children: React.ReactNode;
+}
+/**
+ * A single tab panel. Must be used inside `<Tabs>`.
+ *
+ * ```mdx
+ * <Tab label="npm">npm install boltdocs</Tab>
+ * ```
+ */
+declare function Tab({ children }: TabProps): react_jsx_runtime.JSX.Element;
+interface TabsProps {
+    /** Which tab index is initially active (0-based, default 0) */
+    defaultIndex?: number;
+    children: React.ReactNode;
+}
+/**
+ * Tab container that manages active state.
+ *
+ * ```mdx
+ * <Tabs>
+ *   <Tab label="npm">npm install boltdocs</Tab>
+ *   <Tab label="pnpm">pnpm add boltdocs</Tab>
+ *   <Tab label="yarn">yarn add boltdocs</Tab>
+ * </Tabs>
+ * ```
+ */
+declare function Tabs({ defaultIndex, children }: TabsProps): react_jsx_runtime.JSX.Element;
+
+interface AdmonitionProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Admonition type — controls color and icon */
+    type?: "note" | "tip" | "info" | "warning" | "danger";
+    /** Override the default title */
+    title?: string;
+    children: React.ReactNode;
+}
+/**
+ * Callout / admonition box for notes, warnings, etc.
+ *
+ * ```mdx
+ * <Admonition type="warning" title="Breaking Change">
+ *   This API has changed in v2.
+ * </Admonition>
+ * ```
+ */
+declare function Admonition({ type, title, children, className, ...rest }: AdmonitionProps): react_jsx_runtime.JSX.Element;
+declare const Note: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const Tip: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const Warning: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const Danger: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const InfoBox: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+
+interface ListProps extends React.HTMLAttributes<HTMLUListElement> {
+    /** Visual variant */
+    variant?: "checked" | "arrow" | "default";
+    children: React.ReactNode;
+}
+/**
+ * Enhanced list component with icon variants.
+ *
+ * ```mdx
+ * <List variant="checked">
+ *   <li>File-system routing</li>
+ *   <li>MDX support</li>
+ *   <li>Syntax highlighting</li>
+ * </List>
+ * ```
+ */
+declare function List({ variant, children, className, ...rest }: ListProps): react_jsx_runtime.JSX.Element;
+
+export { Admonition, type AdmonitionProps, BackgroundGradient, Badge, type BadgeProps, BoltdocsConfig, Breadcrumbs, Button, type ButtonProps, Card, type CardProps, Cards, type CardsProps, CodeBlock, ComponentRoute, Danger, Head, InfoBox, List, type ListProps, Loading, Navbar, NotFound, Note, OnThisPage, Playground, Sidebar, Tab, type TabProps, Tabs, type TabsProps, ThemeLayout, Tip, Video, Warning };

package/dist/client/index.d.ts

@@ -0,0 +1,298 @@
+import { B as BoltdocsConfig } from '../config-D2XmHJYe.js';
+export { a as BoltdocsThemeConfig } from '../config-D2XmHJYe.js';
+import { C as ComponentRoute } from '../index-CRQKWAeo.js';
+export { a as CreateBoltdocsAppOptions, c as createBoltdocsApp } from '../index-CRQKWAeo.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import 'vite';
+
+/**
+ * The top navigation bar of the documentation site.
+ */
+declare function Navbar({ config, routes, allRoutes, currentLocale, currentVersion, }: {
+    config: BoltdocsConfig;
+    routes?: ComponentRoute[];
+    allRoutes?: ComponentRoute[];
+    currentLocale?: string;
+    currentVersion?: string;
+}): react_jsx_runtime.JSX.Element;
+
+interface RouteItem {
+    path: string;
+    title: string;
+    group?: string;
+    groupTitle?: string;
+    sidebarPosition?: number;
+    badge?: string | {
+        text: string;
+        expires?: string;
+    };
+}
+/**
+ * The sidebar navigation component.
+ * Groups documentation routes logically based on the `group` property.
+ * Highlights the active link based on the current URL path.
+ *
+ * @param routes - Array of all generated routes to be displayed
+ * @param config - Global configuration (which can contain sidebar overrides)
+ */
+declare function Sidebar({ routes, config, onCollapse, }: {
+    routes: RouteItem[];
+    config: BoltdocsConfig;
+    onCollapse?: () => void;
+}): react_jsx_runtime.JSX.Element;
+
+interface TocHeading {
+    id: string;
+    text: string;
+    level: number;
+}
+declare function OnThisPage({ headings, editLink, communityHelp, filePath, }: {
+    headings?: TocHeading[];
+    editLink?: string;
+    communityHelp?: string;
+    filePath?: string;
+}): react_jsx_runtime.JSX.Element | null;
+
+interface HeadProps {
+    siteTitle: string;
+    siteDescription?: string;
+    routes: Array<{
+        path: string;
+        title: string;
+        description?: string;
+    }>;
+}
+declare function Head({ siteTitle, siteDescription, routes }: HeadProps): null;
+
+interface BreadcrumbsProps {
+    routes: ComponentRoute[];
+    config: BoltdocsConfig;
+}
+declare function Breadcrumbs({ routes, config }: BreadcrumbsProps): react_jsx_runtime.JSX.Element | null;
+
+declare function BackgroundGradient(): react_jsx_runtime.JSX.Element;
+
+interface ThemeLayoutProps {
+    config: BoltdocsConfig;
+    routes: ComponentRoute[];
+    children: React.ReactNode;
+    /** Custom navbar component (slots) */
+    navbar?: React.ReactNode;
+    /** Custom sidebar component (slots) */
+    sidebar?: React.ReactNode;
+    /** Custom table of contents (OnThisPage) component (slots) */
+    toc?: React.ReactNode;
+    /** Custom background component (slots) */
+    background?: React.ReactNode;
+    /** Custom head/metadata component (slots) */
+    head?: React.ReactNode;
+    /** Custom breadcrumbs component (slots) */
+    breadcrumbs?: React.ReactNode;
+    /** Custom class name for the root layout element */
+    className?: string;
+    /** Custom styles for the root layout element */
+    style?: React.CSSProperties;
+}
+/**
+ * The main structural layout for documentation pages.
+ * Integrates the Navbar, Sidebar, and OnThisPage components into a cohesive shell.
+ * It also manages mobile interaction states like the sidebar overlay toggle.
+ *
+ * @param config - The global Boltdocs configuration object
+ * @param routes - The array of available doc routes (used to render the sidebar)
+ */
+declare function ThemeLayout({ config, routes, children, navbar, sidebar, toc, background, head, breadcrumbs, className, style, }: ThemeLayoutProps): react_jsx_runtime.JSX.Element;
+
+interface PlaygroundProps {
+    code?: string;
+    children?: string | React.ReactNode;
+    scope?: Record<string, any>;
+    readonly?: boolean;
+}
+/**
+ * A live React playground component.
+ * Features a split layout with a live editor and a preview section.
+ */
+declare function Playground({ code, children, scope, readonly, }: PlaygroundProps): react_jsx_runtime.JSX.Element;
+
+declare function NotFound(): react_jsx_runtime.JSX.Element;
+
+declare function Loading(): react_jsx_runtime.JSX.Element;
+
+interface CodeBlockProps {
+    children?: React.ReactNode;
+    className?: string;
+    [key: string]: any;
+}
+/**
+ * A specialized wrapper for code snippets compiled from MDX blocks.
+ * Provides syntax highlighting styling scaffolding and a "Copy to Clipboard" button.
+ */
+declare function CodeBlock({ children, ...props }: CodeBlockProps): react_jsx_runtime.JSX.Element;
+
+interface VideoProps {
+    /** Video source URL */
+    src?: string;
+    /** Poster/thumbnail image URL */
+    poster?: string;
+    /** Alt text for accessibility */
+    alt?: string;
+    /** Show native video controls (default: true) */
+    controls?: boolean;
+    /** Preload strategy (default: 'none') */
+    preload?: string;
+    /** Children (e.g. <source> elements) */
+    children?: React.ReactNode;
+    /** Allow any additional HTML video attributes */
+    [key: string]: any;
+}
+/**
+ * Optimized video component with lazy loading via IntersectionObserver.
+ * The `<video>` element is only rendered once it enters the viewport,
+ * preventing unnecessary network downloads on initial page load.
+ *
+ * Usage in MDX:
+ * ```mdx
+ * <video src="/demo.mp4" poster="/demo-thumb.jpg" />
+ * ```
+ */
+declare function Video({ src, poster, alt, children, controls, preload, ...rest }: VideoProps): react_jsx_runtime.JSX.Element;
+
+type ButtonProps = React.AnchorHTMLAttributes<HTMLAnchorElement> & React.ButtonHTMLAttributes<HTMLButtonElement> & {
+    /** Visual variant */
+    variant?: "primary" | "secondary" | "outline" | "ghost";
+    /** Size */
+    size?: "sm" | "md" | "lg";
+    /** If provided, renders as a link */
+    href?: string;
+    children: React.ReactNode;
+};
+/**
+ * A versatile button/link component for use in MDX pages and the home page.
+ *
+ * ```mdx
+ * <Button variant="primary" href="/docs/getting-started">Get Started →</Button>
+ * <Button variant="secondary" href="https://github.com">GitHub</Button>
+ * ```
+ */
+declare function Button({ variant, size, href, children, className, ...rest }: ButtonProps): react_jsx_runtime.JSX.Element;
+
+interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
+    /** Color variant */
+    variant?: "default" | "primary" | "success" | "warning" | "danger" | "info";
+    children: React.ReactNode;
+}
+/**
+ * Inline badge / pill for labels, statuses, or tags.
+ *
+ * ```mdx
+ * <Badge variant="success">Stable</Badge>
+ * <Badge variant="warning">Beta</Badge>
+ * ```
+ */
+declare function Badge({ variant, children, className, ...rest }: BadgeProps): react_jsx_runtime.JSX.Element;
+
+interface CardsProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Number of columns (defaults to 3) */
+    cols?: 1 | 2 | 3 | 4;
+    children: React.ReactNode;
+}
+/**
+ * Grid wrapper for `<Card>` components.
+ *
+ * ```mdx
+ * <Cards cols={3}>
+ *   <Card title="Fast" icon="⚡">Instant HMR.</Card>
+ *   <Card title="Simple" icon="📁">File-system routing.</Card>
+ * </Cards>
+ * ```
+ */
+declare function Cards({ cols, children, className, ...rest }: CardsProps): react_jsx_runtime.JSX.Element;
+interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Card heading */
+    title?: string;
+    /** Emoji or icon string displayed above the title */
+    icon?: React.ReactNode;
+    /** If provided, the entire card becomes a link */
+    href?: string;
+    children?: React.ReactNode;
+}
+/**
+ * Individual feature/info card.
+ */
+declare function Card({ title, icon, href, children, className, ...rest }: CardProps): react_jsx_runtime.JSX.Element;
+
+interface TabProps {
+    /** The label shown in the tab bar */
+    label: string;
+    children: React.ReactNode;
+}
+/**
+ * A single tab panel. Must be used inside `<Tabs>`.
+ *
+ * ```mdx
+ * <Tab label="npm">npm install boltdocs</Tab>
+ * ```
+ */
+declare function Tab({ children }: TabProps): react_jsx_runtime.JSX.Element;
+interface TabsProps {
+    /** Which tab index is initially active (0-based, default 0) */
+    defaultIndex?: number;
+    children: React.ReactNode;
+}
+/**
+ * Tab container that manages active state.
+ *
+ * ```mdx
+ * <Tabs>
+ *   <Tab label="npm">npm install boltdocs</Tab>
+ *   <Tab label="pnpm">pnpm add boltdocs</Tab>
+ *   <Tab label="yarn">yarn add boltdocs</Tab>
+ * </Tabs>
+ * ```
+ */
+declare function Tabs({ defaultIndex, children }: TabsProps): react_jsx_runtime.JSX.Element;
+
+interface AdmonitionProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Admonition type — controls color and icon */
+    type?: "note" | "tip" | "info" | "warning" | "danger";
+    /** Override the default title */
+    title?: string;
+    children: React.ReactNode;
+}
+/**
+ * Callout / admonition box for notes, warnings, etc.
+ *
+ * ```mdx
+ * <Admonition type="warning" title="Breaking Change">
+ *   This API has changed in v2.
+ * </Admonition>
+ * ```
+ */
+declare function Admonition({ type, title, children, className, ...rest }: AdmonitionProps): react_jsx_runtime.JSX.Element;
+declare const Note: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const Tip: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const Warning: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const Danger: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+declare const InfoBox: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
+
+interface ListProps extends React.HTMLAttributes<HTMLUListElement> {
+    /** Visual variant */
+    variant?: "checked" | "arrow" | "default";
+    children: React.ReactNode;
+}
+/**
+ * Enhanced list component with icon variants.
+ *
+ * ```mdx
+ * <List variant="checked">
+ *   <li>File-system routing</li>
+ *   <li>MDX support</li>
+ *   <li>Syntax highlighting</li>
+ * </List>
+ * ```
+ */
+declare function List({ variant, children, className, ...rest }: ListProps): react_jsx_runtime.JSX.Element;
+
+export { Admonition, type AdmonitionProps, BackgroundGradient, Badge, type BadgeProps, BoltdocsConfig, Breadcrumbs, Button, type ButtonProps, Card, type CardProps, Cards, type CardsProps, CodeBlock, ComponentRoute, Danger, Head, InfoBox, List, type ListProps, Loading, Navbar, NotFound, Note, OnThisPage, Playground, Sidebar, Tab, type TabProps, Tabs, type TabsProps, ThemeLayout, Tip, Video, Warning };