boltdocs 1.10.2 → 2.0.0

package/dist/search-dialog-EB3N4TYM.mjs

@@ -0,0 +1 @@
+import{a as f}from"./chunk-H63UMKYF.mjs";import{h as g,i as h,j as u,k as m,l as S,m as d,n as p,o as y,p as D}from"./chunk-BQCD3DWG.mjs";import"./chunk-XEAPSFMB.mjs";import"./chunk-JZXLCA2E.mjs";import{useEffect as K,useCallback as M}from"react";import{useNavigate as R}from"react-router-dom";import{Fragment as T,jsx as o,jsxs as n}from"react/jsx-runtime";function N({routes:v}){let{isOpen:I,setIsOpen:a,query:w,setQuery:k,list:E}=f(v),r=R();K(()=>{let e=t=>{(/Mac/.test(navigator.userAgent)?t.metaKey:t.ctrlKey)&&(t.key==="k"||t.key==="j")&&(t.preventDefault(),a(i=>!i))};return window.addEventListener("keydown",e),()=>window.removeEventListener("keydown",e)},[a]);let l=M(e=>{let t=String(e);if(a(!1),t.includes("#")){let[s,c]=t.split("#");r(s),setTimeout(()=>{let i=document.getElementById(c);i&&i.scrollIntoView({behavior:"smooth"})},100)}else r(t)},[r,a]);return n(T,{children:[o(g.SearchTrigger,{onPress:()=>a(!0)}),o(h,{isOpen:I,onOpenChange:a,children:n(u,{onSelectionChange:l,children:[o(m,{value:w,onChange:e=>k(e.target.value)}),o(S,{items:E,children:e=>n(d,{onPress:()=>l(e.id),textValue:e.title,children:[o(p,{isHeading:e.isHeading}),n("div",{className:"flex flex-col justify-center gap-0.5",children:[o(y,{children:e.title}),o(D,{children:e.groupTitle})]})]},e.id)})]})})]})}export{N as SearchDialog};

package/dist/types-BuZWFT7r.d.ts

