boltdocs 1.6.0 → 1.7.0

package/dist/client/ssr.mjs

@@ -1,6 +1,6 @@
 import {
   AppShell
-} from "../chunk-HSPDIRTW.mjs";
+} from "../chunk-MULKZFVN.mjs";
 import "../chunk-FMTOYQLO.mjs";
 
 // src/client/ssr.tsx
@@ -9,7 +9,7 @@ import ReactDOMServer from "react-dom/server";
 import { StaticRouter } from "react-router-dom/server";
 import { jsx } from "react/jsx-runtime";
 async function render(options) {
-  const { path, routes, config, modules, homePage } = options;
+  const { path, routes, config, modules, homePage, docsDirName } = options;
   const resolvedModules = {};
   for (const [key, mod] of Object.entries(modules)) {
     resolvedModules[key] = () => Promise.resolve(mod);
@@ -20,6 +20,7 @@ async function render(options) {
       {
         initialRoutes: routes,
         initialConfig: config,
+        docsDirName,
         modules: resolvedModules,
         homePage
       }

package/dist/{config-DkZg5aCf.d.ts → config-D68h41CA.d.mts}

@@ -28,8 +28,18 @@ interface BoltdocsThemeConfig {
     logo?: string;
     /** Items to display in the top navigation bar */
     navbar?: Array<{
-        text: string;
-        link: string;
+        /** Text to display (alias for text) */
+        label?: string;
+        /** Text to display */
+        text?: string;
+        /** URL path or external link (alias for link) */
+        to?: string;
+        /** URL path or external link (alias for link) */
+        href?: string;
+        /** URL path or external link */
+        link?: string;
+        /** Alignment of the item in the navbar */
+        position?: "left" | "right";
     }>;
     /** Items to display in the sidebar, organized optionally by group URLs */
     sidebar?: Record<string, Array<{
@@ -67,6 +77,15 @@ interface BoltdocsThemeConfig {
         className?: string;
         style?: any;
     };
+    /**
+     * 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').

package/dist/{config-DkZg5aCf.d.mts → config-D68h41CA.d.ts}

@@ -28,8 +28,18 @@ interface BoltdocsThemeConfig {
     logo?: string;
     /** Items to display in the top navigation bar */
     navbar?: Array<{
-        text: string;
-        link: string;
+        /** Text to display (alias for text) */
+        label?: string;
+        /** Text to display */
+        text?: string;
+        /** URL path or external link (alias for link) */
+        to?: string;
+        /** URL path or external link (alias for link) */
+        href?: string;
+        /** URL path or external link */
+        link?: string;
+        /** Alignment of the item in the navbar */
+        position?: "left" | "right";
     }>;
     /** Items to display in the sidebar, organized optionally by group URLs */
     sidebar?: Record<string, Array<{
@@ -67,6 +77,15 @@ interface BoltdocsThemeConfig {
         className?: string;
         style?: any;
     };
+    /**
+     * 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').

package/dist/node/index.d.mts

@@ -1,6 +1,6 @@
 import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-DkZg5aCf.mjs';
-export { a as BoltdocsThemeConfig } from '../config-DkZg5aCf.mjs';
+import { B as BoltdocsConfig } from '../config-D68h41CA.mjs';
+export { a as BoltdocsThemeConfig } from '../config-D68h41CA.mjs';
 
 /**
  * Configuration options specifically for the Boltdocs Vite plugin.
@@ -20,6 +20,8 @@ interface BoltdocsPluginOptions {
 interface SSGOptions {
     /** The root directory containing markdown documentation files */
     docsDir: string;
+    /** The name of the documentation directory (e.g. 'docs') */
+    docsDirName: string;
     /** The output directory where Vite placed the compiled `index.html` and assets */
     outDir: string;
     /** Pre-resolved config (avoids re-resolving during the SSG phase) */
@@ -57,6 +59,8 @@ interface RouteMeta {
     groupTitle?: string;
     /** Optional explicit position for ordering the group itself */
     groupPosition?: number;
+    /** Optional icon for the route's group */
+    groupIcon?: string;
     /** Extracted markdown headings for search indexing */
     headings?: {
         level: number;
@@ -72,6 +76,10 @@ interface RouteMeta {
         text: string;
         expires?: 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;
 }
 
 declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;

package/dist/node/index.d.ts

@@ -1,6 +1,6 @@
 import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-DkZg5aCf.js';
-export { a as BoltdocsThemeConfig } from '../config-DkZg5aCf.js';
+import { B as BoltdocsConfig } from '../config-D68h41CA.js';
+export { a as BoltdocsThemeConfig } from '../config-D68h41CA.js';
 
 /**
  * Configuration options specifically for the Boltdocs Vite plugin.
@@ -20,6 +20,8 @@ interface BoltdocsPluginOptions {
 interface SSGOptions {
     /** The root directory containing markdown documentation files */
     docsDir: string;
+    /** The name of the documentation directory (e.g. 'docs') */
+    docsDirName: string;
     /** The output directory where Vite placed the compiled `index.html` and assets */
     outDir: string;
     /** Pre-resolved config (avoids re-resolving during the SSG phase) */
@@ -57,6 +59,8 @@ interface RouteMeta {
     groupTitle?: string;
     /** Optional explicit position for ordering the group itself */
     groupPosition?: number;
+    /** Optional icon for the route's group */
+    groupIcon?: string;
     /** Extracted markdown headings for search indexing */
     headings?: {
         level: number;
@@ -72,6 +76,10 @@ interface RouteMeta {
         text: string;
         expires?: 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;
 }
 
 declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;

package/dist/node/index.js

@@ -478,6 +478,14 @@ function parseDocFile(file, docsDir, basePath, config) {
       parts = parts.slice(1);
     }
   }
+  let inferredTab;
+  if (parts.length > 0) {
+    const tabMatch = parts[0].match(/^\((.+)\)$/);
+    if (tabMatch) {
+      inferredTab = tabMatch[1].toLowerCase();
+      parts = parts.slice(1);
+    }
+  }
   const cleanRelativePath = parts.join("/");
   let cleanRoutePath;
   if (data.permalink) {
@@ -511,15 +519,16 @@ function parseDocFile(file, docsDir, basePath, config) {
     const level = match[1].length;
     const text = match[2].replace(/\[([^\]]+)\]\([^\)]+\)/g, "$1").replace(/[_*`]/g, "").trim();
     const id = slugger.slug(text);
-    headings.push({ level, text: escapeHtml(text), id });
+    headings.push({ level, text, id });
   }
-  const sanitizedTitle = data.title ? escapeHtml(data.title) : inferredTitle;
-  let sanitizedDescription = data.description ? escapeHtml(data.description) : "";
+  const sanitizedTitle = data.title ? data.title : inferredTitle;
+  let sanitizedDescription = data.description ? data.description : "";
   if (!sanitizedDescription && content) {
     const summary = content.replace(/^#+.*$/gm, "").replace(/\[([^\]]+)\]\([^\)]+\)/g, "$1").replace(/[_*`]/g, "").replace(/\n+/g, " ").trim().slice(0, 160);
-    sanitizedDescription = escapeHtml(summary);
+    sanitizedDescription = summary;
   }
-  const sanitizedBadge = data.badge ? escapeHtml(data.badge) : void 0;
+  const sanitizedBadge = data.badge ? data.badge : void 0;
+  const icon = data.icon ? String(data.icon) : void 0;
   return {
     route: {
       path: finalPath,
@@ -531,15 +540,17 @@ function parseDocFile(file, docsDir, basePath, config) {
       headings,
       locale,
       version,
-      badge: sanitizedBadge
+      badge: sanitizedBadge,
+      icon,
+      tab: inferredTab
     },
     relativeDir: cleanDirName,
     isGroupIndex,
+    inferredTab,
     groupMeta: isGroupIndex ? {
-      title: escapeHtml(
-        data.groupTitle || data.title || (cleanDirName ? capitalize(cleanDirName) : "")
-      ),
-      position: data.groupPosition ?? data.sidebarPosition ?? (rawDirName ? extractNumberPrefix(rawDirName) : void 0)
+      title: data.groupTitle || data.title || (cleanDirName ? capitalize(cleanDirName) : ""),
+      position: data.groupPosition ?? data.sidebarPosition ?? (rawDirName ? extractNumberPrefix(rawDirName) : void 0),
+      icon
     } : void 0,
     inferredGroupPosition: rawDirName ? extractNumberPrefix(rawDirName) : void 0
   };
@@ -608,13 +619,17 @@ async function generateRoutes(docsDir, config, basePath = "/docs") {
       if (!groupMeta.has(p.relativeDir)) {
         groupMeta.set(p.relativeDir, {
           title: capitalize(p.relativeDir),
-          position: p.inferredGroupPosition
+          position: p.inferredGroupPosition,
+          icon: p.route.icon
         });
       } else {
         const entry = groupMeta.get(p.relativeDir);
         if (entry.position === void 0 && p.inferredGroupPosition !== void 0) {
           entry.position = p.inferredGroupPosition;
         }
+        if (!entry.icon && p.route.icon) {
+          entry.icon = p.route.icon;
+        }
       }
     }
     if (p.isGroupIndex && p.relativeDir && p.groupMeta) {
@@ -623,6 +638,9 @@ async function generateRoutes(docsDir, config, basePath = "/docs") {
       if (p.groupMeta.position !== void 0) {
         entry.position = p.groupMeta.position;
       }
+      if (p.groupMeta.icon) {
+        entry.icon = p.groupMeta.icon;
+      }
     }
   }
   const routes = parsed.map((p) => {
@@ -632,7 +650,8 @@ async function generateRoutes(docsDir, config, basePath = "/docs") {
       ...p.route,
       group: dir,
       groupTitle: meta?.title || (dir ? capitalize(dir) : void 0),
-      groupPosition: meta?.position
+      groupPosition: meta?.position,
+      groupIcon: meta?.icon
     };
   });
   if (config?.i18n) {
@@ -797,7 +816,7 @@ var _filename = (0, import_url2.fileURLToPath)(import_meta2.url);
 var _dirname = import_path4.default.dirname(_filename);
 var _require = (0, import_module.createRequire)(import_meta2.url);
 async function generateStaticPages(options) {
-  const { docsDir, outDir, config } = options;
+  const { docsDir, docsDirName, outDir, config } = options;
   const routes = await generateRoutes(docsDir, config);
   const siteTitle = config?.themeConfig?.title || "Boltdocs";
   const siteDescription = config?.themeConfig?.description || "";
@@ -829,6 +848,7 @@ async function generateStaticPages(options) {
           path: route.path,
           routes,
           config: config || {},
+          docsDirName,
           modules: fakeModules,
           homePage: void 0
           // No custom home page for now
@@ -863,10 +883,11 @@ async function generateStaticPages(options) {
 
 // src/node/plugin/index.ts
 init_utils();
-var import_path5 = __toESM(require("path"));
+var import_path6 = __toESM(require("path"));
 
 // src/node/plugin/entry.ts
 init_utils();
+var import_path5 = __toESM(require("path"));
 function generateEntryCode(options, config) {
   const homeImport = options.homePage ? `import HomePage from '${normalizePath(options.homePage)}';` : "";
   const homeOption = options.homePage ? "homePage: HomePage," : "";
@@ -875,11 +896,12 @@ function generateEntryCode(options, config) {
   const componentImports = pluginComponents.map(
     ([
       name,
-      path6
-    ]) => `import * as _comp_${name} from '${normalizePath(path6)}';
+      path7
+    ]) => `import * as _comp_${name} from '${normalizePath(path7)}';
 const ${name} = _comp_${name}.default || _comp_${name}['${name}'] || _comp_${name};`
   ).join("\n");
   const componentMap = pluginComponents.map(([name]) => name).join(", ");
+  const docsDirName = import_path5.default.basename(options.docsDir || "docs");
   return `
 import { createBoltdocsApp as _createApp } from 'boltdocs/client';
 import 'boltdocs/style.css';
@@ -892,8 +914,9 @@ ${componentImports}
 _createApp({
   target: '#root',
   routes: _routes,
+  docsDirName: '${docsDirName}',
   config: _config,
-  modules: import.meta.glob('/docs/**/*.{md,mdx}'),
+  modules: import.meta.glob('/${docsDirName}/**/*.{md,mdx}'),
   hot: import.meta.hot,
   ${homeOption}
   components: { ${componentMap} },
@@ -946,7 +969,7 @@ ${themeScript}  </head>`);
 
 // src/node/plugin/index.ts
 function boltdocsPlugin(options = {}, passedConfig) {
-  const docsDir = import_path5.default.resolve(process.cwd(), options.docsDir || "docs");
+  const docsDir = import_path6.default.resolve(process.cwd(), options.docsDir || "docs");
   const normalizedDocsDir = normalizePath(docsDir);
   let config = passedConfig;
   let viteConfig;
@@ -976,7 +999,7 @@ function boltdocsPlugin(options = {}, passedConfig) {
       },
       configureServer(server) {
         const configPaths = CONFIG_FILES.map(
-          (c) => import_path5.default.resolve(process.cwd(), c)
+          (c) => import_path6.default.resolve(process.cwd(), c)
         );
         server.watcher.add(configPaths);
         const handleFileEvent = async (file, type) => {
@@ -1039,8 +1062,9 @@ function boltdocsPlugin(options = {}, passedConfig) {
       },
       async closeBundle() {
         if (!isBuild) return;
-        const outDir = viteConfig?.build?.outDir ? import_path5.default.resolve(viteConfig.root, viteConfig.build.outDir) : import_path5.default.resolve(process.cwd(), "dist");
-        await generateStaticPages({ docsDir, outDir, config });
+        const outDir = viteConfig?.build?.outDir ? import_path6.default.resolve(viteConfig.root, viteConfig.build.outDir) : import_path6.default.resolve(process.cwd(), "dist");
+        const docsDirName = import_path6.default.basename(docsDir || "docs");
+        await generateStaticPages({ docsDir, docsDirName, outDir, config });
         const { flushCache: flushCache2 } = await Promise.resolve().then(() => (init_cache(), cache_exports));
         await flushCache2();
       }

package/dist/node/index.mjs

@@ -60,6 +60,14 @@ function parseDocFile(file, docsDir, basePath, config) {
       parts = parts.slice(1);
     }
   }
+  let inferredTab;
+  if (parts.length > 0) {
+    const tabMatch = parts[0].match(/^\((.+)\)$/);
+    if (tabMatch) {
+      inferredTab = tabMatch[1].toLowerCase();
+      parts = parts.slice(1);
+    }
+  }
   const cleanRelativePath = parts.join("/");
   let cleanRoutePath;
   if (data.permalink) {
@@ -93,15 +101,16 @@ function parseDocFile(file, docsDir, basePath, config) {
     const level = match[1].length;
     const text = match[2].replace(/\[([^\]]+)\]\([^\)]+\)/g, "$1").replace(/[_*`]/g, "").trim();
     const id = slugger.slug(text);
-    headings.push({ level, text: escapeHtml(text), id });
+    headings.push({ level, text, id });
   }
-  const sanitizedTitle = data.title ? escapeHtml(data.title) : inferredTitle;
-  let sanitizedDescription = data.description ? escapeHtml(data.description) : "";
+  const sanitizedTitle = data.title ? data.title : inferredTitle;
+  let sanitizedDescription = data.description ? data.description : "";
   if (!sanitizedDescription && content) {
     const summary = content.replace(/^#+.*$/gm, "").replace(/\[([^\]]+)\]\([^\)]+\)/g, "$1").replace(/[_*`]/g, "").replace(/\n+/g, " ").trim().slice(0, 160);
-    sanitizedDescription = escapeHtml(summary);
+    sanitizedDescription = summary;
   }
-  const sanitizedBadge = data.badge ? escapeHtml(data.badge) : void 0;
+  const sanitizedBadge = data.badge ? data.badge : void 0;
+  const icon = data.icon ? String(data.icon) : void 0;
   return {
     route: {
       path: finalPath,
@@ -113,15 +122,17 @@ function parseDocFile(file, docsDir, basePath, config) {
       headings,
       locale,
       version,
-      badge: sanitizedBadge
+      badge: sanitizedBadge,
+      icon,
+      tab: inferredTab
     },
     relativeDir: cleanDirName,
     isGroupIndex,
+    inferredTab,
     groupMeta: isGroupIndex ? {
-      title: escapeHtml(
-        data.groupTitle || data.title || (cleanDirName ? capitalize(cleanDirName) : "")
-      ),
-      position: data.groupPosition ?? data.sidebarPosition ?? (rawDirName ? extractNumberPrefix(rawDirName) : void 0)
+      title: data.groupTitle || data.title || (cleanDirName ? capitalize(cleanDirName) : ""),
+      position: data.groupPosition ?? data.sidebarPosition ?? (rawDirName ? extractNumberPrefix(rawDirName) : void 0),
+      icon
     } : void 0,
     inferredGroupPosition: rawDirName ? extractNumberPrefix(rawDirName) : void 0
   };
@@ -190,13 +201,17 @@ async function generateRoutes(docsDir, config, basePath = "/docs") {
       if (!groupMeta.has(p.relativeDir)) {
         groupMeta.set(p.relativeDir, {
           title: capitalize(p.relativeDir),
-          position: p.inferredGroupPosition
+          position: p.inferredGroupPosition,
+          icon: p.route.icon
         });
       } else {
         const entry = groupMeta.get(p.relativeDir);
         if (entry.position === void 0 && p.inferredGroupPosition !== void 0) {
           entry.position = p.inferredGroupPosition;
         }
+        if (!entry.icon && p.route.icon) {
+          entry.icon = p.route.icon;
+        }
       }
     }
     if (p.isGroupIndex && p.relativeDir && p.groupMeta) {
@@ -205,6 +220,9 @@ async function generateRoutes(docsDir, config, basePath = "/docs") {
       if (p.groupMeta.position !== void 0) {
         entry.position = p.groupMeta.position;
       }
+      if (p.groupMeta.icon) {
+        entry.icon = p.groupMeta.icon;
+      }
     }
   }
   const routes = parsed.map((p) => {
@@ -214,7 +232,8 @@ async function generateRoutes(docsDir, config, basePath = "/docs") {
       ...p.route,
       group: dir,
       groupTitle: meta?.title || (dir ? capitalize(dir) : void 0),
-      groupPosition: meta?.position
+      groupPosition: meta?.position,
+      groupIcon: meta?.icon
     };
   });
   if (config?.i18n) {
@@ -375,7 +394,7 @@ var _filename = fileURLToPath(import.meta.url);
 var _dirname = path3.dirname(_filename);
 var _require = createRequire(import.meta.url);
 async function generateStaticPages(options) {
-  const { docsDir, outDir, config } = options;
+  const { docsDir, docsDirName, outDir, config } = options;
   const routes = await generateRoutes(docsDir, config);
   const siteTitle = config?.themeConfig?.title || "Boltdocs";
   const siteDescription = config?.themeConfig?.description || "";
@@ -407,6 +426,7 @@ async function generateStaticPages(options) {
           path: route.path,
           routes,
           config: config || {},
+          docsDirName,
           modules: fakeModules,
           homePage: void 0
           // No custom home page for now
@@ -440,9 +460,10 @@ async function generateStaticPages(options) {
 }
 
 // src/node/plugin/index.ts
-import path4 from "path";
+import path5 from "path";
 
 // src/node/plugin/entry.ts
+import path4 from "path";
 function generateEntryCode(options, config) {
   const homeImport = options.homePage ? `import HomePage from '${normalizePath(options.homePage)}';` : "";
   const homeOption = options.homePage ? "homePage: HomePage," : "";
@@ -451,11 +472,12 @@ function generateEntryCode(options, config) {
   const componentImports = pluginComponents.map(
     ([
       name,
-      path5
-    ]) => `import * as _comp_${name} from '${normalizePath(path5)}';
+      path6
+    ]) => `import * as _comp_${name} from '${normalizePath(path6)}';
 const ${name} = _comp_${name}.default || _comp_${name}['${name}'] || _comp_${name};`
   ).join("\n");
   const componentMap = pluginComponents.map(([name]) => name).join(", ");
+  const docsDirName = path4.basename(options.docsDir || "docs");
   return `
 import { createBoltdocsApp as _createApp } from 'boltdocs/client';
 import 'boltdocs/style.css';
@@ -468,8 +490,9 @@ ${componentImports}
 _createApp({
   target: '#root',
   routes: _routes,
+  docsDirName: '${docsDirName}',
   config: _config,
-  modules: import.meta.glob('/docs/**/*.{md,mdx}'),
+  modules: import.meta.glob('/${docsDirName}/**/*.{md,mdx}'),
   hot: import.meta.hot,
   ${homeOption}
   components: { ${componentMap} },
@@ -522,7 +545,7 @@ ${themeScript}  </head>`);
 
 // src/node/plugin/index.ts
 function boltdocsPlugin(options = {}, passedConfig) {
-  const docsDir = path4.resolve(process.cwd(), options.docsDir || "docs");
+  const docsDir = path5.resolve(process.cwd(), options.docsDir || "docs");
   const normalizedDocsDir = normalizePath(docsDir);
   let config = passedConfig;
   let viteConfig;
@@ -552,7 +575,7 @@ function boltdocsPlugin(options = {}, passedConfig) {
       },
       configureServer(server) {
         const configPaths = CONFIG_FILES.map(
-          (c) => path4.resolve(process.cwd(), c)
+          (c) => path5.resolve(process.cwd(), c)
         );
         server.watcher.add(configPaths);
         const handleFileEvent = async (file, type) => {
@@ -615,8 +638,9 @@ function boltdocsPlugin(options = {}, passedConfig) {
       },
       async closeBundle() {
         if (!isBuild) return;
-        const outDir = viteConfig?.build?.outDir ? path4.resolve(viteConfig.root, viteConfig.build.outDir) : path4.resolve(process.cwd(), "dist");
-        await generateStaticPages({ docsDir, outDir, config });
+        const outDir = viteConfig?.build?.outDir ? path5.resolve(viteConfig.root, viteConfig.build.outDir) : path5.resolve(process.cwd(), "dist");
+        const docsDirName = path5.basename(docsDir || "docs");
+        await generateStaticPages({ docsDir, docsDirName, outDir, config });
         const { flushCache } = await import("../cache-KNL5B4EE.mjs");
         await flushCache();
       }

package/dist/{types-DGIo1VKD.d.mts → types-CviV0GbX.d.mts}

@@ -33,6 +33,17 @@ interface ComponentRoute {
     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: string;
+        expires?: string;
+    };
+    /** Optional icon for the route's group */
+    groupIcon?: string;
 }
 /**
  * Configuration options for initializing the Boltdocs client app.
@@ -42,6 +53,8 @@ interface CreateBoltdocsAppOptions {
     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: any;
     /** Dynamic import mapping from `import.meta.glob` for the documentation pages */

package/dist/{types-DGIo1VKD.d.ts → types-CviV0GbX.d.ts}

@@ -33,6 +33,17 @@ interface ComponentRoute {
     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: string;
+        expires?: string;
+    };
+    /** Optional icon for the route's group */
+    groupIcon?: string;
 }
 /**
  * Configuration options for initializing the Boltdocs client app.
@@ -42,6 +53,8 @@ interface CreateBoltdocsAppOptions {
     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: any;
     /** Dynamic import mapping from `import.meta.glob` for the documentation pages */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boltdocs",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "A lightweight documentation generator for React projects.",
   "main": "dist/node/index.js",
   "module": "dist/node/index.mjs",

package/src/client/app/index.tsx

@@ -89,6 +89,7 @@ const mdxComponents = {
 export function AppShell({
   initialRoutes,
   initialConfig,
+  docsDirName,
   modules,
   hot,
   homePage: HomePage,
@@ -96,6 +97,7 @@ export function AppShell({
 }: {
   initialRoutes: ComponentRoute[];
   initialConfig: any;
+  docsDirName: string;
   modules: Record<string, () => Promise<any>>;
   hot?: any;
   homePage?: React.ComponentType;
@@ -110,8 +112,8 @@ export function AppShell({
         (route) => !(HomePage && (route.path === "/" || route.path === "")),
       )
       .map((route) => {
-        const loaderKey = Object.keys(modules).find((k) =>
-          k.endsWith("/" + route.filePath),
+        const loaderKey = Object.keys(modules).find(
+          (k) => k === `/${docsDirName}/${route.filePath}`,
         );
         const loader = loaderKey ? modules[loaderKey] : null;
 
@@ -142,7 +144,7 @@ export function AppShell({
   // Sync resolved routes when info or modules change
   useEffect(() => {
     setResolvedRoutes(resolveRoutes(routesInfo));
-  }, [routesInfo, modules]);
+  }, [routesInfo, modules, docsDirName]);
 
   return (
     <ConfigContext.Provider value={config}>
@@ -302,7 +304,8 @@ function MdxPage({
  * ```
  */
 export function createBoltdocsApp(options: CreateBoltdocsAppOptions) {
-  const { target, routes, config, modules, hot, homePage } = options;
+  const { target, routes, docsDirName, config, modules, hot, homePage } =
+    options;
   const container = document.querySelector(target);
   if (!container) {
     throw new Error(
@@ -316,6 +319,7 @@ export function createBoltdocsApp(options: CreateBoltdocsAppOptions) {
         <AppShell
           initialRoutes={routes}
           initialConfig={config}
+          docsDirName={docsDirName}
           modules={modules}
           hot={hot}
           homePage={homePage}

package/src/client/index.ts

@@ -29,6 +29,7 @@ export {
   InfoBox,
   List,
   FileTree,
+  Table,
 } from "./theme/components/mdx";
 export type {
   ButtonProps,
@@ -40,4 +41,5 @@ export type {
   AdmonitionProps,
   ListProps,
   FileTreeProps,
+  TableProps,
 } from "./theme/components/mdx";