boltdocs 1.0.0

package/dist/client/ssr.mjs

@@ -0,0 +1,32 @@
+import {
+  AppShell
+} from "../chunk-ZFCOLEXN.mjs";
+import "../chunk-X6BYQHVC.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 } = 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,
+        modules: resolvedModules,
+        homePage
+      }
+    ) }) })
+  );
+  return html;
+}
+export {
+  render
+};

package/dist/config-D2XmHJYe.d.mts

@@ -0,0 +1,122 @@
+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;
+    /** 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 */
+    logo?: string;
+    /** Items to display in the top navigation bar */
+    navbar?: Array<{
+        text: string;
+        link: 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;
+    /** 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. */
+    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;
+    /** Whether to show the 'Powered by LiteDocs' badge in the sidebar (default: true) */
+    poweredBy?: boolean;
+    /** Granular layout customization props */
+    layoutProps?: {
+        navbar?: any;
+        sidebar?: any;
+        toc?: any;
+        background?: any;
+        head?: any;
+        breadcrumbs?: any;
+        className?: string;
+        style?: any;
+    };
+}
+/**
+ * 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?: any[];
+    /** Optional rehype plugins to add to the MDX pipeline */
+    rehypePlugins?: any[];
+    /** 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>;
+}
+/**
+ * The root configuration object for Boltdocs.
+ */
+interface BoltdocsConfig {
+    /** The base URL of the site, used for generating the sitemap */
+    siteUrl?: string;
+    /** Configuration pertaining to the UI and appearance */
+    themeConfig?: BoltdocsThemeConfig;
+    /** The root directory containing markdown documentation files (default: 'docs') */
+    docsDir?: string;
+    /** Configuration for internationalization */
+    i18n?: BoltdocsI18nConfig;
+    /** Configuration for documentation versioning */
+    versions?: BoltdocsVersionsConfig;
+    /** Custom plugins for extending functionality */
+    plugins?: BoltdocsPlugin[];
+}
+
+export type { BoltdocsConfig as B, BoltdocsThemeConfig as a };

package/dist/config-D2XmHJYe.d.ts

@@ -0,0 +1,122 @@
+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;
+    /** 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 */
+    logo?: string;
+    /** Items to display in the top navigation bar */
+    navbar?: Array<{
+        text: string;
+        link: 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;
+    /** 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. */
+    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;
+    /** Whether to show the 'Powered by LiteDocs' badge in the sidebar (default: true) */
+    poweredBy?: boolean;
+    /** Granular layout customization props */
+    layoutProps?: {
+        navbar?: any;
+        sidebar?: any;
+        toc?: any;
+        background?: any;
+        head?: any;
+        breadcrumbs?: any;
+        className?: string;
+        style?: any;
+    };
+}
+/**
+ * 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?: any[];
+    /** Optional rehype plugins to add to the MDX pipeline */
+    rehypePlugins?: any[];
+    /** 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>;
+}
+/**
+ * The root configuration object for Boltdocs.
+ */
+interface BoltdocsConfig {
+    /** The base URL of the site, used for generating the sitemap */
+    siteUrl?: string;
+    /** Configuration pertaining to the UI and appearance */
+    themeConfig?: BoltdocsThemeConfig;
+    /** The root directory containing markdown documentation files (default: 'docs') */
+    docsDir?: string;
+    /** Configuration for internationalization */
+    i18n?: BoltdocsI18nConfig;
+    /** Configuration for documentation versioning */
+    versions?: BoltdocsVersionsConfig;
+    /** Custom plugins for extending functionality */
+    plugins?: BoltdocsPlugin[];
+}
+
+export type { BoltdocsConfig as B, BoltdocsThemeConfig as a };

package/dist/index-CRQKWAeo.d.mts

@@ -0,0 +1,82 @@
+import React from 'react';
+
+declare global {
+    interface ImportMeta {
+        env: Record<string, any>;
+    }
+}
+/**
+ * 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 locale this route belongs to, if i18n is configured */
+    locale?: string;
+    /** The version this route belongs to, if versioning is configured */
+    version?: string;
+}
+/**
+ * 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[];
+    /** Site configuration (`virtual:boltdocs-config`) */
+    config: any;
+    /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
+    modules: Record<string, () => Promise<any>>;
+    /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
+    hot?: any;
+    /** Optional custom React component to render when visiting the root path ('/') */
+    homePage?: React.ComponentType;
+    /** Optional custom MDX components provided by plugins */
+    components?: Record<string, React.ComponentType<any>>;
+}
+/**
+ * Creates and mounts the Boltdocs documentation app.
+ *
+ * Usage:
+ * ```tsx
+ * import { createBoltdocsApp } from 'boltdocs/client'
+ * import routes from 'virtual:boltdocs-routes'
+ * import config from 'virtual:boltdocs-config'
+ * import 'boltdocs/style.css'
+ * import HomePage from './HomePage'
+ *
+ * createBoltdocsApp({
+ *   target: '#root',
+ *   routes,
+ *   config,
+ *   modules: import.meta.glob('/docs/**\/*.{md,mdx}'),
+ *   hot: import.meta.hot,
+ *   homePage: HomePage,
+ * })
+ * ```
+ */
+declare function createBoltdocsApp(options: CreateBoltdocsAppOptions): void;
+
+export { type ComponentRoute as C, type CreateBoltdocsAppOptions as a, createBoltdocsApp as c };

