boltdocs 2.7.10 → 2.8.0

package/src/client/store/boltdocs-context.tsx

@@ -1,137 +0,0 @@
-import { createContext, use, useMemo, useState, useEffect } from 'react'
-
-const PREFERENCES_KEY = 'boltdocs-user-preferences'
-
-interface PersistedState {
-  locale?: string
-  version?: string
-}
-
-export interface BoltdocsState {
-  currentLocale: string
-  currentVersion: string
-  setLocale: (locale: string) => void
-  setVersion: (version: string) => void
-  hasHydrated: boolean
-  setHasHydrated: (hasHydrated: boolean) => void
-}
-
-const BOLTDOCS_CONTEXT_SYMBOL = Symbol.for('__BDOCS_BOLTDOCS_CONTEXT__')
-const BOLTDOCS_INSTANCE_SYMBOL = Symbol.for('__BDOCS_BOLTDOCS_INSTANCE__')
-
-const BoltdocsContext =
-  (globalThis as any)[BOLTDOCS_CONTEXT_SYMBOL] ||
-  ((globalThis as any)[BOLTDOCS_CONTEXT_SYMBOL] = createContext<
-    BoltdocsState | undefined
-  >(undefined))
-
-export function BoltdocsProvider({
-  children,
-  initialLocale = '',
-  initialVersion = '',
-}: {
-  children: React.ReactNode
-  initialLocale?: string
-  initialVersion?: string
-}) {
-  // Helper to read from storage safely
-  const getSavedPrefs = (): PersistedState => {
-    if (typeof window === 'undefined') return {}
-    try {
-      const raw = localStorage.getItem(PREFERENCES_KEY)
-      return raw ? JSON.parse(raw) : {}
-    } catch {
-      return {}
-    }
-  }
-
-  // 1. Lazy state initializers prioritize passed URL state, falling back to LocalStorage preference immediately
-  const [locale, setLocaleState] = useState(() => {
-    if (initialLocale) return initialLocale
-    const prefs = getSavedPrefs()
-    return prefs.locale || ''
-  })
-
-  const [version, setVersionState] = useState(() => {
-    if (initialVersion) return initialVersion
-    const prefs = getSavedPrefs()
-    return prefs.version || ''
-  })
-
-  const [hasHydrated, setHasHydrated] = useState(() => {
-    return typeof window !== 'undefined'
-  })
-
-  // Ensure the hydrator runs once client is definitely booted
-  useEffect(() => {
-    setHasHydrated(true)
-  }, [])
-
-  const value = useMemo(() => {
-    const updateLocale = (l: string) => {
-      const newL = l || ''
-      setLocaleState(newL)
-      if (typeof window !== 'undefined') {
-        try {
-          const prefs = getSavedPrefs()
-          localStorage.setItem(
-            PREFERENCES_KEY,
-            JSON.stringify({ ...prefs, locale: newL }),
-          )
-        } catch (e) {}
-      }
-    }
-
-    const updateVersion = (v: string) => {
-      const newV = v || ''
-      setVersionState(newV)
-      if (typeof window !== 'undefined') {
-        try {
-          const prefs = getSavedPrefs()
-          localStorage.setItem(
-            PREFERENCES_KEY,
-            JSON.stringify({ ...prefs, version: newV }),
-          )
-        } catch (e) {}
-      }
-    }
-
-    return {
-      currentLocale: locale,
-      currentVersion: version,
-      setLocale: updateLocale,
-      setVersion: updateVersion,
-      hasHydrated,
-      setHasHydrated,
-    }
-  }, [locale, version, hasHydrated])
-
-  // Sync with global registry for dual-package fallback
-  if (typeof globalThis !== 'undefined') {
-    ;(globalThis as any)[BOLTDOCS_INSTANCE_SYMBOL] = value
-  }
-
-  return (
-    <BoltdocsContext.Provider value={value}>
-      {children}
-    </BoltdocsContext.Provider>
-  )
-}
-
-export function useBoltdocsContext() {
-  const context = use(BoltdocsContext)
-
-  // Fallback to global registry if context is missing (dual-package hazard safety net)
-  if (
-    !context &&
-    typeof globalThis !== 'undefined' &&
-    (globalThis as any)[BOLTDOCS_INSTANCE_SYMBOL]
-  ) {
-    return (globalThis as any)[BOLTDOCS_INSTANCE_SYMBOL] as BoltdocsState
-  }
-
-  if (!context) {
-    throw new Error('useBoltdocsContext must be used within a BoltdocsProvider')
-  }
-  return context as BoltdocsState
-}

package/src/client/theme/neutral.css

