boltdocs 2.4.1 → 2.5.0

package/dist/types-opDA2E9-.d.ts

@@ -1,394 +0,0 @@
-import React__default from 'react';
-import * as vite from 'vite';
-import { Plugin } 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 (can be translated) */
-    title?: string | Record<string, string>;
-    /** The global description of the site (can be translated) */
-    description?: string | Record<string, 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 (can be a string or a map of translations) */
-        label: string | Record<string, string>;
-        /** URL path or external link */
-        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 to display (can be a string or a map of translations) */
-        text: string | Record<string, 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 a specific locale.
- */
-interface BoltdocsLocaleConfig {
-    /** The display name of the locale */
-    label?: string;
-    /** The text direction (ltr or rtl) */
-    direction?: 'ltr' | 'rtl';
-    /** The HTML lang attribute value (e.g., 'en-US') */
-    htmlLang?: string;
-    /** The calendar system to use (e.g., 'gregory') */
-    calendar?: string;
-}
-/**
- * Configuration for internationalization (i18n).
- */
-interface BoltdocsI18nConfig {
-    /** The default locale (e.g., 'en') */
-    defaultLocale: string;
-    /** Available locales and their basic display names (e.g., { en: 'English', es: 'Español' }) */
-    locales: Record<string, string>;
-    /** Detailed configuration for each locale */
-    localeConfigs?: Record<string, BoltdocsLocaleConfig>;
-}
-/**
- * Configuration for a specific documentation version.
- */
-interface BoltdocsVersionConfig {
-    /** The display name of the version (e.g., 'v2.0') */
-    label: string;
-    /** The URL path prefix for the version (e.g., '2.0') */
-    path: string;
-}
-/**
- * Configuration for documentation versioning.
- */
-interface BoltdocsVersionsConfig {
-    /** The default version path (e.g., 'v2') */
-    defaultVersion: string;
-    /**
-     * Optional prefix for all version paths (e.g., 'v').
-     * If set to 'v', version '1.1' will be available at '/docs/v1.1'.
-     */
-    prefix?: string;
-    /** Available versions configurations */
-    versions: BoltdocsVersionConfig[];
-}
-/**
- * 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[];
-    /** External integrations configuration */
-    integrations?: BoltdocsIntegrationsConfig;
-    /** Configuration for the robots.txt file */
-    robots?: BoltdocsRobotsConfig;
-    /** Low-level Vite configuration overrides */
-    vite?: vite.InlineConfig;
-}
-
-/**
- * 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 page summary or description */
-    description?: 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 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: 'updated' | 'new' | 'deprecated';
-        expires?: string;
-    };
-    /** Optional icon for the route's group */
-    groupIcon?: string;
-    /** The extracted plain-text content of the page for search indexing */
-    _content?: string;
-    /** The raw markdown content of the page */
-    _rawContent?: string;
-}
-/**
- * Site configuration provided by the server.
- */
-type SiteConfig = BoltdocsConfig;
-/**
- * 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[];
-    /** The name of the documentation directory (e.g. 'docs') */
-    docsDirName: string;
-    /** Site configuration (`virtual:boltdocs-config`) */
-    config: SiteConfig;
-    /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
-    modules: Record<string, () => Promise<{
-        default: React__default.ComponentType<any>;
-    }>>;
-    /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
-    hot?: {
-        accept: (cb?: (mod: any) => void) => void;
-        dispose: (cb: (data: any) => void) => void;
-        on: (event: string, cb: (data: any) => void) => void;
-        data: any;
-    };
-    /** Optional custom React component to render when visiting the root path ('/') */
-    homePage?: React__default.ComponentType;
-    /** Custom external pages mapped by their route path */
-    externalPages?: Record<string, React__default.ComponentType>;
-    /** Optional custom layout for external pages */
-    externalLayout?: React__default.ComponentType<{
-        children: React__default.ReactNode;
-    }>;
-    /** Optional custom MDX components provided by plugins */
-    components?: Record<string, React__default.ComponentType>;
-}
-/**
- * Types for CodeSandbox integration.
- */
-interface SandboxFile {
-    content: string | object;
-    isBinary?: boolean;
-}
-type SandboxFiles = Record<string, SandboxFile>;
-interface SandboxOptions {
-    files?: SandboxFiles;
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-    title?: string;
-    description?: string;
-    template?: string;
-    /** The file path to open by default in the editor (e.g. `"src/App.tsx"`). */
-    entry?: string;
-    /** Options for the embedded iframe view, used by `embedSandbox()`. */
-    embed?: SandboxEmbedOptions;
-    /** Custom scripts for the package.json (e.g. `{ "start": "vite" }`). */
-    scripts?: Record<string, string>;
-    /** Optional default theme configuration for the sandbox project. */
-    themeConfig?: Record<string, unknown>;
-}
-interface SandboxEmbedOptions {
-    /** Which panel to display: `"editor"`, `"preview"`, or `"split"`. */
-    view?: 'editor' | 'preview' | 'split';
-    /** Color theme: `"dark"` or `"light"`. */
-    theme?: 'dark' | 'light';
-    /** Whether to hide the navigation bar in the embed. */
-    hideNavigation?: boolean;
-}
-/**
- * Tab configuration for the documentation site.
- */
-interface BoltdocsTab {
-    id: string;
-    /** Text to display (can be a string or a map of translations) */
-    text: string | Record<string, string>;
-    icon?: string;
-}
-/**
- * Props for the Sidebar component.
- */
-interface SidebarProps {
-    routes: ComponentRoute[];
-    config: BoltdocsConfig;
-}
-/**
- * Props for the OnThisPage (TOC) component.
- */
-interface OnThisPageProps {
-    headings?: {
-        level: number;
-        text: string;
-        id: string;
-    }[];
-    editLink?: string;
-    communityHelp?: string;
-    filePath?: string;
-}
-/**
- * Props for the Tabs component.
- */
-interface TabsProps {
-    tabs: BoltdocsTab[];
-    routes: ComponentRoute[];
-}
-/**
- * Props for user-defined layout components (layout.tsx).
- */
-interface LayoutProps {
-    children: React__default.ReactNode;
-}
-/**
- * Unified type for navbar links.
- */
-interface NavbarLink {
-    /** Label to display (can be a string or a map of translations) */
-    label: string | Record<string, string>;
-    href: string;
-    active: boolean;
-    /** Optional icon or string for external link indication */
-    to?: string;
-}
-
-export type { BoltdocsConfig as B, ComponentRoute as C, LayoutProps as L, NavbarLink as N, OnThisPageProps as O, SandboxEmbedOptions as S, TabsProps as T, BoltdocsTab as a, CreateBoltdocsAppOptions as b, BoltdocsThemeConfig as c, SandboxFile as d, SandboxFiles as e, SandboxOptions as f, BoltdocsSocialLink as g, SidebarProps as h, SiteConfig as i };