package/dist/index-CRQKWAeo.d.ts

@@ -0,0 +1,82 @@
+import React from 'react';
+
+declare global {
+    interface ImportMeta {
+        env: Record<string, any>;
+    }
+}
+/**
+ * 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 locale this route belongs to, if i18n is configured */
+    locale?: string;
+    /** The version this route belongs to, if versioning is configured */
+    version?: string;
+}
+/**
+ * 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[];
+    /** Site configuration (`virtual:boltdocs-config`) */
+    config: any;
+    /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
+    modules: Record<string, () => Promise<any>>;
+    /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
+    hot?: any;
+    /** Optional custom React component to render when visiting the root path ('/') */
+    homePage?: React.ComponentType;
+    /** Optional custom MDX components provided by plugins */
+    components?: Record<string, React.ComponentType<any>>;
+}
+/**
+ * Creates and mounts the Boltdocs documentation app.
+ *
+ * Usage:
+ * ```tsx
+ * import { createBoltdocsApp } from 'boltdocs/client'
+ * import routes from 'virtual:boltdocs-routes'
+ * import config from 'virtual:boltdocs-config'
+ * import 'boltdocs/style.css'
+ * import HomePage from './HomePage'
+ *
+ * createBoltdocsApp({
+ *   target: '#root',
+ *   routes,
+ *   config,
+ *   modules: import.meta.glob('/docs/**\/*.{md,mdx}'),
+ *   hot: import.meta.hot,
+ *   homePage: HomePage,
+ * })
+ * ```
+ */
+declare function createBoltdocsApp(options: CreateBoltdocsAppOptions): void;
+
+export { type ComponentRoute as C, type CreateBoltdocsAppOptions as a, createBoltdocsApp as c };

package/dist/node/cli/index.d.mts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/node/cli/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/node/cli/index.js

