boltdocs 1.0.4 → 1.3.1

package/src/node/utils.ts

@@ -1,134 +1,134 @@
-import fs from "fs";
-import matter from "gray-matter";
-
-/**
- * Normalizes a file path by replacing Windows backslashes with forward slashes.
- * Ensures consistent path handling across different operating systems.
- *
- * @param p - The file path to normalize
- * @returns The normalized path using forward slashes
- */
-export function normalizePath(p: string): string {
-  return p.replace(/\\/g, "/");
-}
-
-/**
- * Strips a numeric prefix from a file or directory name (e.g., '1.guide' -> 'guide').
- *
- * @param name - The name to strip
- * @returns The name without the numeric prefix
- */
-export function stripNumberPrefix(name: string): string {
-  return name.replace(/^\d+\./, "");
-}
-
-/**
- * Extracts the numeric prefix from a file or directory name if it exists.
- *
- * @param name - The name to parse
- * @returns The extracted number, or undefined if none exists
- */
-export function extractNumberPrefix(name: string): number | undefined {
-  const match = name.match(/^(\d+)\./);
-  return match ? parseInt(match[1], 10) : undefined;
-}
-
-/**
- * Checks if a given file path points to a Markdown or MDX file.
- *
- * @param filePath - The path to check
- * @returns True if the file ends with .md or .mdx, false otherwise
- */
-export function isDocFile(filePath: string): boolean {
-  return /\.mdx?$/.test(filePath);
-}
-
-/**
- * Retrieves the modification time (mtime) of a file in milliseconds.
- * Useful for caching strategies to detect if a file has changed.
- * Returns 0 if the file doesn't exist or cannot be accessed.
- *
- * @param filePath - The absolute path to the file
- * @returns The modification time in milliseconds, or 0 on error
- */
-export function getFileMtime(filePath: string): number {
-  try {
-    return fs.statSync(filePath).mtimeMs;
-  } catch {
-    return 0;
-  }
-}
-
-/**
- * Parses frontmatter and markdown content from a file synchronously.
- * Uses `gray-matter` for parsing. Returns the parsed data and the remaining markdown content.
- *
- * @param filePath - The absolute path to the markdown/mdx file
- * @returns An object containing the parsed metadata (`data`) and the raw markdown (`content`)
- */
-export function parseFrontmatter(filePath: string): {
-  data: Record<string, any>;
-  content: string;
-} {
-  const raw = fs.readFileSync(filePath, "utf-8");
-  const { data, content } = matter(raw);
-  return { data, content };
-}
-
-/**
- * Escapes special HTML characters in a string to prevent XSS and ensure
- * safe injection into HTML attributes or text content.
- *
- * @param str - The raw string to escape
- * @returns The escaped string
- */
-export function escapeHtml(str: string): string {
-  return str
-    .replace(/&/g, "&amp;")
-    .replace(/"/g, "&quot;")
-    .replace(/</g, "&lt;")
-    .replace(/>/g, "&gt;");
-}
-
-/**
- * Converts a file path relative to the `docsDir` into a URL route path.
- * Handles removing extensions, converting `index` files to directory roots,
- * and ensuring proper slash formatting.
- *
- * @param relativePath - The file path relative to the documentation source directory (e.g., 'guide/index.md')
- * @returns The corresponding route path (e.g., '/guide')
- */
-export function fileToRoutePath(relativePath: string): string {
-  // Strip number prefixes from every segment
-  let cleanedPath = relativePath.split("/").map(stripNumberPrefix).join("/");
-
-  let routePath = cleanedPath.replace(/\.mdx?$/, "");
-
-  // Handle index files → directory root
-  if (routePath === "index" || routePath.endsWith("/index")) {
-    routePath = routePath.replace(/index$/, "");
-  }
-
-  // Ensure leading slash
-  if (!routePath.startsWith("/")) {
-    routePath = "/" + routePath;
-  }
-
-  // Remove trailing slash (except for root '/')
-  if (routePath.length > 1 && routePath.endsWith("/")) {
-    routePath = routePath.slice(0, -1);
-  }
-
-  return routePath;
-}
-
-/**
- * Capitalizes the first letter of a given string.
- * Used primarily for generating default group titles.
- *
- * @param str - The string to capitalize
- * @returns The capitalized string
- */
-export function capitalize(str: string): string {
-  return str.charAt(0).toUpperCase() + str.slice(1);
-}
+import fs from "fs";
+import matter from "gray-matter";
+
+/**
+ * Normalizes a file path by replacing Windows backslashes with forward slashes.
+ * Ensures consistent path handling across different operating systems.
+ *
+ * @param p - The file path to normalize
+ * @returns The normalized path using forward slashes
+ */
+export function normalizePath(p: string): string {
+  return p.replace(/\\/g, "/");
+}
+
+/**
+ * Strips a numeric prefix from a file or directory name (e.g., '1.guide' -> 'guide').
+ *
+ * @param name - The name to strip
+ * @returns The name without the numeric prefix
+ */
+export function stripNumberPrefix(name: string): string {
+  return name.replace(/^\d+\./, "");
+}
+
+/**
+ * Extracts the numeric prefix from a file or directory name if it exists.
+ *
+ * @param name - The name to parse
+ * @returns The extracted number, or undefined if none exists
+ */
+export function extractNumberPrefix(name: string): number | undefined {
+  const match = name.match(/^(\d+)\./);
+  return match ? parseInt(match[1], 10) : undefined;
+}
+
+/**
+ * Checks if a given file path points to a Markdown or MDX file.
+ *
+ * @param filePath - The path to check
+ * @returns True if the file ends with .md or .mdx, false otherwise
+ */
+export function isDocFile(filePath: string): boolean {
+  return /\.mdx?$/.test(filePath);
+}
+
+/**
+ * Retrieves the modification time (mtime) of a file in milliseconds.
+ * Useful for caching strategies to detect if a file has changed.
+ * Returns 0 if the file doesn't exist or cannot be accessed.
+ *
+ * @param filePath - The absolute path to the file
+ * @returns The modification time in milliseconds, or 0 on error
+ */
+export function getFileMtime(filePath: string): number {
+  try {
+    return fs.statSync(filePath).mtimeMs;
+  } catch {
+    return 0;
+  }
+}
+
+/**
+ * Parses frontmatter and markdown content from a file synchronously.
+ * Uses `gray-matter` for parsing. Returns the parsed data and the remaining markdown content.
+ *
+ * @param filePath - The absolute path to the markdown/mdx file
+ * @returns An object containing the parsed metadata (`data`) and the raw markdown (`content`)
+ */
+export function parseFrontmatter(filePath: string): {
+  data: Record<string, any>;
+  content: string;
+} {
+  const raw = fs.readFileSync(filePath, "utf-8");
+  const { data, content } = matter(raw);
+  return { data, content };
+}
+
+/**
+ * Escapes special HTML characters in a string to prevent XSS and ensure
+ * safe injection into HTML attributes or text content.
+ *
+ * @param str - The raw string to escape
+ * @returns The escaped string
+ */
+export function escapeHtml(str: string): string {
+  return str
+    .replace(/&/g, "&amp;")
+    .replace(/"/g, "&quot;")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;");
+}
+
+/**
+ * Converts a file path relative to the `docsDir` into a URL route path.
+ * Handles removing extensions, converting `index` files to directory roots,
+ * and ensuring proper slash formatting.
+ *
+ * @param relativePath - The file path relative to the documentation source directory (e.g., 'guide/index.md')
+ * @returns The corresponding route path (e.g., '/guide')
+ */
+export function fileToRoutePath(relativePath: string): string {
+  // Strip number prefixes from every segment
+  let cleanedPath = relativePath.split("/").map(stripNumberPrefix).join("/");
+
+  let routePath = cleanedPath.replace(/\.mdx?$/, "");
+
+  // Handle index files → directory root
+  if (routePath === "index" || routePath.endsWith("/index")) {
+    routePath = routePath.replace(/index$/, "");
+  }
+
+  // Ensure leading slash
+  if (!routePath.startsWith("/")) {
+    routePath = "/" + routePath;
+  }
+
+  // Remove trailing slash (except for root '/')
+  if (routePath.length > 1 && routePath.endsWith("/")) {
+    routePath = routePath.slice(0, -1);
+  }
+
+  return routePath;
+}
+
+/**
+ * Capitalizes the first letter of a given string.
+ * Used primarily for generating default group titles.
+ *
+ * @param str - The string to capitalize
+ * @returns The capitalized string
+ */
+export function capitalize(str: string): string {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+}

package/tsconfig.json

@@ -1,21 +1,21 @@
-{
-    "compilerOptions": {
-        "target": "ES2022",
-        "module": "ESNext",
-        "moduleResolution": "Node",
-        "esModuleInterop": true,
-        "strict": true,
-        "skipLibCheck": true,
-        "jsx": "react-jsx",
-        "declaration": true,
-        "outDir": "dist"
-    },
-    "include": [
-        "src"
-    ],
-    "exclude": [
-        "node_modules",
-        "dist",
-        "src/node/cli"
-    ]
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "ESNext",
+        "moduleResolution": "Node",
+        "esModuleInterop": true,
+        "strict": true,
+        "skipLibCheck": true,
+        "jsx": "react-jsx",
+        "declaration": true,
+        "outDir": "dist"
+    },
+    "include": [
+        "src"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist",
+        "src/node/cli"
+    ]
 }