@@ -1,141 +0,0 @@
-@theme {
-  --font-display: "Inter", "ui-sans-serif", "system-ui", sans-serif;
-  --font-sans: "Inter", "ui-sans-serif", "system-ui", sans-serif;
-  --font-mono:
-    "JetBrains Mono", "ui-monospace", "SFMono-Regular", Menlo, Monaco, Consolas,
-    "liberation mono", "courier new", monospace;
-
-  --breakpoint-3xl: 120rem;
-
-  /* Premium Terracotta brand Palette (#eb5828) */
-  --color-primary-50: #fef4f0;
-  --color-primary-100: #fde4da;
-  --color-primary-200: #fbc8b6;
-  --color-primary-300: #faa184;
-  --color-primary-400: #f6724a;
-  --color-primary-500: #eb5828;
-  /* Core brand Terracotta Orange */
-  --color-primary-600: #d34013;
-  --color-primary-700: #ab300c;
-  --color-primary-800: #842308;
-  --color-primary-900: #5a1503;
-
-  /* Intellectual warm Neutral Palette (#faf9f5 / #141413) */
-  --color-neutral-50: #faf9f5;
-  /* Elegant Light Background */
-  --color-neutral-100: #f5f4ee;
-  /* Soft backgrounds and cards */
-  --color-neutral-200: #eae8de;
-  /* Subtle border */
-  --color-neutral-300: #d9d6c7;
-  /* Strong border */
-  --color-neutral-400: #b5b19c;
-  --color-neutral-500: #8a8670;
-  /* Muted warm gray text */
-  --color-neutral-600: #706c57;
-  --color-neutral-700: #4a483a;
-  /* Paragraph text */
-  --color-neutral-800: #25241d;
-  --color-neutral-900: #141413;
-  /* Elegant Soft Black text / Dark mode main background */
-  --color-neutral-950: #080807;
-
-  /* Semantic Status Colors */
-  --color-danger-500: oklch(0.63 0.24 27);
-  --color-success-500: oklch(0.72 0.19 150);
-  --color-warning-500: oklch(0.78 0.17 75);
-  --color-info-500: oklch(0.62 0.19 260);
-
-  /* Modern Organic Rounded Radii (Warmer and More Rounded) */
-  --radius-sm: 0.375rem;
-  --radius-md: 0.5rem;
-  --radius-lg: 1rem;
-  /* 16px */
-  --radius-xl: 1.25rem;
-  /* 20px */
-  --radius-2xl: 1.5rem;
-  /* 24px */
-  --radius-full: 99999rem;
-
-  --ease-fluid: cubic-bezier(0.3, 0, 0, 1);
-  --ease-snappy: cubic-bezier(0.2, 0, 0, 1);
-
-  /* Semantic Colors - Default (Light Parchment) */
-  --color-main: var(--color-neutral-50);
-  --color-surface: #ffffff;
-  /* Pure soft white for cards */
-  --color-soft: var(--color-neutral-100);
-  --color-body: var(--color-neutral-900);
-  --color-paragraph: var(--color-neutral-700);
-  --color-muted: var(--color-neutral-500);
-  --color-dim: var(--color-neutral-400);
-  --color-subtle: var(--color-neutral-200);
-  --color-strong: var(--color-neutral-300);
-  --color-code-bg: var(--color-neutral-100);
-  --color-code-text: #eb5828;
-
-  /* Semantic Colors - Dark Override (handled via standard CSS overrides below the @theme block) */
-
-  /* Spacing and Dimensions */
-  --spacing-navbar: 3.5rem;
-  --spacing-sidebar: 16rem;
-  --spacing-toc: 16rem;
-  --spacing-content-max: 54rem;
-
-  @keyframes pulse {
-    0%,
-    100% {
-      opacity: 1;
-    }
-
-    50% {
-      opacity: 0.5;
-    }
-  }
-
-  @keyframes fade-in {
-    from {
-      opacity: 0;
-    }
-
-    to {
-      opacity: 1;
-    }
-  }
-}
-
-@variant dark 
-(
-&:where(.dark, .dark *));
-
-.animate-pulse {
-  animation: pulse 2s cubic-bezier(0.4, 0, 0.6, 1) infinite;
-}
-
-.animate-fade-in {
-  animation: fade-in 0.1s ease-out forwards;
-}
-
-:root[data-theme="dark"],
-:root.dark {
-  --color-main: #141413;
-  /* Deep warm charcoal background */
-  --color-surface: #1e1e1d;
-  /* Slightly lighter warm charcoal for cards */
-  --color-soft: #252524;
-  /* Warm dark gray for containers */
-  --color-body: #f3f3f2;
-  /* Soft warm white body text */
-  --color-paragraph: #d5d5d3;
-  /* Warm light gray text */
-  --color-muted: #9a9a97;
-  /* Warm muted text */
-  --color-dim: #767673;
-  --color-subtle: #2c2c2a;
-  /* Subtle dark border */
-  --color-strong: #3c3c39;
-  /* Strong dark border */
-  --color-code-bg: #1c1c1b;
-  --color-code-text: #eb5828;
-  /* Outstanding terracotta orange inline code */
-}

