boltdocs 1.10.2 → 2.0.0

package/dist/client/ssr.mjs

@@ -1,33 +1 @@
-import {
-  AppShell
-} from "../chunk-TKLQWU7H.mjs";
-import "../chunk-FMTOYQLO.mjs";
-
-// src/client/ssr.tsx
-import React from "react";
-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, docsDirName } = options;
-  const resolvedModules = {};
-  for (const [key, mod] of Object.entries(modules)) {
-    resolvedModules[key] = () => Promise.resolve(mod);
-  }
-  const html = ReactDOMServer.renderToString(
-    /* @__PURE__ */ jsx(React.StrictMode, { children: /* @__PURE__ */ jsx(StaticRouter, { location: path, children: /* @__PURE__ */ jsx(
-      AppShell,
-      {
-        initialRoutes: routes,
-        initialConfig: config,
-        docsDirName,
-        modules: resolvedModules,
-        homePage
-      }
-    ) }) })
-  );
-  return html;
-}
-export {
-  render
-};
+import{d as t}from"../chunk-QYPNX5UN.mjs";import"../chunk-A4HQPEPU.mjs";import"../chunk-BA5NH5HU.mjs";import"../chunk-BQCD3DWG.mjs";import"../chunk-XEAPSFMB.mjs";import"../chunk-JZXLCA2E.mjs";import l from"react";import R from"react-dom/server";import{StaticRouter as f}from"react-router-dom/server";import{jsx as e}from"react/jsx-runtime";async function D(r){let{path:n,routes:i,config:s,modules:a,homePage:m,externalPages:c,docsDirName:p}=r,o={};for(let[d,g]of Object.entries(a))o[d]=()=>Promise.resolve(g);return R.renderToString(e(l.StrictMode,{children:e(f,{location:n,children:e(t,{initialRoutes:i,initialConfig:s,docsDirName:p,modules:o,homePage:m,externalPages:c})})}))}export{D as render};

package/dist/{config-BsFQ-ErD.d.ts → config-CX4l-ZNp.d.mts}

@@ -4,8 +4,8 @@ import { Plugin } from 'vite';
  * Represents a single social link in the configuration.
  */
 interface BoltdocsSocialLink {
-    /** Identifier for the icon (e.g., 'github', 'twitter') */
-    icon: "discord" | "x" | string;
+    /** Identifier for the icon (e.g., 'github') */
+    icon: 'discord' | 'x' | 'github' | 'bluesky' | string;
     /** The URL the social link points to */
     link: string;
 }