package/tsup.config.ts

@@ -1,22 +1,22 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  entry: [
-    "src/node/index.ts",
-    "src/node/cli/index.ts",
-    "src/client/index.ts",
-    "src/client/ssr.tsx",
-  ],
-  format: ["cjs", "esm"],
-  dts: true,
-  tsconfig: "./tsconfig.json",
-  clean: true,
-  external: [
-    "vite",
-    "react",
-    "react-dom",
-    "react-router-dom",
-    "virtual:boltdocs-routes",
-    "virtual:boltdocs-config",
-  ],
-});
+import { defineConfig } from "tsup";
+
+export default defineConfig({
+  entry: [
+    "src/node/index.ts",
+    "src/node/cli/index.ts",
+    "src/client/index.ts",
+    "src/client/ssr.tsx",
+  ],
+  format: ["cjs", "esm"],
+  dts: true,
+  tsconfig: "./tsconfig.json",
+  clean: true,
+  external: [
+    "vite",
+    "react",
+    "react-dom",
+    "react-router-dom",
+    "virtual:boltdocs-routes",
+    "virtual:boltdocs-config",
+  ],
+});

package/dist/Playground-B2FA34BC.mjs

@@ -1,6 +0,0 @@
-import {
-  Playground
-} from "./chunk-WPT4MWTQ.mjs";
-export {
-  Playground
-};