@@ -0,0 +1,199 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/node/cli/index.ts
+var import_cac = __toESM(require("cac"));
+
+// src/node/cli/commands/config.ts
+var import_path2 = __toESM(require("path"));
+
+// src/node/config.ts
+var import_path = __toESM(require("path"));
+var import_url = require("url");
+var import_fs = __toESM(require("fs"));
+var CONFIG_FILES = [
+  "boltdocs.config.js",
+  "boltdocs.config.mjs",
+  "boltdocs.config.ts"
+];
+async function resolveConfig(docsDir) {
+  const projectRoot = process.cwd();
+  const defaults = {
+    docsDir: import_path.default.resolve(docsDir),
+    themeConfig: {
+      title: "Boltdocs",
+      description: "A Vite documentation framework",
+      navbar: [
+        { text: "Home", link: "/" },
+        { text: "Documentation", link: "/docs" }
+      ]
+    }
+  };
+  for (const filename of CONFIG_FILES) {
+    const configPath = import_path.default.resolve(projectRoot, filename);
+    if (import_fs.default.existsSync(configPath)) {
+      try {
+        const fileUrl = (0, import_url.pathToFileURL)(configPath).href + "?t=" + Date.now();
+        const mod = await import(fileUrl);
+        const userConfig = mod.default || mod;
+        const userThemeConfig = userConfig.themeConfig || userConfig;
+        return {
+          docsDir: import_path.default.resolve(docsDir),
+          themeConfig: {
+            ...defaults.themeConfig,
+            ...userThemeConfig
+          },
+          i18n: userConfig.i18n,
+          versions: userConfig.versions,
+          siteUrl: userConfig.siteUrl,
+          plugins: userConfig.plugins || []
+        };
+      } catch (e) {
+        console.warn(`[boltdocs] Failed to load config from ${filename}:`, e);
+      }
+    }
+  }
+  return defaults;
+}
+
+// src/node/cli/commands/config.ts
+async function configAction(root) {
+  const rootDir = root ? import_path2.default.resolve(root) : process.cwd();
+  const docsDir = import_path2.default.resolve(rootDir, "docs");
+  try {
+    const config = await resolveConfig(docsDir);
+    process.stdout.write(JSON.stringify(config, null, 2) + "\n");
+  } catch (e) {
+    process.stderr.write("Failed to resolve configuration: " + e + "\n");
+    process.exit(1);
+  }
+}
+
+// src/node/cli/commands/generate-css.ts
+var import_path3 = __toESM(require("path"));
+var import_node_fs = __toESM(require("fs"));
+
+// src/node/cli/constants.ts
+var DEFAULT_CSS_VARIABLES = `:root {
+  /* \u2500 Base palette \u2500 */
+  --ld-bg-main: #0a0a0f;
+  --ld-bg-soft: #0f0f18;
+  --ld-bg-mute: #141420;
+  --ld-surface: #1a1a2e;
+  --ld-border-subtle: rgba(255, 255, 255, 0.06);
+  --ld-border-strong: rgba(255, 255, 255, 0.12);
+
+  /* \u2500 Text \u2500 */
+  --ld-text-main: #e4e4ed;
+  --ld-text-muted: #9d9db5;
+  --ld-text-dim: #6b6b85;
+
+  /* \u2500 Accent \u2500 */
+  --ld-color-primary: #ffff;
+  --ld-color-primary-hover: #f8f8f8;
+  --ld-color-primary-muted: rgba(255, 255, 255, 0.05);
+  --ld-color-primary-glow: rgba(255, 255, 255, 0.15);
+  --ld-color-primary-text: #010101;
+  --ld-color-accent: #ffff; /* Yellow accent for TOC */
+
+  /* \u2500 Code \u2500 */
+  --ld-code-bg: #0d0d14;
+  --ld-code-header: #111119;
+  --ld-code-text: #d4d4d4;
+
+  /* \u2500 Typography \u2500 */
+  --ld-font-sans: "Inter", system-ui, -apple-system, sans-serif;
+  --ld-font-mono:
+    "JetBrains Mono", ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas,
+    monospace;
+
+  /* \u2500 Dimensions \u2500 */
+  --ld-navbar-height: 3.5rem;
+  --ld-sidebar-width: 14.5rem;
+  --ld-toc-width: 13rem;
+  --ld-content-max-width: 820px;
+  --ld-radius-sm: 4px;
+  --ld-radius-md: 8px;
+  --ld-radius-lg: 12px;
+  --ld-radius-full: 9999px;
+}
+
+[data-theme="light"],
+.theme-light {
+  --ld-bg-main: #ffffff;
+  --ld-bg-soft: #f9fafb;
+  --ld-bg-mute: #f3f4f6;
+
+  --ld-surface: #ffffff;
+
+  --ld-border-subtle: #e5e7eb;
+  --ld-border-strong: #d1d5db;
+
+  --ld-text-main: #111827;
+  --ld-text-muted: #4b5563;
+  --ld-text-dim: #6b7280;
+
+  --ld-color-primary: #010101;
+  --ld-color-primary-hover: #010101;
+  --ld-color-primary-muted: rgba(127, 19, 236, 0.1);
+  --ld-color-primary-glow: rgba(127, 19, 236, 0.25);
+  --ld-color-primary-text: #010101;
+
+  --ld-code-bg: #f3f4f6;
+  --ld-code-header: #e5e7eb;
+  --ld-code-text: #1f2937;
+}
+`;
+
+// src/node/cli/commands/generate-css.ts
+function generateCssAction(outputPath) {
+  try {
+    const target = process.cwd();
+    const filename = outputPath || "custom.css";
+    const filepath = import_path3.default.resolve(target, filename);
+    if (import_node_fs.default.existsSync(filepath)) {
+      process.stderr.write(
+        "Error: File " + filename + " already exists in " + target + ".\n"
+      );
+      process.exit(1);
+    }
+    import_node_fs.default.writeFileSync(filepath, DEFAULT_CSS_VARIABLES);
+    process.stdout.write("Success! Generated " + filename + "\n");
+  } catch (e) {
+    process.stderr.write("Failed to generate CSS: " + e + "\n");
+    process.exit(1);
+  }
+}
+
+// src/node/cli/index.ts
+var cli = (0, import_cac.default)("boltdocs");
+cli.command("config [root]", "Output the resolved boltdocs configuration").action(configAction);
+cli.command(
+  "generate:css [path]",
+  "Generate a custom.css file with default Boltdocs CSS variables"
+).action(generateCssAction);
+cli.help();
+cli.version("1.0.0");
+cli.parse();