boltdocs 1.11.0 → 2.1.0

package/dist/types-Cp21DHI6.d.ts

@@ -0,0 +1,355 @@
+import React__default from 'react';
+import * as vite from 'vite';
+import { Plugin } from 'vite';
+
+/**
+ * Represents a single social link in the configuration.
+ */
+interface BoltdocsSocialLink {
+    /** Identifier for the icon (e.g., 'github') */
+    icon: 'discord' | 'x' | 'github' | 'bluesky' | string;
+    /** The URL the social link points to */
+    link: string;
+}
+/**
+ * Configuration for the site footer.
+ */
+interface BoltdocsFooterConfig {
+    /** Text to display in the footer (HTML is supported) */
+    text?: string;
+}
+/**
+ * Theme-specific configuration options governing the appearance and navigation of the site.
+ */
+interface BoltdocsThemeConfig {
+    /** The global title of the documentation site */
+    title?: string;
+    /** The global description of the site (used for SEO) */
+    description?: string;
+    /** URL path to the site logo or an object for light/dark versions */
+    logo?: string | {
+        dark: string;
+        light: string;
+        alt?: string;
+        width?: number;
+        height?: number;
+    };
+    /** Items to display in the top navigation bar */
+    navbar?: Array<{
+        /** Text to display */
+        label: string;
+        /** URL path or external link */
+        href: string;
+        /** Nested items for NavigationMenu */
+        items?: Array<{
+            label: string;
+            href: string;
+        }>;
+    }>;
+    /** Items to display in the sidebar, organized optionally by group URLs */
+    sidebar?: Record<string, Array<{
+        text: string;
+        link: string;
+    }>>;
+    /** Social links to display in the navigation bar */
+    socialLinks?: BoltdocsSocialLink[];
+    /** Site footer configuration */
+    footer?: BoltdocsFooterConfig;
+    /** Whether to show breadcrumbs navigation (default: true) */
+    breadcrumbs?: boolean;
+    /** URL template for 'Edit this page'. Use :path as a placeholder. */
+    editLink?: string;
+    /** URL for the 'Community help' link. */
+    communityHelp?: string;
+    /** The current version of the project (e.g., 'v2.8.9'). Displayed in the Navbar. */
+    version?: string;
+    /** The GitHub repository in the format 'owner/repo' to fetch and display star count. */
+    githubRepo?: string;
+    /**
+     * URL path to the site favicon.
+     * If not specified, the logo will be used if available.
+     */
+    favicon?: string;
+    /**
+     * The Open Graph image URL to display when the site is shared on social media.
+     */
+    ogImage?: string;
+    /** Whether to show the 'Powered by LiteDocs' badge in the sidebar (default: true) */
+    poweredBy?: boolean;
+    /**
+     * Top-level tabs for organizing documentation groups.
+     * Tab discovery uses the (tab-id) directory syntax.
+     */
+    tabs?: Array<{
+        id: string;
+        text: string;
+        icon?: string;
+    }>;
+    /**
+     * The syntax highlighting theme for code blocks.
+     * Supports any Shiki theme name (e.g., 'github-dark', 'one-dark-pro', 'aurora-x').
+     * Can also be an object for multiple themes (e.g., { light: 'github-light', dark: 'github-dark' }).
+     * Default: { light: 'github-light', dark: 'one-dark-pro' }
+     */
+    codeTheme?: string | {
+        light: string;
+        dark: string;
+    };
+    /**
+     * Configuration for the 'Copy Markdown' button.
+     * Can be a boolean or an object with text and icon.
+     * Default: true
+     */
+    copyMarkdown?: boolean | {
+        text?: string;
+        icon?: string;
+    };
+}
+/**
+ * Configuration for the robots.txt file.
+ */
+type BoltdocsRobotsConfig = string | {
+    /** User-agent rules */
+    rules?: Array<{
+        userAgent: string;
+        /** Paths allowed to be crawled */
+        allow?: string | string[];
+        /** Paths disallowed to be crawled */
+        disallow?: string | string[];
+    }>;
+    /** Sitemaps to include in the robots.txt */
+    sitemaps?: string[];
+};
+/**
+ * Configuration for internationalization (i18n).
+ */
+interface BoltdocsI18nConfig {
+    /** The default locale (e.g., 'en') */
+    defaultLocale: string;
+    /** Available locales and their display names (e.g., { en: 'English', es: 'Español' }) */
+    locales: Record<string, string>;
+}
+/**
+ * Configuration for documentation versioning.
+ */
+interface BoltdocsVersionsConfig {
+    /** The default version (e.g., 'v2') */
+    defaultVersion: string;
+    /** Available versions and their display names (e.g., { v1: 'Version 1.x', v2: 'Version 2.x' }) */
+    versions: Record<string, string>;
+}
+/**
+ * Defines a Boltdocs plugin that can extend the build process and client-side functionality.
+ */
+interface BoltdocsPlugin {
+    /** A unique name for the plugin */
+    name: string;
+    /** Whether to run this plugin before or after default ones (optional) */
+    enforce?: 'pre' | 'post';
+    /** Optional remark plugins to add to the MDX pipeline */
+    remarkPlugins?: unknown[];
+    /** Optional rehype plugins to add to the MDX pipeline */
+    rehypePlugins?: unknown[];
+    /** Optional Vite plugins to inject into the build process */
+    vitePlugins?: Plugin[];
+    /** Optional custom React components to register in MDX. Map of Name -> Module Path. */
+    components?: Record<string, string>;
+}
+/**
+ * Configuration for external integrations (e.g., CodeSandbox).
+ */
+interface BoltdocsIntegrationsConfig {
+    /** CodeSandbox integration settings */
+    sandbox?: {
+        /** Whether to enable the "Open in Sandbox" button in CodeBlocks */
+        enable?: boolean;
+        /** Default options for the sandbox (files, dependencies, etc.) */
+        config?: Record<string, unknown>;
+    };
+}
+/**
+ * The root configuration object for Boltdocs.
+ */
+interface BoltdocsConfig {
+    /** The base URL of the site, used for generating the sitemap */
+    siteUrl?: string;
+    /** The root directory containing markdown documentation files (default: 'docs') */
+    docsDir?: string;
+    /** Path to a custom HomePage component */
+    homePage?: string;
+    /** Configuration pertaining to the UI and appearance */
+    theme?: BoltdocsThemeConfig;
+    /** Configuration for internationalization */
+    i18n?: BoltdocsI18nConfig;
+    /** Configuration for documentation versioning */
+    versions?: BoltdocsVersionsConfig;
+    /** Custom plugins for extending functionality */
+    plugins?: BoltdocsPlugin[];
+    /** Map of custom external route paths to component file paths */
+    external?: Record<string, string>;
+    /** External integrations configuration */
+    integrations?: BoltdocsIntegrationsConfig;
+    /** Configuration for the robots.txt file */
+    robots?: BoltdocsRobotsConfig;
+    /** Low-level Vite configuration overrides */
+    vite?: vite.InlineConfig;
+    /** @deprecated Use theme instead */
+    themeConfig?: BoltdocsThemeConfig;
+}
+
+/**
+ * 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 { BoltdocsConfig as B, ComponentRoute as C, LayoutProps as L, NavbarLink as N, OnThisPageProps as O, SandboxOptions as S, BoltdocsSocialLink as a, BoltdocsTab as b, CreateBoltdocsAppOptions as c, BoltdocsThemeConfig as d, SandboxEmbedOptions as e, SandboxFile as f, SandboxFiles as g };

package/dist/use-routes-8Iei6jTp.d.mts

@@ -0,0 +1,29 @@
+import { C as ComponentRoute, B as BoltdocsConfig } from './types-Cp21DHI6.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-xLhumjbV.d.ts

@@ -0,0 +1,29 @@
+import { C as ComponentRoute, B as BoltdocsConfig } from './types-Cp21DHI6.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,10 +1,13 @@
 {
   "name": "boltdocs",
-  "version": "1.11.0",
+  "version": "2.1.0",
   "description": "A lightweight documentation generator for React projects.",
   "main": "dist/node/index.js",
   "module": "dist/node/index.mjs",
   "types": "dist/node/index.d.ts",
+  "bin": {
+    "boltdocs": "bin/boltdocs.js"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -36,13 +39,6 @@
     },
     "./theme/neutral.css": "./src/client/theme/neutral.css"
   },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "format": "pnpm exec biome format --write",
-    "lint": "pnpm exec biome lint --write",
-    "check": "pnpm exec biome check --write"
-  },
   "keywords": [
     "docs",
     "documentation",
@@ -60,12 +56,16 @@
   "dependencies": {
     "@mdx-js/react": "^3.1.1",
     "@mdx-js/rollup": "^3.1.1",
+    "@tailwindcss/vite": "^4.2.2",
+    "@vitejs/plugin-react": "^4.2.1",
+    "cac": "^7.0.0",
     "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-aria-components": "^1.16.0",
     "react-router-dom": "^6.30.3",
@@ -85,7 +85,6 @@
     "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",
@@ -93,5 +92,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/index.tsx

@@ -31,7 +31,7 @@ export function AppShell({
   initialRoutes: ComponentRoute[]
   initialConfig: BoltdocsConfig
   docsDirName: string
-  modules: Record<string, () => Promise<{ default: React.ComponentType }>>
+  modules: Record<string, () => Promise<{ default: React.ComponentType<any> }>>
   hot?: CreateBoltdocsAppOptions['hot']
   homePage?: React.ComponentType
   externalPages?: Record<string, React.ComponentType>
@@ -50,15 +50,19 @@ export function AppShell({
       )
       .map((route) => {
         const loaderKey = Object.keys(modules).find(
-          (k) => k === `/${docsDirName}/${route.filePath}`,
+          (k) =>
+            k === `/${docsDirName}/${route.filePath}` || // Vite dev/build relative path
+            k.endsWith(`/${docsDirName}/${route.filePath}`) || // SSG absolute path fallback
+            k.endsWith(`/${docsDirName}\\${route.filePath.replace(/\\/g, '/')}`), // Windows fallback
         )
         const loader = loaderKey ? modules[loaderKey] : null
 
         return {
           ...route,
-          Component: React.lazy(() => {
-            if (!loader) return Promise.resolve({ default: NotFound })
-            return loader() as any
+          Component: React.lazy<React.ComponentType<any>>(async () => {
+            if (!loader) return { default: NotFound as React.ComponentType<any> }
+            const mod = await loader()
+            return mod
           }),
         }
       })
@@ -113,7 +117,6 @@ export function AppShell({
                   ),
                 )}
 
-                {/* Documentation pages WITH sidebar + TOC layout */}
                 <Route key="docs-layout" element={<DocsLayout />}>
                   {resolvedRoutes.map((route) => (
                     <Route

package/src/client/components/ui-base/breadcrumbs.tsx

@@ -12,10 +12,11 @@ import { useConfig } from '@client/app/config-context'
 export function Breadcrumbs() {
   const { crumbs, activeRoute } = useBreadcrumbs()
   const config = useConfig()
+  const themeConfig = config.theme || config.themeConfig || {}
 
   if (crumbs.length === 0) return null
 
-  if (!config.themeConfig?.breadcrumbs) return null
+  if (!themeConfig?.breadcrumbs) return null
 
   return (
     <BreadcrumbsRoot>

package/src/client/components/ui-base/navbar.tsx

@@ -24,7 +24,7 @@ export function Navbar() {
   const { links, title, logo, logoProps, github, social, config } = useNavbar()
   const { routes, allRoutes, currentVersion, currentLocale } = useRoutes()
   const { pathname } = useLocation()
-  const { themeConfig } = useConfig()
+  const themeConfig = config.theme || config.themeConfig || {}
 
   const hasTabs = themeConfig?.tabs && themeConfig.tabs.length > 0
 
@@ -76,10 +76,10 @@ export function Navbar() {
         </NavbarPrimitive.NavbarRight>
       </NavbarPrimitive.Content>
 
-      {pathname !== '/' && hasTabs && config.themeConfig?.tabs && (
+      {pathname !== '/' && hasTabs && themeConfig?.tabs && (
         <div className="w-full border-b border-border-subtle bg-bg-main">
           <Tabs
-            tabs={config.themeConfig.tabs}
+            tabs={themeConfig.tabs}
             routes={allRoutes || routes || []}
           />
         </div>

package/src/client/components/ui-base/sidebar.tsx

@@ -67,6 +67,7 @@ export function Sidebar({
   config: BoltdocsConfig
 }) {
   const { groups, ungrouped, activePath } = useSidebar(routes)
+  const themeConfig = config.theme || config.themeConfig || {}
 
   return (
     <SidebarPrimitive.SidebarRoot>
@@ -94,7 +95,7 @@ export function Sidebar({
         />
       ))}
 
-      {config.themeConfig?.poweredBy && (
+      {themeConfig?.poweredBy && (
         <div className="mt-auto pt-8">
           <PoweredBy />
         </div>

package/src/client/hooks/use-navbar.ts

@@ -8,7 +8,7 @@ export function useNavbar() {
   const { theme } = useTheme()
   const location = useLocation()
 
-  const themeConfig = config.themeConfig || {}
+  const themeConfig = config.theme || config.themeConfig || {}
   const title = themeConfig.title || 'Boltdocs'
   const rawLinks = themeConfig.navbar || []
   const socialLinks = themeConfig.socialLinks || []

package/src/client/types.ts

@@ -62,7 +62,7 @@ export interface CreateBoltdocsAppOptions {
   /** Site configuration (`virtual:boltdocs-config`) */
   config: SiteConfig
   /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
-  modules: Record<string, () => Promise<{ default: React.ComponentType }>>
+  modules: Record<string, () => Promise<{ default: React.ComponentType<any> }>>
   /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
   hot?: {
     accept: (cb?: (mod: any) => void) => void

package/src/node/cli-entry.ts

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+import cac from "cac";
+import { devAction, buildAction, previewAction } from "./cli";
+
+const cli = cac("boltdocs");
+
+cli
+  .command("[root]", "Start development server")
+  .alias("dev")
+  .action(devAction);
+
+cli
+  .command("build [root]", "Build for production")
+  .action(buildAction);
+
+cli
+  .command("preview [root]", "Preview production build")
+  .action(previewAction);
+
+cli.help();
+// This will be replaced at build time or package publishing, but hardcoded to 2.0.0 for now
+cli.version("2.0.0");
+
+cli.parse();

package/src/node/cli.ts

@@ -0,0 +1,59 @@
+import { createServer, build, preview } from 'vite'
+import { createViteConfig, resolveConfig } from './index'
+import { getHtmlTemplate } from './plugin/html'
+import path from 'path'
+import fs from 'fs'
+
+/**
+ * Core logic for the Boltdocs CLI commands.
+ * These functions wrap Vite's JS API to provide a seamless experience.
+ */
+
+export async function devAction(root: string = process.cwd()) {
+  try {
+    const viteConfig = await createViteConfig(root, 'development')
+    const server = await createServer(viteConfig)
+    await server.listen()
+    server.printUrls()
+    server.bindCLIShortcuts({ print: true })
+  } catch (e) {
+    console.error('[boltdocs] Failed to start dev server:', e)
+    process.exit(1)
+  }
+}
+
+export async function buildAction(root: string = process.cwd()) {
+  let createdIndexHtml = false
+  const indexPath = path.resolve(root, 'index.html')
+
+  try {
+    if (!fs.existsSync(indexPath)) {
+      const config = await resolveConfig('docs', root)
+      fs.writeFileSync(indexPath, getHtmlTemplate(config), 'utf-8')
+      createdIndexHtml = true
+    }
+
+    const viteConfig = await createViteConfig(root, 'production')
+    await build(viteConfig)
+    console.log('[boltdocs] Build completed successfully.')
+  } catch (e) {
+    console.error('[boltdocs] Build failed:', e)
+    process.exit(1)
+  } finally {
+    if (createdIndexHtml && fs.existsSync(indexPath)) {
+      fs.unlinkSync(indexPath)
+    }
+  }
+}
+
+export async function previewAction(root: string = process.cwd()) {
+  try {
+    const viteConfig = await createViteConfig(root, 'production')
+    const previewServer = await preview(viteConfig)
+    previewServer.printUrls()
+  } catch (e) {
+    console.error('[boltdocs] Failed to start preview server:', e)
+    process.exit(1)
+  }
+}
+