package/dist/chunk-WPT4MWTQ.mjs

@@ -1,89 +0,0 @@
-// src/client/theme/components/Playground/Playground.tsx
-import React, { useState } from "react";
-import { LiveProvider, LiveEditor, LiveError, LivePreview } from "react-live";
-import { Copy, Check, Terminal, Play } from "lucide-react";
-import { jsx, jsxs } from "react/jsx-runtime";
-function prepareCode(raw) {
-  const trimmed = raw.trim();
-  const fnMatch = trimmed.match(/export\s+default\s+function\s+(\w+)/);
-  if (fnMatch) {
-    const name = fnMatch[1];
-    const code = trimmed.replace(/export\s+default\s+/, "") + `
-
-render(<${name} />);`;
-    return { code, noInline: true };
-  }
-  const varMatch = trimmed.match(/export\s+default\s+(\w+)\s*;?\s*$/);
-  if (varMatch) {
-    const name = varMatch[1];
-    const code = trimmed.replace(/export\s+default\s+\w+\s*;?\s*$/, "") + `
-render(<${name} />);`;
-    return { code, noInline: true };
-  }
-  return { code: trimmed, noInline: false };
-}
-function Playground({
-  code,
-  children,
-  scope = {},
-  readonly = false,
-  noInline: forceNoInline
-}) {
-  let initialCode = code || "";
-  if (!initialCode && typeof children === "string") {
-    initialCode = children;
-  }
-  const prepared = prepareCode(initialCode);
-  const useNoInline = forceNoInline ?? prepared.noInline;
-  const [copied, setCopied] = useState(false);
-  const [activeCode, setActiveCode] = useState(prepared.code);
-  const handleCopy = () => {
-    navigator.clipboard.writeText(activeCode);
-    setCopied(true);
-    setTimeout(() => setCopied(false), 2e3);
-  };
-  const extendedScope = { React, ...scope };
-  return /* @__PURE__ */ jsx("div", { className: "boltdocs-playground", "data-readonly": readonly, children: /* @__PURE__ */ jsx(
-    LiveProvider,
-    {
-      code: activeCode,
-      scope: extendedScope,
-      theme: void 0,
-      noInline: useNoInline,
-      children: /* @__PURE__ */ jsxs("div", { className: "playground-split-container", children: [
-        /* @__PURE__ */ jsxs("div", { className: "playground-panel playground-editor-panel", children: [
-          /* @__PURE__ */ jsxs("div", { className: "playground-panel-header", children: [
-            /* @__PURE__ */ jsxs("div", { className: "playground-panel-title", children: [
-              /* @__PURE__ */ jsx(Terminal, { size: 14 }),
-              /* @__PURE__ */ jsx("span", { children: readonly ? "Code Example" : "Live Editor" })
-            ] }),
-            /* @__PURE__ */ jsx(
-              "button",
-              {
-                className: "playground-copy-btn",
-                onClick: handleCopy,
-                title: "Copy code",
-                children: copied ? /* @__PURE__ */ jsx(Check, { size: 14 }) : /* @__PURE__ */ jsx(Copy, { size: 14 })
-              }
-            )
-          ] }),
-          /* @__PURE__ */ jsx("div", { className: "playground-panel-content playground-editor", children: /* @__PURE__ */ jsx(LiveEditor, { disabled: readonly, onChange: setActiveCode }) })
-        ] }),
-        /* @__PURE__ */ jsxs("div", { className: "playground-panel playground-preview-panel", children: [
-          /* @__PURE__ */ jsx("div", { className: "playground-panel-header", children: /* @__PURE__ */ jsxs("div", { className: "playground-panel-title", children: [
-            /* @__PURE__ */ jsx(Play, { size: 14 }),
-            /* @__PURE__ */ jsx("span", { children: "Preview" })
-          ] }) }),
-          /* @__PURE__ */ jsxs("div", { className: "playground-panel-content playground-preview", children: [
-            /* @__PURE__ */ jsx(LivePreview, {}),
-            /* @__PURE__ */ jsx(LiveError, { className: "playground-error" })
-          ] })
-        ] })
-      ] })
-    }
-  ) });
-}
-
-export {
-  Playground
-};