package/dist/use-routes-DNwgTRpU.d.ts

@@ -1,29 +0,0 @@
-import { C as ComponentRoute, B as BoltdocsConfig } from './types-opDA2E9-.js';
-
-/**
- * Hook to access the framework's routing state.
- * Returns both the complete set of routes and a filtered list based on the current
- * version and locale.
- */
-declare function useRoutes(): {
-    routes: ComponentRoute[];
-    allRoutes: ComponentRoute[];
-    currentRoute: ComponentRoute | undefined;
-    currentLocale: string | undefined;
-    currentLocaleLabel: string | undefined;
-    availableLocales: {
-        key: string;
-        label: string;
-        isCurrent: boolean;
-    }[];
-    currentVersion: string | undefined;
-    currentVersionLabel: string | undefined;
-    availableVersions: {
-        key: string;
-        label: string;
-        isCurrent: boolean;
-    }[];
-    config: BoltdocsConfig;
-};
-
-export { useRoutes as u };

package/dist/use-routes-DrT80Eom.d.mts

@@ -1,29 +0,0 @@
-import { C as ComponentRoute, B as BoltdocsConfig } from './types-opDA2E9-.mjs';
-
-/**
- * Hook to access the framework's routing state.
- * Returns both the complete set of routes and a filtered list based on the current
- * version and locale.
- */
-declare function useRoutes(): {
-    routes: ComponentRoute[];
-    allRoutes: ComponentRoute[];
-    currentRoute: ComponentRoute | undefined;
-    currentLocale: string | undefined;
-    currentLocaleLabel: string | undefined;
-    availableLocales: {
-        key: string;
-        label: string;
-        isCurrent: boolean;
-    }[];
-    currentVersion: string | undefined;
-    currentVersionLabel: string | undefined;
-    availableVersions: {
-        key: string;
-        label: string;
-        isCurrent: boolean;
-    }[];
-    config: BoltdocsConfig;
-};
-
-export { useRoutes as u };