package/src/client/theme/reset.css

@@ -1,189 +0,0 @@
-@layer base {
-  *,
-  *::before,
-  *::after {
-    box-sizing: border-box;
-  }
-
-  html,
-  body {
-    margin: 0;
-    padding: 0;
-    min-height: 100%;
-    overflow-x: hidden;
-  }
-
-  body {
-    @apply bg-main text-body antialiased;
-    font-family: var(--font-sans);
-    line-height: 1.7;
-  }
-
-  a {
-    text-decoration: none;
-  }
-
-  /* Scroll-margin-top for anchor scrolling */
-  h1,
-  h2,
-  h3,
-  h4,
-  h5,
-  h6 {
-    scroll-margin-top: 6rem;
-  }
-
-  /* Scrollbar */
-  ::-webkit-scrollbar {
-    width: 6px;
-    height: 6px;
-  }
-
-  ::-webkit-scrollbar-track {
-    background: transparent;
-  }
-
-  ::-webkit-scrollbar-thumb {
-    background-color: var(--color-strong);
-    border-radius: 9999px;
-  }
-
-  ::-webkit-scrollbar-thumb:hover {
-    background-color: var(--color-muted);
-  }
-
-  /* ═══ Content Area ═══ */
-  .boltdocs-content {
-    scrollbar-width: none;
-  }
-
-  .boltdocs-content::-webkit-scrollbar {
-    display: none;
-  }
-
-  /* ═══ MDX Page - Mobile Text Overflow Prevention ═══ */
-  .boltdocs-page {
-    overflow-wrap: break-word;
-    word-break: break-word;
-  }
-
-  /* Inline code inside prose shouldn't force horizontal overflow */
-  .boltdocs-page :not(pre) > code {
-    word-break: break-all;
-  }
-
-  .scrollbar-hide {
-    scrollbar-width: none;
-    -ms-overflow-style: none;
-  }
-
-  .scrollbar-hide::-webkit-scrollbar {
-    display: none;
-  }
-
-  /* Hide native search cancel button */
-  input::-webkit-search-cancel-button,
-  input::-webkit-search-decoration,
-  input::-webkit-search-results-button,
-  input::-webkit-search-results-decoration {
-    display: none;
-  }
-
-  /* Shiki Styles are defined below */
-
-  /* ═══ Shiki Styles ═══ */
-
-  /* Shiki Light/Dark Mode */
-  :root .shiki,
-  :root .shiki span {
-    font-family: var(--font-mono);
-    font-size: 12px !important;
-    background-color: transparent !important;
-  }
-
-  :root.dark .shiki,
-  :root.dark .shiki span {
-    color: var(--shiki-dark) !important;
-  }
-
-  /* Base Shiki Pre & Span Styles */
-  pre.shiki {
-    @apply py-2 text-[12px] leading-[1.6];
-    overflow-x: auto;
-    -webkit-overflow-scrolling: touch;
-  }
-
-  pre.shiki span.line {
-    @apply relative block px-4 py-0;
-    min-height: 1.6em;
-  }
-
-  /* Shiki Word Wrap */
-  pre.shiki-word-wrap {
-    @apply whitespace-pre-wrap break-words;
-  }
-
-  pre.shiki-word-wrap span.line {
-    @apply block w-full;
-  }
-
-  /* Shiki Line Numbers */
-  pre.shiki-line-numbers code {
-    counter-reset: step;
-    counter-increment: step 0;
-  }
-
-  pre.shiki-line-numbers .line {
-    @apply !pl-12;
-  }
-
-  /* Hide the last line if it is completely empty to avoid extra numbers or spacing */
-  pre.shiki .line:last-child:empty,
-  pre.shiki .line:last-child:has(> :empty),
-  pre.shiki-line-numbers .line:last-child:empty,
-  pre.shiki-line-numbers .line:last-child:has(> :empty) {
-    display: none;
-  }
-
-  pre.shiki-line-numbers .line::before {
-    counter-increment: step;
-    content: counter(step);
-    @apply absolute left-0 top-0 inline-flex w-10 justify-end pr-3;
-    @apply text-[11px] text-muted opacity-30 select-none;
-    line-height: inherit;
-    /* Sync with line text */
-  }
-
-  /* Shiki Highlight */
-  pre span.shiki-line-highlight {
-    @apply relative z-0 inline-block w-full;
-
-    &::after {
-      content: "";
-      @apply absolute top-0 left-0 -z-10 h-full w-full border-l-2 border-primary-500 !bg-primary-500/10 opacity-100;
-    }
-  }
-
-  /* Shiki Notation Diff */
-  pre.has-diff span.line.diff {
-    @apply relative inline-block w-full;
-  }
-
-  pre.has-diff span.line.diff.add {
-    @apply !bg-emerald-500/10 dark:!bg-emerald-500/10;
-
-    &::before {
-      content: "+";
-      @apply absolute left-2 text-emerald-500 font-bold;
-    }
-  }
-
-  pre.has-diff span.line.diff.remove {
-    @apply !bg-danger-500/10 opacity-70;
-
-    &::before {
-      content: "-";
-      @apply absolute left-2 text-danger-500 font-bold;
-    }
-  }
-}