@@ -24,22 +24,25 @@ interface BoltdocsThemeConfig {
     title?: string;
     /** The global description of the site (used for SEO) */
     description?: string;
-    /** URL path to the site logo */
-    logo?: 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 (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;
+        label: string;
         /** URL path or external link */
-        link?: string;
-        /** Alignment of the item in the navbar */
-        position?: "left" | "right";
+        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<{
@@ -52,8 +55,6 @@ interface BoltdocsThemeConfig {
     footer?: BoltdocsFooterConfig;
     /** Whether to show breadcrumbs navigation (default: true) */
     breadcrumbs?: boolean;
-    /** Path to a custom CSS file that overrides theme variables */
-    customCss?: string;
     /** URL template for 'Edit this page'. Use :path as a placeholder. */
     editLink?: string;
     /** URL for the 'Community help' link. */
@@ -64,19 +65,6 @@ interface BoltdocsThemeConfig {
     githubRepo?: string;
     /** Whether to show the 'Powered by LiteDocs' badge in the sidebar (default: true) */
     poweredBy?: boolean;
-    /** Whether to show a preview tooltip on internal links hover (default: true) */
-    linkPreview?: boolean;
-    /** Granular layout customization props */
-    layoutProps?: {
-        navbar?: any;
-        sidebar?: any;
-        toc?: any;
-        background?: any;
-        head?: any;
-        breadcrumbs?: any;
-        className?: string;
-        style?: any;
-    };
     /**
      * Top-level tabs for organizing documentation groups.
      * Tab discovery uses the (tab-id) directory syntax.
@@ -90,9 +78,12 @@ interface BoltdocsThemeConfig {
      * 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: 'one-dark-pro'
+     * Default: { light: 'github-light', dark: 'one-dark-pro' }
      */
-    codeTheme?: string | Record<string, string>;
+    codeTheme?: string | {
+        light: string;
+        dark: string;
+    };
     /**
      * Configuration for the 'Copy Markdown' button.
      * Can be a boolean or an object with text and icon.
@@ -128,16 +119,28 @@ interface BoltdocsPlugin {
     /** A unique name for the plugin */
     name: string;
     /** Whether to run this plugin before or after default ones (optional) */
-    enforce?: "pre" | "post";
+    enforce?: 'pre' | 'post';
     /** Optional remark plugins to add to the MDX pipeline */
-    remarkPlugins?: any[];
+    remarkPlugins?: unknown[];
     /** Optional rehype plugins to add to the MDX pipeline */
-    rehypePlugins?: any[];
+    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.
  */
@@ -154,6 +157,10 @@ interface BoltdocsConfig {
     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;
 }
 
-export type { BoltdocsConfig as B, BoltdocsThemeConfig as a };
+export type { BoltdocsConfig as B, BoltdocsThemeConfig as a, BoltdocsSocialLink as b };

package/dist/{config-BsFQ-ErD.d.mts → config-CX4l-ZNp.d.ts}

@@ -4,8 +4,8 @@ import { Plugin } from 'vite';
  * Represents a single social link in the configuration.
  */
 interface BoltdocsSocialLink {
-    /** Identifier for the icon (e.g., 'github', 'twitter') */
-    icon: "discord" | "x" | string;
+    /** Identifier for the icon (e.g., 'github') */
+    icon: 'discord' | 'x' | 'github' | 'bluesky' | string;
     /** The URL the social link points to */
     link: string;
 }
@@ -24,22 +24,25 @@ interface BoltdocsThemeConfig {
     title?: string;
     /** The global description of the site (used for SEO) */
     description?: string;
-    /** URL path to the site logo */
-    logo?: 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 (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;
+        label: string;
         /** URL path or external link */
-        link?: string;
-        /** Alignment of the item in the navbar */
-        position?: "left" | "right";
+        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<{
@@ -52,8 +55,6 @@ interface BoltdocsThemeConfig {
     footer?: BoltdocsFooterConfig;
     /** Whether to show breadcrumbs navigation (default: true) */
     breadcrumbs?: boolean;
-    /** Path to a custom CSS file that overrides theme variables */
-    customCss?: string;
     /** URL template for 'Edit this page'. Use :path as a placeholder. */
     editLink?: string;
     /** URL for the 'Community help' link. */
@@ -64,19 +65,6 @@ interface BoltdocsThemeConfig {
     githubRepo?: string;
     /** Whether to show the 'Powered by LiteDocs' badge in the sidebar (default: true) */
     poweredBy?: boolean;
-    /** Whether to show a preview tooltip on internal links hover (default: true) */
-    linkPreview?: boolean;
-    /** Granular layout customization props */
-    layoutProps?: {
-        navbar?: any;
-        sidebar?: any;
-        toc?: any;
-        background?: any;
-        head?: any;
-        breadcrumbs?: any;
-        className?: string;
-        style?: any;
-    };
     /**
      * Top-level tabs for organizing documentation groups.
      * Tab discovery uses the (tab-id) directory syntax.
@@ -90,9 +78,12 @@ interface BoltdocsThemeConfig {
      * 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: 'one-dark-pro'
+     * Default: { light: 'github-light', dark: 'one-dark-pro' }
      */
-    codeTheme?: string | Record<string, string>;
+    codeTheme?: string | {
+        light: string;
+        dark: string;
+    };
     /**
      * Configuration for the 'Copy Markdown' button.
      * Can be a boolean or an object with text and icon.
@@ -128,16 +119,28 @@ interface BoltdocsPlugin {
     /** A unique name for the plugin */
     name: string;
     /** Whether to run this plugin before or after default ones (optional) */
-    enforce?: "pre" | "post";
+    enforce?: 'pre' | 'post';
     /** Optional remark plugins to add to the MDX pipeline */
-    remarkPlugins?: any[];
+    remarkPlugins?: unknown[];
     /** Optional rehype plugins to add to the MDX pipeline */
-    rehypePlugins?: any[];
+    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.
  */
@@ -154,6 +157,10 @@ interface BoltdocsConfig {
     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;
 }
 
-export type { BoltdocsConfig as B, BoltdocsThemeConfig as a };
+export type { BoltdocsConfig as B, BoltdocsThemeConfig as a, BoltdocsSocialLink as b };

package/dist/node/index.d.mts

@@ -1,6 +1,6 @@
 import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-BsFQ-ErD.mjs';
-export { a as BoltdocsThemeConfig } from '../config-BsFQ-ErD.mjs';
+import { B as BoltdocsConfig } from '../config-CX4l-ZNp.mjs';
+export { a as BoltdocsThemeConfig } from '../config-CX4l-ZNp.mjs';
 
 /**
  * Configuration options specifically for the Boltdocs Vite plugin.
@@ -10,8 +10,6 @@ interface BoltdocsPluginOptions {
     docsDir?: string;
     /** Path to a custom home page component (relative to project root) to render at '/' */
     homePage?: string;
-    /** Path to a custom CSS file to override theme variables. Can also be set in boltdocs.config.js */
-    customCss?: string;
 }
 
 /**

package/dist/node/index.d.ts

@@ -1,6 +1,6 @@
 import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-BsFQ-ErD.js';
-export { a as BoltdocsThemeConfig } from '../config-BsFQ-ErD.js';
+import { B as BoltdocsConfig } from '../config-CX4l-ZNp.js';
+export { a as BoltdocsThemeConfig } from '../config-CX4l-ZNp.js';
 
 /**
  * Configuration options specifically for the Boltdocs Vite plugin.
@@ -10,8 +10,6 @@ interface BoltdocsPluginOptions {
     docsDir?: string;
     /** Path to a custom home page component (relative to project root) to render at '/' */
     homePage?: string;
-    /** Path to a custom CSS file to override theme variables. Can also be set in boltdocs.config.js */
-    customCss?: string;
 }
 
 /**