boltdocs 1.0.0

package/dist/node/cli/index.mjs

@@ -0,0 +1,154 @@
+#!/usr/bin/env node
+import {
+  init_config,
+  resolveConfig
+} from "../../chunk-X2TDGMTR.mjs";
+import {
+  __commonJS,
+  __esm
+} from "../../chunk-X6BYQHVC.mjs";
+
+// src/node/cli/commands/config.ts
+import path from "path";
+async function configAction(root) {
+  const rootDir = root ? path.resolve(root) : process.cwd();
+  const docsDir = path.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);
+  }
+}
+var init_config2 = __esm({
+  "src/node/cli/commands/config.ts"() {
+    "use strict";
+    init_config();
+  }
+});
+
+// src/node/cli/constants.ts
+var DEFAULT_CSS_VARIABLES;
+var init_constants = __esm({
+  "src/node/cli/constants.ts"() {
+    "use strict";
+    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
+import path2 from "path";
+import fs from "fs";
+function generateCssAction(outputPath) {
+  try {
+    const target = process.cwd();
+    const filename = outputPath || "custom.css";
+    const filepath = path2.resolve(target, filename);
+    if (fs.existsSync(filepath)) {
+      process.stderr.write(
+        "Error: File " + filename + " already exists in " + target + ".\n"
+      );
+      process.exit(1);
+    }
+    fs.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);
+  }
+}
+var init_generate_css = __esm({
+  "src/node/cli/commands/generate-css.ts"() {
+    "use strict";
+    init_constants();
+  }
+});
+
+// src/node/cli/index.ts
+import cac from "cac";
+var require_cli = __commonJS({
+  "src/node/cli/index.ts"() {
+    init_config2();
+    init_generate_css();
+    var cli = cac("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();
+  }
+});
+export default require_cli();

package/dist/node/index.d.mts

@@ -0,0 +1,79 @@
+import { Plugin } from 'vite';
+import { B as BoltdocsConfig } from '../config-D2XmHJYe.mjs';
+export { a as BoltdocsThemeConfig } from '../config-D2XmHJYe.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 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;
+    /** 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;
+    };
+}
+
+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

@@ -0,0 +1,79 @@
+import { Plugin } from 'vite';
+import { B as BoltdocsConfig } from '../config-D2XmHJYe.js';
+export { a as BoltdocsThemeConfig } from '../config-D2XmHJYe.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 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;
+    /** 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;
+    };
+}
+
+declare function boltdocs(options?: BoltdocsPluginOptions): Promise<Plugin[]>;
+
+export { BoltdocsConfig, type BoltdocsPluginOptions, type RouteMeta, type SSGOptions, boltdocs as default, generateStaticPages };