@@ -0,0 +1,159 @@
+import React__default from 'react';
+import { B as BoltdocsConfig } from './config-CX4l-ZNp.js';
+
+/**
+ * Metadata provided by the server for a specific route.
+ * Maps closely to the `RouteMeta` type in the Node environment.
+ */
+interface ComponentRoute {
+    /** The final URL path */
+    path: string;
+    /** The absolute filesystem path of the source file */
+    componentPath: string;
+    /** The page title */
+    title: string;
+    /** Explicit order in the sidebar */
+    sidebarPosition?: number;
+    /** The relative path from the docs directory */
+    filePath: string;
+    /** The group directory name */
+    group?: string;
+    /** The display title of the group */
+    groupTitle?: string;
+    /** Explicit order of the group in the sidebar */
+    groupPosition?: number;
+    /** Extracted markdown headings for search indexing */
+    headings?: {
+        level: number;
+        text: string;
+        id: string;
+    }[];
+    /** The page summary or description */
+    description?: string;
+    /** The locale this route belongs to, if i18n is configured */
+    locale?: string;
+    /** The version this route belongs to, if versioning is configured */
+    version?: string;
+    /** Optional icon to display (Lucide icon name or raw SVG) */
+    icon?: string;
+    /** The tab this route belongs to, if tabs are configured */
+    tab?: string;
+    /** Optional badge to display next to the sidebar item */
+    badge?: string | {
+        text: 'updated' | 'new' | 'deprecated';
+        expires?: string;
+    };
+    /** Optional icon for the route's group */
+    groupIcon?: string;
+    /** The extracted plain-text content of the page for search indexing */
+    _content?: string;
+    /** The raw markdown content of the page */
+    _rawContent?: string;
+}
+/**
+ * Site configuration provided by the server.
+ */
+type SiteConfig = BoltdocsConfig;
+/**
+ * Configuration options for initializing the Boltdocs client app.
+ */
+interface CreateBoltdocsAppOptions {
+    /** CSS selector for the DOM element where the app should mount (e.g. '#root') */
+    target: string;
+    /** Initial routes generated by the Vite plugin (`virtual:boltdocs-routes`) */
+    routes: ComponentRoute[];
+    /** The name of the documentation directory (e.g. 'docs') */
+    docsDirName: string;
+    /** Site configuration (`virtual:boltdocs-config`) */
+    config: SiteConfig;
+    /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
+    modules: Record<string, () => Promise<{
+        default: React__default.ComponentType<any>;
+    }>>;
+    /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
+    hot?: {
+        accept: (cb?: (mod: any) => void) => void;
+        dispose: (cb: (data: any) => void) => void;
+        on: (event: string, cb: (data: any) => void) => void;
+        data: any;
+    };
+    /** Optional custom React component to render when visiting the root path ('/') */
+    homePage?: React__default.ComponentType;
+    /** Custom external pages mapped by their route path */
+    externalPages?: Record<string, React__default.ComponentType>;
+    /** Optional custom MDX components provided by plugins */
+    components?: Record<string, React__default.ComponentType>;
+}
+/**
+ * Types for CodeSandbox integration.
+ */
+interface SandboxFile {
+    content: string | object;
+    isBinary?: boolean;
+}
+type SandboxFiles = Record<string, SandboxFile>;
+interface SandboxOptions {
+    files?: SandboxFiles;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    title?: string;
+    description?: string;
+    template?: string;
+    /** The file path to open by default in the editor (e.g. `"src/App.tsx"`). */
+    entry?: string;
+    /** Options for the embedded iframe view, used by `embedSandbox()`. */
+    embed?: SandboxEmbedOptions;
+    /** Custom scripts for the package.json (e.g. `{ "start": "vite" }`). */
+    scripts?: Record<string, string>;
+    /** Optional default theme configuration for the sandbox project. */
+    themeConfig?: Record<string, unknown>;
+}
+interface SandboxEmbedOptions {
+    /** Which panel to display: `"editor"`, `"preview"`, or `"split"`. */
+    view?: 'editor' | 'preview' | 'split';
+    /** Color theme: `"dark"` or `"light"`. */
+    theme?: 'dark' | 'light';
+    /** Whether to hide the navigation bar in the embed. */
+    hideNavigation?: boolean;
+}
+/**
+ * Tab configuration for the documentation site.
+ */
+interface BoltdocsTab {
+    id: string;
+    text: string;
+    icon?: string;
+}
+/**
+ * Props for the OnThisPage (TOC) component.
+ */
+interface OnThisPageProps {
+    headings?: {
+        level: number;
+        text: string;
+        id: string;
+    }[];
+    editLink?: string;
+    communityHelp?: string;
+    filePath?: string;
+}
+/**
+ * Props for user-defined layout components (layout.tsx).
+ */
+interface LayoutProps {
+    children: React__default.ReactNode;
+}
+/**
+ * Unified type for navbar links.
+ */
+interface NavbarLink {
+    label: string;
+    href: string;
+    active: boolean;
+    /** Optional icon or string for external link indication */
+    to?: string;
+    /** Nested items for NavigationMenu */
+    items?: NavbarLink[];
+}
+
+export type { BoltdocsTab as B, ComponentRoute as C, LayoutProps as L, NavbarLink as N, OnThisPageProps as O, SandboxOptions as S, CreateBoltdocsAppOptions as a, SandboxEmbedOptions as b, SandboxFile as c, SandboxFiles as d };

package/dist/types-CvT-SGbK.d.mts