package/src/client/theme/styles/home.css

@@ -1,60 +0,0 @@
-/* ═══════════════════════════════════════════════════════════
-   HOME / LANDING PAGE — Layout only
-   Component styles (badge, buttons, cards) now live in
-   mdx-components.css and use the shared UI components.
-   ═══════════════════════════════════════════════════════════ */
-.boltdocs-home {
-  min-height: calc(100vh - var(--ld-navbar-height));
-}
-
-.home-hero {
-  display: flex;
-  align-items: center;
-  justify-content: center;
-  padding: 6rem 2rem 4rem;
-  text-align: center;
-}
-
-.hero-content {
-  max-width: 680px;
-}
-
-.hero-title {
-  font-size: 3.5rem;
-  font-weight: 900;
-  line-height: 1.1;
-  margin: 0 0 1.25rem;
-  letter-spacing: -0.03em;
-  color: var(--ld-text-main);
-}
-
-.hero-highlight {
-  background: linear-gradient(
-    135deg,
-    var(--ld-gradient-from),
-    var(--ld-gradient-to)
-  );
-  -webkit-background-clip: text;
-  -webkit-text-fill-color: transparent;
-  background-clip: text;
-}
-
-.hero-description {
-  font-size: 1.125rem;
-  color: var(--ld-text-muted);
-  line-height: 1.7;
-  margin-bottom: 2rem;
-}
-
-.hero-actions {
-  display: flex;
-  gap: 0.75rem;
-  justify-content: center;
-  flex-wrap: wrap;
-}
-
-.home-features {
-  padding: 2rem 2rem 6rem;
-  max-width: 1000px;
-  margin: 0 auto;
-}