boltdocs 1.10.2 → 1.11.0

package/dist/client/ssr.mjs

@@ -1,33 +0,0 @@
-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
-};

package/dist/config-BsFQ-ErD.d.mts

@@ -1,159 +0,0 @@
-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 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<{
-        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;
-    /** 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.
-     */
-    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: 'one-dark-pro'
-     */
-    codeTheme?: string | Record<string, 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 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-BsFQ-ErD.d.ts

@@ -1,159 +0,0 @@
-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 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<{
-        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;
-    /** 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.
-     */
-    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: 'one-dark-pro'
-     */
-    codeTheme?: string | Record<string, 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 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/node/index.d.mts

@@ -1,91 +0,0 @@
-import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-BsFQ-ErD.mjs';
-export { a as BoltdocsThemeConfig } from '../config-BsFQ-ErD.mjs';
-
-/**
- * Configuration options specifically for the Boltdocs Vite plugin.
- */
-interface BoltdocsPluginOptions {
-    /** The root directory containing markdown files (default: 'docs') */
-    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;
-}
-
-/**
- * Options for the Static Site Generation process.
- */
-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) */
-    config?: BoltdocsConfig;
-}
-
-/**
- * Generates static HTML files and a \`sitemap.xml\` for all documentation routes.
- * Called automatically in the \`closeBundle\` hook of the Vite plugin during a production build.
- *
- * @param options - Configuration for paths and site metadata
- */
-declare function generateStaticPages(options: SSGOptions): Promise<void>;
-
-/**
- * Metadata representing a single documentation route.
- * This information is used to build the client-side router and the sidebar navigation.
- */
-interface RouteMeta {
-    /** The final URL path for the route (e.g., '/docs/guide/start') */
-    path: string;
-    /** The absolute filesystem path to the source markdown/mdx file */
-    componentPath: string;
-    /** The title of the page, usually extracted from frontmatter or the filename */
-    title: string;
-    /** The relative path from the docs directory, used for edit links */
-    filePath: string;
-    /** Optional description of the page (for SEO/meta tags) */
-    description?: string;
-    /** Optional explicit position for ordering in the sidebar */
-    sidebarPosition?: number;
-    /** The group (directory) this route belongs to */
-    group?: string;
-    /** The display title for the route's group */
-    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;
-        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;
-    /** Optional badge to display next to the sidebar item (e.g., 'New', 'Experimental') */
-    badge?: string | {
-        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;
-    /** The extracted plain-text content of the page for search indexing */
-    _content?: string;
-    /** The raw markdown content of the page */
-    _rawContent?: string;
-}
-
-declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;
-
-export { BoltdocsConfig, type BoltdocsPluginOptions, type RouteMeta, type SSGOptions, boltdocs as default, generateStaticPages };

package/dist/node/index.d.ts

@@ -1,91 +0,0 @@
-import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-BsFQ-ErD.js';
-export { a as BoltdocsThemeConfig } from '../config-BsFQ-ErD.js';
-
-/**
- * Configuration options specifically for the Boltdocs Vite plugin.
- */
-interface BoltdocsPluginOptions {
-    /** The root directory containing markdown files (default: 'docs') */
-    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;
-}
-
-/**
- * Options for the Static Site Generation process.
- */
-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) */
-    config?: BoltdocsConfig;
-}
-
-/**
- * Generates static HTML files and a \`sitemap.xml\` for all documentation routes.
- * Called automatically in the \`closeBundle\` hook of the Vite plugin during a production build.
- *
- * @param options - Configuration for paths and site metadata
- */
-declare function generateStaticPages(options: SSGOptions): Promise<void>;
-
-/**
- * Metadata representing a single documentation route.
- * This information is used to build the client-side router and the sidebar navigation.
- */
-interface RouteMeta {
-    /** The final URL path for the route (e.g., '/docs/guide/start') */
-    path: string;
-    /** The absolute filesystem path to the source markdown/mdx file */
-    componentPath: string;
-    /** The title of the page, usually extracted from frontmatter or the filename */
-    title: string;
-    /** The relative path from the docs directory, used for edit links */
-    filePath: string;
-    /** Optional description of the page (for SEO/meta tags) */
-    description?: string;
-    /** Optional explicit position for ordering in the sidebar */
-    sidebarPosition?: number;
-    /** The group (directory) this route belongs to */
-    group?: string;
-    /** The display title for the route's group */
-    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;
-        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;
-    /** Optional badge to display next to the sidebar item (e.g., 'New', 'Experimental') */
-    badge?: string | {
-        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;
-    /** The extracted plain-text content of the page for search indexing */
-    _content?: string;
-    /** The raw markdown content of the page */
-    _rawContent?: string;
-}
-
-declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;
-
-export { BoltdocsConfig, type BoltdocsPluginOptions, type RouteMeta, type SSGOptions, boltdocs as default, generateStaticPages };