@@ -0,0 +1,159 @@
+import React__default from 'react';
+import { B as BoltdocsConfig } from './config-CX4l-ZNp.mjs';
+
+/**
+ * Metadata provided by the server for a specific route.
+ * Maps closely to the `RouteMeta` type in the Node environment.
+ */
+interface ComponentRoute {
+    /** The final URL path */
+    path: string;
+    /** The absolute filesystem path of the source file */
+    componentPath: string;
+    /** The page title */
+    title: string;
+    /** Explicit order in the sidebar */
+    sidebarPosition?: number;
+    /** The relative path from the docs directory */
+    filePath: string;
+    /** The group directory name */
+    group?: string;
+    /** The display title of the group */
+    groupTitle?: string;
+    /** Explicit order of the group in the sidebar */
+    groupPosition?: number;
+    /** Extracted markdown headings for search indexing */
+    headings?: {
+        level: number;
+        text: string;
+        id: string;
+    }[];
+    /** The page summary or description */
+    description?: string;
+    /** The locale this route belongs to, if i18n is configured */
+    locale?: string;
+    /** The version this route belongs to, if versioning is configured */
+    version?: string;
+    /** Optional icon to display (Lucide icon name or raw SVG) */
+    icon?: string;
+    /** The tab this route belongs to, if tabs are configured */
+    tab?: string;
+    /** Optional badge to display next to the sidebar item */
+    badge?: string | {
+        text: 'updated' | 'new' | 'deprecated';
+        expires?: string;
+    };
+    /** Optional icon for the route's group */
+    groupIcon?: string;
+    /** The extracted plain-text content of the page for search indexing */
+    _content?: string;
+    /** The raw markdown content of the page */
+    _rawContent?: string;
+}
+/**
+ * Site configuration provided by the server.
+ */
+type SiteConfig = BoltdocsConfig;
+/**
+ * Configuration options for initializing the Boltdocs client app.
+ */
+interface CreateBoltdocsAppOptions {
+    /** CSS selector for the DOM element where the app should mount (e.g. '#root') */
+    target: string;
+    /** Initial routes generated by the Vite plugin (`virtual:boltdocs-routes`) */
+    routes: ComponentRoute[];
+    /** The name of the documentation directory (e.g. 'docs') */
+    docsDirName: string;
+    /** Site configuration (`virtual:boltdocs-config`) */
+    config: SiteConfig;
+    /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
+    modules: Record<string, () => Promise<{
+        default: React__default.ComponentType<any>;
+    }>>;
+    /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
+    hot?: {
+        accept: (cb?: (mod: any) => void) => void;
+        dispose: (cb: (data: any) => void) => void;
+        on: (event: string, cb: (data: any) => void) => void;
+        data: any;
+    };
+    /** Optional custom React component to render when visiting the root path ('/') */
+    homePage?: React__default.ComponentType;
+    /** Custom external pages mapped by their route path */
+    externalPages?: Record<string, React__default.ComponentType>;
+    /** Optional custom MDX components provided by plugins */
+    components?: Record<string, React__default.ComponentType>;
+}
+/**
+ * Types for CodeSandbox integration.
+ */
+interface SandboxFile {
+    content: string | object;
+    isBinary?: boolean;
+}
+type SandboxFiles = Record<string, SandboxFile>;
+interface SandboxOptions {
+    files?: SandboxFiles;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    title?: string;
+    description?: string;
+    template?: string;
+    /** The file path to open by default in the editor (e.g. `"src/App.tsx"`). */
+    entry?: string;
+    /** Options for the embedded iframe view, used by `embedSandbox()`. */
+    embed?: SandboxEmbedOptions;
+    /** Custom scripts for the package.json (e.g. `{ "start": "vite" }`). */
+    scripts?: Record<string, string>;
+    /** Optional default theme configuration for the sandbox project. */
+    themeConfig?: Record<string, unknown>;
+}
+interface SandboxEmbedOptions {
+    /** Which panel to display: `"editor"`, `"preview"`, or `"split"`. */
+    view?: 'editor' | 'preview' | 'split';
+    /** Color theme: `"dark"` or `"light"`. */
+    theme?: 'dark' | 'light';
+    /** Whether to hide the navigation bar in the embed. */
+    hideNavigation?: boolean;
+}
+/**
+ * Tab configuration for the documentation site.
+ */
+interface BoltdocsTab {
+    id: string;
+    text: string;
+    icon?: string;
+}
+/**
+ * Props for the OnThisPage (TOC) component.
+ */
+interface OnThisPageProps {
+    headings?: {
+        level: number;
+        text: string;
+        id: string;
+    }[];
+    editLink?: string;
+    communityHelp?: string;
+    filePath?: string;
+}
+/**
+ * Props for user-defined layout components (layout.tsx).
+ */
+interface LayoutProps {
+    children: React__default.ReactNode;
+}
+/**
+ * Unified type for navbar links.
+ */
+interface NavbarLink {
+    label: string;
+    href: string;
+    active: boolean;
+    /** Optional icon or string for external link indication */
+    to?: string;
+    /** Nested items for NavigationMenu */
+    items?: NavbarLink[];
+}
+
+export type { BoltdocsTab as B, ComponentRoute as C, LayoutProps as L, NavbarLink as N, OnThisPageProps as O, SandboxOptions as S, CreateBoltdocsAppOptions as a, SandboxEmbedOptions as b, SandboxFile as c, SandboxFiles as d };

package/dist/use-routes-5bAtAAYX.d.mts

@@ -0,0 +1,30 @@
+import { B as BoltdocsConfig } from './config-CX4l-ZNp.mjs';
+import { C as ComponentRoute } from './types-CvT-SGbK.mjs';
+
+/**
+ * Hook to access the framework's routing state.
+ * Returns both the complete set of routes and a filtered list based on the current
+ * version and locale.
+ */
+declare function useRoutes(): {
+    routes: ComponentRoute[];
+    allRoutes: ComponentRoute[];
+    currentRoute: ComponentRoute | undefined;
+    currentLocale: string | undefined;
+    currentLocaleLabel: string | undefined;
+    availableLocales: {
+        key: string;
+        label: string;
+        isCurrent: boolean;
+    }[];
+    currentVersion: string | undefined;
+    currentVersionLabel: string | undefined;
+    availableVersions: {
+        key: string;
+        label: string;
+        isCurrent: boolean;
+    }[];
+    config: BoltdocsConfig;
+};
+
+export { useRoutes as u };

package/dist/use-routes-BefRXY3v.d.ts