package/src/client/types.ts

@@ -1,116 +0,0 @@
-import type * as React from 'react'
-export type { BoltdocsConfig } from '../shared/types'
-
-/**
- * Metadata provided by the server for a specific route.
- * Maps closely to the `RouteMeta` type in the Node environment.
- */
-export 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 sub-route group this route belongs to (from folders starting with _) */
-  subRouteGroup?: string
-  /** The nested sub-routes if this route acts as the parent of a subRouteGroup */
-  subRoutes?: ComponentRoute[]
-  /** The extracted plain-text content of the page for search indexing */
-  _content?: string
-  /** The raw markdown content of the page */
-  _rawContent?: string
-  /** The publication date */
-  date?: string | Date
-  /** The last updated timestamp or date */
-  lastUpdated?: string | number | Date
-  /** Raw extensible frontmatter data for custom components and formatters */
-  frontmatter?: Record<string, any>
-  /** Clean URL segments stripped of locale/version prefixes */
-  slugParts?: string[]
-}
-
-/**
- * Site configuration provided by the server.
- */
-export type SiteConfig = BoltdocsConfig
-
-/**
- * Tab configuration for the documentation site.
- */
-export 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.
- */
-export interface SidebarProps {
-  routes: ComponentRoute[]
-  config: BoltdocsConfig
-}
-
-/**
- * Props for the OnThisPage (TOC) component.
- */
-export interface OnThisPageProps {
-  headings?: { level: number; text: string; id: string }[]
-  editLink?: string
-  communityHelp?: string
-  filePath?: string
-}
-
-/**
- * Props for the Tabs component.
- */
-export interface TabsProps {
-  tabs: BoltdocsTab[]
-  routes: ComponentRoute[]
-}
-
-/**
- * Props for user-defined layout components (layout.tsx).
- */
-export interface LayoutProps {
-  children: React.ReactNode
-}
-
-/**
- * Unified type for navbar links.
- */
-export interface NavbarLink {
-  label: string | Record<string, string>
-  href: string
-  active: boolean
-  to?: string
-  items?: NavbarLink[]
-}

package/src/client/utils/cn.ts

@@ -1,6 +0,0 @@
-import { type ClassValue, clsx } from 'clsx'
-import { twMerge } from 'tailwind-merge'
-
-export function cn(...inputs: ClassValue[]) {
-  return twMerge(clsx(inputs))
-}

package/src/client/utils/copy-clipboard.ts

@@ -1,22 +0,0 @@
-/**
- * Copy text to clipboard.
- * @param text - The text to copy.
- * @returns True if the text was copied successfully.
- */
-export const copyToClipboard = async (text: string) => {
-  try {
-    await navigator.clipboard.writeText(text)
-    return true
-  } catch {
-    // Fallback
-    const textarea = document.createElement('textarea')
-    textarea.value = text
-    textarea.style.position = 'fixed'
-    textarea.style.opacity = '0'
-    document.body.appendChild(textarea)
-    textarea.select()
-    document.execCommand('copy')
-    document.body.removeChild(textarea)
-    return true
-  }
-}

package/src/client/utils/get-base-file-path.ts

@@ -1,21 +0,0 @@
-/**
- * Get the base file path by removing version and locale prefixes.
- * @param filePath - The full file path.
- * @param version - The version to remove from the path.
- * @param locale - The locale to remove from the path.
- * @returns The base file path.
- */
-export function getBaseFilePath(
-  filePath: string,
-  version: string | undefined,
-  locale: string | undefined,
-): string {
-  let path = filePath
-  if (version && (path === version || path.startsWith(version + '/'))) {
-    path = path === version ? 'index.md' : path.slice(version.length + 1)
-  }
-  if (locale && (path === locale || path.startsWith(locale + '/'))) {
-    path = path === locale ? 'index.md' : path.slice(locale.length + 1)
-  }
-  return path
-}