boltdocs 2.0.0 → 2.1.0

package/dist/node/index.d.mts

@@ -1,6 +1,210 @@
-import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-CX4l-ZNp.mjs';
-export { a as BoltdocsThemeConfig } from '../config-CX4l-ZNp.mjs';
+import * as vite from 'vite';
+import { Plugin, InlineConfig } 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;
+}
+declare function defineConfig(config: BoltdocsConfig): BoltdocsConfig;
+/**
+ * Loads user's configuration file (e.g., `boltdocs.config.js` or `boltdocs.config.ts`) if it exists,
+ * merges it with the default configuration, and returns the final `BoltdocsConfig`.
+ *
+ * @param docsDir - The directory containing the documentation files
+ * @param root - The project root directory (defaults to process.cwd())
+ * @returns The merged configuration object
+ */
+declare function resolveConfig(docsDir: string, root?: string): Promise<BoltdocsConfig>;
 
 /**
  * Configuration options specifically for the Boltdocs Vite plugin.
@@ -85,5 +289,10 @@ interface RouteMeta {
 }
 
 declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;
+/**
+ * Generates the complete Vite configuration for a Boltdocs project.
+ * This is used by the Boltdocs CLI to run Vite without a user-defined vite.config.ts.
+ */
+declare function createViteConfig(root: string, mode?: 'development' | 'production'): Promise<InlineConfig>;
 
-export { BoltdocsConfig, type BoltdocsPluginOptions, type RouteMeta, type SSGOptions, boltdocs as default, generateStaticPages };
+export { type BoltdocsConfig, type BoltdocsPluginOptions, type BoltdocsThemeConfig, type RouteMeta, type SSGOptions, createViteConfig, boltdocs as default, defineConfig, generateStaticPages, resolveConfig };

package/dist/node/index.d.ts

@@ -1,6 +1,210 @@
-import { Plugin } from 'vite';
-import { B as BoltdocsConfig } from '../config-CX4l-ZNp.js';
-export { a as BoltdocsThemeConfig } from '../config-CX4l-ZNp.js';
+import * as vite from 'vite';
+import { Plugin, InlineConfig } 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;
+}
+declare function defineConfig(config: BoltdocsConfig): BoltdocsConfig;
+/**
+ * Loads user's configuration file (e.g., `boltdocs.config.js` or `boltdocs.config.ts`) if it exists,
+ * merges it with the default configuration, and returns the final `BoltdocsConfig`.
+ *
+ * @param docsDir - The directory containing the documentation files
+ * @param root - The project root directory (defaults to process.cwd())
+ * @returns The merged configuration object
+ */
+declare function resolveConfig(docsDir: string, root?: string): Promise<BoltdocsConfig>;
 
 /**
  * Configuration options specifically for the Boltdocs Vite plugin.
@@ -85,5 +289,10 @@ interface RouteMeta {
 }
 
 declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;
+/**
+ * Generates the complete Vite configuration for a Boltdocs project.
+ * This is used by the Boltdocs CLI to run Vite without a user-defined vite.config.ts.
+ */
+declare function createViteConfig(root: string, mode?: 'development' | 'production'): Promise<InlineConfig>;
 
-export { BoltdocsConfig, type BoltdocsPluginOptions, type RouteMeta, type SSGOptions, boltdocs as default, generateStaticPages };
+export { type BoltdocsConfig, type BoltdocsPluginOptions, type BoltdocsThemeConfig, type RouteMeta, type SSGOptions, createViteConfig, boltdocs as default, defineConfig, generateStaticPages, resolveConfig };