@@ -0,0 +1,30 @@
+import { B as BoltdocsConfig } from './config-CX4l-ZNp.js';
+import { C as ComponentRoute } from './types-BuZWFT7r.js';
+
+/**
+ * Hook to access the framework's routing state.
+ * Returns both the complete set of routes and a filtered list based on the current
+ * version and locale.
+ */
+declare function useRoutes(): {
+    routes: ComponentRoute[];
+    allRoutes: ComponentRoute[];
+    currentRoute: ComponentRoute | undefined;
+    currentLocale: string | undefined;
+    currentLocaleLabel: string | undefined;
+    availableLocales: {
+        key: string;
+        label: string;
+        isCurrent: boolean;
+    }[];
+    currentVersion: string | undefined;
+    currentVersionLabel: string | undefined;
+    availableVersions: {
+        key: string;
+        label: string;
+        isCurrent: boolean;
+    }[];
+    config: BoltdocsConfig;
+};
+
+export { useRoutes as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boltdocs",
-  "version": "1.10.2",
+  "version": "2.0.0",
   "description": "A lightweight documentation generator for React projects.",
   "main": "dist/node/index.js",
   "module": "dist/node/index.mjs",
@@ -19,11 +19,22 @@
       "import": "./dist/client/index.mjs",
       "require": "./dist/client/index.js"
     },
-    "./style.css": "./dist/client/index.css"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch"
+    "./client/hooks": {
+      "types": "./dist/client/hooks/index.d.ts",
+      "import": "./dist/client/hooks/index.mjs",
+      "require": "./dist/client/hooks/index.js"
+    },
+    "./client/primitives": {
+      "types": "./dist/client/components/primitives/index.d.ts",
+      "import": "./dist/client/components/primitives/index.mjs",
+      "require": "./dist/client/components/primitives/index.js"
+    },
+    "./client/types": {
+      "types": "./dist/client/types.d.ts",
+      "import": "./dist/client/types.mjs",
+      "require": "./dist/client/types.js"
+    },
+    "./theme/neutral.css": "./src/client/theme/neutral.css"
   },
   "keywords": [
     "docs",
@@ -42,28 +53,32 @@
   "dependencies": {
     "@mdx-js/react": "^3.1.1",
     "@mdx-js/rollup": "^3.1.1",
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "codesandbox": "^2.2.3",
     "fast-glob": "^3.3.3",
     "github-slugger": "^2.0.0",
     "gray-matter": "^4.0.3",
+    "isomorphic-dompurify": "^3.7.1",
     "lucide-react": "^0.575.0",
-    "react-live": "^4.1.8",
+    "react-aria-components": "^1.16.0",
     "react-router-dom": "^6.30.3",
-    "rehype-pretty-code": "^0.14.1",
     "rehype-slug": "^6.0.0",
     "remark-frontmatter": "^5.0.0",
     "remark-gfm": "^4.0.1",
+    "scroll-into-view-if-needed": "^3.1.0",
     "sharp": "^0.34.5",
     "shiki": "^3.23.0",
     "svgo": "^4.0.1",
+    "tailwind-merge": "^3.5.0",
     "unist-util-visit": "^5.1.0",
     "vite": "^7.3.1",
     "vite-plugin-image-optimizer": "^2.0.3"
   },
   "peerDependencies": {
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0"
   },
-  "packageManager": "pnpm@10.30.2",
   "devDependencies": {
     "@types/node": "^25.3.2",
     "@types/react": "^19.2.14",
@@ -71,5 +86,12 @@
     "@types/react-router-dom": "^5.3.3",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "format": "pnpm exec biome format --write",
+    "lint": "pnpm exec biome lint --write",
+    "check": "pnpm exec biome check --write"
   }
-}
+}

package/src/client/app/config-context.tsx

@@ -0,0 +1,18 @@
+import { createContext, use } from 'react'
+import type { BoltdocsConfig } from '@node/config'
+
+/**
+ * Context for the global documentation configuration.
+ */
+export const ConfigContext = createContext<BoltdocsConfig | null>(null)
+
+/**
+ * Hook to access the Boltdocs configuration.
+ */
+export function useConfig() {
+  const context = use(ConfigContext)
+  if (!context) {
+    throw new Error('useConfig must be used within a ConfigProvider')
+  }
+  return context
+}

package/src/client/app/docs-layout.tsx

@@ -0,0 +1,14 @@
+import { Outlet } from 'react-router-dom'
+import UserLayout from 'virtual:boltdocs-layout'
+
+/**
+ * Wraps the docs Outlet with the user's (or default) layout component.
+ * The Layout receives the routed page as `children`.
+ */
+export function DocsLayout() {
+  return (
+    <UserLayout>
+      <Outlet />
+    </UserLayout>
+  )
+}