npm - boltdocs - Versions diffs - 2.6.1 → 2.7.0 - Mend

boltdocs 2.6.1 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (177) hide show

package/bin/boltdocs.js +0 -1
package/dist/cache-CQKlT4fI.mjs +6 -0
package/dist/cache-DorPMFgW.cjs +6 -0
package/dist/cards-BLoSiRuL.d.ts +30 -0
package/dist/cards-CQn9mXZS.d.cts +30 -0
package/dist/chunk-Ds5LZdWN.cjs +6 -0
package/dist/client/index.cjs +1 -1
package/dist/client/index.d.cts +173 -1328
package/dist/client/index.d.ts +172 -1327
package/dist/client/index.js +1 -1
package/dist/{package-c99Cs7mD.cjs → client/mdx.cjs} +1 -1
package/dist/client/mdx.d.cts +128 -0
package/dist/client/mdx.d.ts +129 -0
package/dist/client/mdx.js +6 -0
package/dist/client/primitives.cjs +6 -0
package/dist/client/primitives.d.cts +818 -0
package/dist/client/primitives.d.ts +818 -0
package/dist/client/primitives.js +6 -0
package/dist/client/theme/neutral.css +74 -361
package/dist/client/theme/reset.css +189 -0
package/dist/docs-layout-BlDhcQRv.cjs +6 -0
package/dist/docs-layout-BvAOWEJw.js +6 -0
package/dist/doctor-BQiQhCTl.cjs +6 -0
package/dist/doctor-COpf35L2.cjs +20 -0
package/dist/doctor-Dh1XP7Pz.mjs +20 -0
package/dist/generator-DGW6pkCC.cjs +22 -0
package/dist/generator-Dv3wEmhZ.mjs +22 -0
package/dist/icons-dev-CrQLjoQp.js +6 -0
package/dist/icons-dev-rzdz6Lf3.cjs +6 -0
package/dist/image-BkIfa9oo.js +6 -0
package/dist/image-DIGjCPe6.cjs +6 -0
package/dist/mdx-K0WYBAJ3.js +7 -0
package/dist/mdx-hpErbRUe.cjs +7 -0
package/dist/meta-loader-0gJ4PtBC.cjs +6 -0
package/dist/meta-loader-9IpAHWDS.mjs +6 -0
package/dist/node/cli-entry.cjs +1 -2
package/dist/node/cli-entry.mjs +1 -2
package/dist/node/index.cjs +1 -1
package/dist/node/index.d.cts +66 -13
package/dist/node/index.d.mts +66 -14
package/dist/node/index.mjs +1 -1
package/dist/node/routes/worker.cjs +6 -0
package/dist/node/routes/worker.d.cts +2 -0
package/dist/node/routes/worker.d.mts +2 -0
package/dist/node/routes/worker.mjs +6 -0
package/dist/node-C2nWXElP.mjs +112 -0
package/dist/node-CinkUtxV.cjs +112 -0
package/dist/package-BMYLDBBP.cjs +6 -0
package/dist/{package-DukYeKmD.mjs → package-HegMOTL_.mjs} +1 -1
package/dist/parser-Bh11BsdA.cjs +6 -0
package/dist/parser-D8eQvE7N.mjs +6 -0
package/dist/parser-DYRzXWmA.cjs +6 -0
package/dist/routes-CHf76Ye4.cjs +6 -0
package/dist/routes-CMUZGI6T.mjs +6 -0
package/dist/routes-Co1mRM58.cjs +6 -0
package/dist/search-dialog-BACuzoVX.cjs +6 -0
package/dist/search-dialog-BKagVT17.js +6 -0
package/dist/search-dialog-C8w12eUx.js +6 -0
package/dist/search-dialog-CGyrozZE.cjs +6 -0
package/dist/search-dialog-D26rUnJ_.cjs +6 -0
package/dist/sidebar-DKvg6KOc.d.cts +491 -0
package/dist/sidebar-Dr1TiRIy.d.ts +491 -0
package/dist/utils-BxNAXhZZ.mjs +7 -0
package/dist/utils-Clzu7jvb.cjs +7 -0
package/dist/worker-pool-Bd8Y9KDv.mjs +6 -0
package/dist/worker-pool-BwU8ckrg.cjs +6 -0
package/package.json +27 -8
package/src/client/app/doc-page.tsx +9 -5
package/src/client/app/docs-layout.tsx +17 -3
package/src/client/app/head.tsx +122 -0
package/src/client/app/helmet-compat.tsx +36 -0
package/src/client/app/mdx-component.tsx +5 -52
package/src/client/app/mdx-components-context.tsx +32 -8
package/src/client/app/routes-context.tsx +2 -2
package/src/client/app/scroll-handler.tsx +1 -1
package/src/client/app/theme-context.tsx +5 -5
package/src/client/app/ui-context.tsx +42 -0
package/src/client/components/docs-layout-default.tsx +85 -0
package/src/client/components/icons-dev.tsx +38 -15
package/src/client/components/mdx/callout.tsx +97 -0
package/src/client/components/mdx/card.tsx +73 -98
package/src/client/components/mdx/cards.tsx +27 -0
package/src/client/components/mdx/code-block.tsx +37 -17
package/src/client/components/mdx/field.tsx +24 -56
package/src/client/components/mdx/image.tsx +36 -15
package/src/client/components/mdx/index.ts +19 -53
package/src/client/components/mdx/table.tsx +46 -148
package/src/client/components/mdx/typographics.tsx +120 -0
package/src/client/components/mdx/{hooks/use-code-block.ts → use-code-block.ts} +5 -7
package/src/client/components/primitives/breadcrumbs.tsx +5 -24
package/src/client/components/primitives/button.tsx +3 -142
package/src/client/components/primitives/code-block.tsx +104 -97
package/src/client/components/{docs-layout.tsx → primitives/docs-layout.tsx} +15 -24
package/src/client/components/primitives/error-boundary.tsx +107 -0
package/src/client/components/primitives/heading.tsx +128 -0
package/src/client/components/primitives/helpers/observer.ts +62 -32
package/src/client/components/primitives/image.tsx +26 -0
package/src/client/components/primitives/link.tsx +50 -52
package/src/client/components/primitives/menu.tsx +25 -49
package/src/client/components/primitives/navbar.tsx +234 -59
package/src/client/components/primitives/on-this-page.tsx +169 -40
package/src/client/components/primitives/page-nav.tsx +11 -39
package/src/client/components/primitives/popover.tsx +12 -30
package/src/client/components/primitives/search-dialog.tsx +77 -71
package/src/client/components/primitives/sidebar.tsx +312 -119
package/src/client/components/primitives/skeleton.tsx +1 -1
package/src/client/components/primitives/tabs.tsx +5 -16
package/src/client/components/primitives/tooltip.tsx +1 -1
package/src/client/components/ui-base/banner.tsx +66 -0
package/src/client/components/ui-base/breadcrumbs.tsx +26 -20
package/src/client/components/ui-base/copy-markdown.tsx +43 -35
package/src/client/components/ui-base/error-boundary.tsx +9 -46
package/src/client/components/ui-base/github-stars.tsx +5 -3
package/src/client/components/ui-base/index.ts +3 -3
package/src/client/components/ui-base/last-updated.tsx +27 -0
package/src/client/components/ui-base/navbar.tsx +183 -89
package/src/client/components/ui-base/not-found.tsx +11 -9
package/src/client/components/ui-base/on-this-page.tsx +8 -104
package/src/client/components/ui-base/page-nav.tsx +23 -9
package/src/client/components/ui-base/search-dialog.tsx +111 -36
package/src/client/components/ui-base/search-highlight.tsx +10 -0
package/src/client/components/ui-base/sidebar.tsx +77 -154
package/src/client/components/ui-base/tabs.tsx +20 -7
package/src/client/components/ui-base/theme-toggle.tsx +88 -10
package/src/client/components/ui-base/version-i18n.tsx +80 -0
package/src/client/hooks/index.ts +2 -1
package/src/client/hooks/use-analytics.ts +272 -0
package/src/client/hooks/use-i18n.ts +120 -53
package/src/client/hooks/use-localized-to.ts +70 -30
package/src/client/hooks/use-navbar.ts +69 -39
package/src/client/hooks/use-page-nav.ts +28 -25
package/src/client/hooks/use-routes.ts +64 -81
package/src/client/hooks/use-search-highlight.ts +185 -0
package/src/client/hooks/use-search.ts +12 -3
package/src/client/hooks/use-sidebar.ts +183 -77
package/src/client/hooks/use-tabs.ts +3 -4
package/src/client/hooks/use-version.ts +46 -18
package/src/client/index.ts +13 -86
package/src/client/mdx.ts +2 -0
package/src/client/primitives.ts +19 -0
package/src/client/ssg/boltdocs-shell.tsx +78 -57
package/src/client/ssg/create-routes.tsx +290 -50
package/src/client/ssg/mdx-page.tsx +2 -1
package/src/client/store/boltdocs-context.tsx +83 -12
package/src/client/theme/neutral.css +74 -361
package/src/client/theme/reset.css +189 -0
package/src/client/types.ts +10 -2
package/src/client/utils/path.ts +9 -0
package/src/client/utils/react-to-text.ts +24 -24
package/src/client/virtual.d.ts +1 -1
package/src/shared/types.ts +97 -21
package/dist/node-CWN8U_p8.mjs +0 -88
package/dist/node-D5iosYXv.cjs +0 -88
package/dist/search-dialog-3lvKsbVG.js +0 -6
package/dist/search-dialog-DMK5OpgH.cjs +0 -6
package/dist/use-search-C9bxCqfF.js +0 -6
package/dist/use-search-DcfZSunO.cjs +0 -6
package/src/client/components/mdx/admonition.tsx +0 -91
package/src/client/components/mdx/badge.tsx +0 -41
package/src/client/components/mdx/button.tsx +0 -35
package/src/client/components/mdx/component-preview.tsx +0 -37
package/src/client/components/mdx/component-props.tsx +0 -83
package/src/client/components/mdx/file-tree.tsx +0 -325
package/src/client/components/mdx/hooks/use-component-preview.ts +0 -16
package/src/client/components/mdx/hooks/useTable.ts +0 -74
package/src/client/components/mdx/hooks/useTabs.ts +0 -68
package/src/client/components/mdx/link.tsx +0 -38
package/src/client/components/mdx/list.tsx +0 -192
package/src/client/components/mdx/tabs.tsx +0 -135
package/src/client/components/mdx/video.tsx +0 -68
package/src/client/components/primitives/index.ts +0 -19
package/src/client/components/primitives/navigation-menu.tsx +0 -114
package/src/client/components/ui-base/head.tsx +0 -76
package/src/client/components/ui-base/loading.tsx +0 -57
package/src/client/components/ui-base/powered-by.tsx +0 -25
package/src/client/hooks/use-onthispage.ts +0 -23
package/src/client/utils/use-on-change.ts +0 -15

package/src/client/app/docs-layout.tsx CHANGED Viewed

@@ -1,14 +1,28 @@
 import { Outlet } from 'react-router-dom'
 import UserLayout from 'virtual:boltdocs-layout'
+import { useRoutes } from '../hooks/use-routes'
+import { useConfig } from './config-context'
+import { Head } from './head'
 /**
  * Wraps the docs Outlet with the user's (or default) layout component.
  * The Layout receives the routed page as `children`.
+ * We use useRoutes to pass the current route context to the persistent layout.
  */
 export function DocsLayout() {
+  const config = useConfig()
+  const { currentRoute, allRoutes } = useRoutes()
   return (
-    <UserLayout>
-      <Outlet />
-    </UserLayout>
+    <>
+      <Head
+        siteTitle={config.theme?.title}
+        siteDescription={config.theme?.description}
+        routes={allRoutes || []}
+      />
+      <UserLayout route={currentRoute}>
+        <Outlet />
+      </UserLayout>
+    </>
   )
 }

package/src/client/app/head.tsx ADDED Viewed

@@ -0,0 +1,122 @@
+import { useMemo } from 'react'
+import { useLocation } from 'react-router-dom'
+import { Helmet } from './helmet-compat'
+import { useConfig } from './config-context'
+import { getTranslated } from '../utils/i18n'
+import { useRoutes } from '../hooks/use-routes'
+interface HeadProps {
+  siteTitle?: string | Record<string, string>
+  siteDescription?: string | Record<string, string>
+  routes: Array<{
+    path: string
+    title: string
+    description?: string
+    seo?: Record<string, unknown>
+  }>
+}
+export function Head({ siteTitle, siteDescription, routes }: HeadProps) {
+  const location = useLocation()
+  const config = useConfig()
+  const { currentLocale } = useRoutes()
+  // Find the current route's metadata — memoized so the O(n) search only
+  // re-runs when the routes array or the current URL changes, not on every render.
+  const currentRoute = useMemo(
+    () => routes?.find?.((r) => r.path === location.pathname),
+    [routes, location.pathname],
+  )
+  const pageTitle = currentRoute?.title
+  const translatedSiteDescription = getTranslated(
+    siteDescription,
+    currentLocale,
+  )
+  const pageDescription =
+    currentRoute?.description || translatedSiteDescription || ''
+  const translatedSiteTitle = getTranslated(siteTitle, currentLocale)
+  const finalTitle = pageTitle
+    ? `${pageTitle} | ${translatedSiteTitle}`
+    : translatedSiteTitle
+  const seo = currentRoute?.seo || {}
+  // Merge custom global metatags
+  const globalMetatags = config?.seo?.metatags || {}
+  // Calculate specific ones
+  const defaultOgImage = config?.seo?.thumbnails?.background
+  const ogImage = (seo['og:image'] || defaultOgImage) as string | undefined
+  return (
+    <Helmet>
+      <title>{finalTitle}</title>
+      <meta name="description" content={pageDescription} />
+      {/* Default OG Tags */}
+      <meta property="og:title" content={finalTitle} />
+      <meta property="og:description" content={pageDescription} />
+      <meta property="og:type" content="article" />
+      {/* Canonical URL for both <link> and og:url */}
+      {typeof window !== 'undefined' && (
+        <meta property="og:url" content={window.location.href} />
+      )}
+      {typeof window !== 'undefined' && (
+        <link
+          rel="canonical"
+          href={window.location.origin + location.pathname}
+        />
+      )}
+      {/* Default Twitter Card */}
+      <meta name="twitter:card" content="summary" />
+      <meta name="twitter:title" content={finalTitle} />
+      <meta name="twitter:description" content={pageDescription} />
+      {ogImage && <meta name="twitter:image" content={ogImage} />}
+      {ogImage && <meta property="og:image" content={ogImage} />}
+      {/* Generator */}
+      <meta name="generator" content="Boltdocs" />
+      {/* User-defined global metatags */}
+      {Object.entries(globalMetatags).map(([key, value]) => {
+        const isProperty =
+          key.startsWith('og:') ||
+          key.startsWith('music:') ||
+          key.startsWith('video:') ||
+          key.startsWith('article:') ||
+          key.startsWith('book:') ||
+          key.startsWith('profile:')
+        return isProperty ? (
+          <meta key={key} property={key} content={value as string} />
+        ) : (
+          <meta key={key} name={key} content={value as string} />
+        )
+      })}
+      {/* Page granular SEO tags (override global) */}
+      {Object.entries(seo).map(([key, value]) => {
+        if (key === 'noindex' && value === true)
+          return <meta key="noindex" name="robots" content="noindex" />
+        if (key === 'robots')
+          return <meta key="robots" name="robots" content={value as string} />
+        if (key === 'canonical')
+          return <link key="canonical" rel="canonical" href={value as string} />
+        const isProperty =
+          key.startsWith('og:') ||
+          key.startsWith('music:') ||
+          key.startsWith('video:') ||
+          key.startsWith('article:') ||
+          key.startsWith('book:') ||
+          key.startsWith('profile:')
+        return isProperty ? (
+          <meta key={key} property={key} content={value as string} />
+        ) : (
+          <meta key={key} name={key} content={value as string} />
+        )
+      })}
+    </Helmet>
+  )
+}

package/src/client/app/helmet-compat.tsx ADDED Viewed

@@ -0,0 +1,36 @@
+/**
+ * Shared Helmet module compatibility helpers.
+ *
+ * react-helmet-async ships different module shapes depending on whether it is
+ * loaded via CJS or ESM. Instead of duplicating the same detection logic in
+ * every component that needs Helmet/HelmetProvider, we centralise it here.
+ */
+import type { ComponentType, ReactNode } from 'react'
+import * as ReactHelmetAsync from 'react-helmet-async'
+type HelmetModule = {
+  Helmet?: ComponentType<{ children?: ReactNode }>
+  HelmetProvider?: ComponentType<{ children?: ReactNode }>
+  default?: {
+    Helmet?: ComponentType<{ children?: ReactNode }>
+    HelmetProvider?: ComponentType<{ children?: ReactNode }>
+  }
+}
+const mod = ReactHelmetAsync as unknown as HelmetModule
+/**
+ * The `<Helmet>` component, resolved across CJS/ESM module shapes.
+ * Falls back to a transparent fragment wrapper if the module cannot be resolved.
+ */
+export const Helmet: ComponentType<{ children?: ReactNode }> =
+  mod.Helmet || mod.default?.Helmet || (({ children }) => <>{children}</>)
+/**
+ * The `<HelmetProvider>` component, resolved across CJS/ESM module shapes.
+ * Falls back to a transparent fragment wrapper if the module cannot be resolved.
+ */
+export const HelmetProvider: ComponentType<{ children?: ReactNode }> =
+  mod.HelmetProvider ||
+  mod.default?.HelmetProvider ||
+  (({ children }) => <>{children}</>)

package/src/client/app/mdx-component.tsx CHANGED Viewed

@@ -1,55 +1,8 @@
-import { Link as LucideLink } from 'lucide-react'
-import * as MdxComponents from '../components/mdx'
-const Heading = ({
-  level,
-  id,
-  children,
-  ...props
-}: {
-  level: number
-  id?: string
-  children?: React.ReactNode
-} & React.HTMLAttributes<HTMLHeadingElement>) => {
-  const Tag = `h${level}` as any
-  return (
-    <Tag id={id} {...props} className="boltdocs-heading">
-      {children}
-      {id && (
-        <a href={`#${id}`} className="header-anchor" aria-label="Anchor">
-          <LucideLink size={16} />
-        </a>
-      )}
-    </Tag>
-  )
-}
-import { Loading } from '../components/ui-base/loading'
+import { NotFound } from '../components/ui-base/not-found'
+import { mdx_components_default } from '../components/mdx'
 export const mdxComponentsDefault = {
-  ...MdxComponents,
-  Loading,
-  h1: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
-    <Heading level={1} {...props} />
-  ),
-  h2: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
-    <Heading level={2} {...props} />
-  ),
-  h3: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
-    <Heading level={3} {...props} />
-  ),
-  h4: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
-    <Heading level={4} {...props} />
-  ),
-  h5: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
-    <Heading level={5} {...props} />
-  ),
-  h6: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
-    <Heading level={6} {...props} />
-  ),
-  pre: (props: React.HTMLAttributes<HTMLPreElement>) => (
-    <MdxComponents.CodeBlock {...props}>
-      {props.children}
-    </MdxComponents.CodeBlock>
-  ),
+  ...mdx_components_default,
+  NotFound,
+  '404': NotFound,
 }

package/src/client/app/mdx-components-context.tsx CHANGED Viewed

@@ -1,6 +1,11 @@
-import { createContext, use } from 'react'
+import { createContext, use, useMemo } from 'react'
+import type { BoltdocsMdxComponents } from '../../shared/types'
-export type MdxComponentsType = Record<string, React.ComponentType<any>>
+export type MdxComponentsType = {
+  [key: string]: React.ComponentType<any>
+} & {
+  Frontmatter?: Record<string, React.ComponentType<any>>
+}
 const MDX_COMPONENTS_CONTEXT_SYMBOL = Symbol.for(
   '__BDOCS_MDX_COMPONENTS_CONTEXT__',
@@ -14,7 +19,7 @@ const MdxComponentsContext =
   ((globalThis as any)[MDX_COMPONENTS_CONTEXT_SYMBOL] =
     createContext<MdxComponentsType>({}))
-export function useMdxComponents() {
+export function useMdxComponents(): BoltdocsMdxComponents {
   const context = use(MdxComponentsContext)
   // Fallback to global registry for dual-package hazards
@@ -22,26 +27,45 @@ export function useMdxComponents() {
     (!context || Object.keys(context).length === 0) &&
     (globalThis as any)[MDX_COMPONENTS_INSTANCE_SYMBOL]
   ) {
-    return (globalThis as any)[MDX_COMPONENTS_INSTANCE_SYMBOL]
+    return (globalThis as any)[
+      MDX_COMPONENTS_INSTANCE_SYMBOL
+    ] as BoltdocsMdxComponents
   }
-  return context
+  return context as any as BoltdocsMdxComponents
 }
 export function MdxComponentsProvider({
   components,
   children,
 }: {
-  components: MdxComponentsType
+  components: Record<string, React.ComponentType<any>>
   children: React.ReactNode
 }) {
+  const processedComponents = useMemo(() => {
+    const processed: Record<string, any> = {}
+    const frontmatter: Record<string, React.ComponentType<any>> = {}
+    Object.entries(components).forEach(([key, value]) => {
+      if (key.startsWith('Frontmatter_')) {
+        const cleanKey = key.slice('Frontmatter_'.length)
+        frontmatter[cleanKey] = value
+      } else {
+        processed[key] = value
+      }
+    })
+    processed.Frontmatter = frontmatter
+    return processed as MdxComponentsType
+  }, [components])
   // Sync with global registry
   if (typeof globalThis !== 'undefined') {
-    ;(globalThis as any)[MDX_COMPONENTS_INSTANCE_SYMBOL] = components
+    ;(globalThis as any)[MDX_COMPONENTS_INSTANCE_SYMBOL] = processedComponents
   }
   return (
-    <MdxComponentsContext.Provider value={components}>
+    <MdxComponentsContext.Provider value={processedComponents}>
       {children}
     </MdxComponentsContext.Provider>
   )

package/src/client/app/routes-context.tsx CHANGED Viewed

@@ -1,4 +1,4 @@
-import { createContext, useContext } from 'react'
+import { createContext, use } from 'react'
 import type { ComponentRoute } from '../types'
 interface RoutesContextType {
@@ -13,7 +13,7 @@ const RoutesContext = createContext<RoutesContextType>({
  * Hook to access the processed routes list from the closest provider.
  */
 export function useRoutesContext() {
-  return useContext(RoutesContext)
+  return use(RoutesContext)
 }
 /**

package/src/client/app/scroll-handler.tsx CHANGED Viewed

@@ -41,7 +41,7 @@ export function ScrollHandler() {
         const elementPosition = elementRect - containerTop
         const offsetPosition = elementPosition - offset + getScrollTop()
-        scrollTo(offsetPosition, 'smooth')
+        scrollTo(offsetPosition, 'auto')
         return
       }
     }

package/src/client/app/theme-context.tsx CHANGED Viewed

@@ -26,8 +26,7 @@ export function ThemeProvider({ children }: { children: React.ReactNode }) {
   const applyTheme = (targetTheme: Theme) => {
     const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
     const isDark =
-      targetTheme === 'dark' ||
-      (targetTheme === 'system' && mediaQuery.matches)
+      targetTheme === 'dark' || (targetTheme === 'system' && mediaQuery.matches)
     const root = window.document.documentElement
     root.classList.toggle('dark', isDark)
@@ -46,7 +45,8 @@ export function ThemeProvider({ children }: { children: React.ReactNode }) {
     const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
     const listener = () => {
-      const current = (localStorage.getItem('boltdocs-theme') as Theme) || 'system'
+      const current =
+        (localStorage.getItem('boltdocs-theme') as Theme) || 'system'
       if (current === 'system') applyTheme('system')
     }
@@ -58,7 +58,7 @@ export function ThemeProvider({ children }: { children: React.ReactNode }) {
     setThemeState(newTheme)
     localStorage.setItem('boltdocs-theme', newTheme)
     applyTheme(newTheme)
     // Notify external listeners (dual-package hazard)
     if (typeof window !== 'undefined') {
       window.dispatchEvent(new CustomEvent(THEME_EVENT, { detail: newTheme }))
@@ -81,7 +81,7 @@ export function useTheme() {
   useEffect(() => {
     if (context) return
     const handler = () => forceUpdate({})
     window.addEventListener(THEME_EVENT, handler)
     return () => window.removeEventListener(THEME_EVENT, handler)

package/src/client/app/ui-context.tsx ADDED Viewed

@@ -0,0 +1,42 @@
+import { createContext, useContext, useState, useEffect } from 'react'
+import { useLocation } from 'react-router-dom'
+interface UIContextType {
+  isSidebarOpen: boolean
+  toggleSidebar: () => void
+  closeSidebar: () => void
+}
+const UIContext = createContext<UIContextType | undefined>(undefined)
+export function UIProvider({ children }: { children: React.ReactNode }) {
+  const [isSidebarOpen, setIsSidebarOpen] = useState(false)
+  const location = useLocation()
+  const toggleSidebar = () => setIsSidebarOpen((prev) => !prev)
+  const closeSidebar = () => setIsSidebarOpen(false)
+  // Close sidebar on navigation
+  useEffect(() => {
+    setIsSidebarOpen(false)
+  }, [location.pathname])
+  return (
+    <UIContext.Provider value={{ isSidebarOpen, toggleSidebar, closeSidebar }}>
+      {children}
+    </UIContext.Provider>
+  )
+}
+export function useUI() {
+  const context = useContext(UIContext)
+  if (context === undefined) {
+    // Safe fallback for split bundles, independent component renders, or during SSR
+    return {
+      isSidebarOpen: false,
+      toggleSidebar: () => {},
+      closeSidebar: () => {},
+    }
+  }
+  return context
+}

package/src/client/components/docs-layout-default.tsx ADDED Viewed

@@ -0,0 +1,85 @@
+import { DocsLayout as DocsLayoutPrimitive } from './primitives/docs-layout'
+import { Navbar } from './ui-base/navbar'
+import { Sidebar } from './ui-base/sidebar'
+import { OnThisPage } from './ui-base/on-this-page'
+import { Breadcrumbs } from './ui-base/breadcrumbs'
+import { PageNav } from './ui-base/page-nav'
+import { ErrorBoundary } from './ui-base/error-boundary'
+import { CopyMarkdown } from './ui-base/copy-markdown'
+import { useRoutes } from '../hooks/use-routes'
+import { useConfig } from '../app/config-context'
+interface DocsLayoutThemeProps {
+  children?: React.ReactNode
+}
+/**
+ * Pre-assembled high-fidelity documentation layout component.
+ * Fully styled and optimized to adapt seamlessly to our custom Parchment/Slate theme.
+ */
+function DocsLayoutComponent({ children }: DocsLayoutThemeProps) {
+  const { routes: filteredRoutes, currentRoute } = useRoutes()
+  const config = useConfig()
+  return (
+    <DocsLayoutPrimitive className="selection:bg-primary-500/10 selection:text-primary-500">
+      <Navbar />
+      <DocsLayoutPrimitive.Body className="bg-main">
+        <Sidebar routes={filteredRoutes || []} config={config} />
+        <DocsLayoutPrimitive.Content className="animate-in fade-in duration-500 scroll-smooth">
+          <DocsLayoutPrimitive.ContentMdx className="max-w-5xl px-2 pt-8 pb-24">
+            <DocsLayoutPrimitive.Header>
+              <div className="mb-4 border-b border-subtle pb-4 flex flex-wrap items-center justify-between gap-3">
+                <Breadcrumbs />
+                <CopyMarkdown
+                  mdxRaw={currentRoute?._rawContent}
+                  route={currentRoute}
+                />
+              </div>
+              {/* Inject Main Page Heading automatically */}
+              {currentRoute?.title && (
+                <h1 className="text-4xl font-bold tracking-tight text-default mb-3">
+                  {currentRoute.title}
+                </h1>
+              )}
+              {currentRoute?.description && (
+                <p className="text-lg text-muted-foreground mb-6 leading-relaxed">
+                  {currentRoute.description}
+                </p>
+              )}
+            </DocsLayoutPrimitive.Header>
+            <ErrorBoundary>
+              <div className="prose prose-neutral dark:prose-invert max-w-none">
+                {children}
+              </div>
+            </ErrorBoundary>
+            <DocsLayoutPrimitive.Footer>
+              <PageNav />
+            </DocsLayoutPrimitive.Footer>
+          </DocsLayoutPrimitive.ContentMdx>
+        </DocsLayoutPrimitive.Content>
+        <OnThisPage
+          headings={currentRoute?.headings}
+          editLink={config.theme?.editLink}
+          communityHelp={config.theme?.communityHelp}
+          filePath={currentRoute?.filePath}
+        />
+      </DocsLayoutPrimitive.Body>
+    </DocsLayoutPrimitive>
+  )
+}
+// Expose the primitive sub-components directly on the Default DocsLayout
+// to maintain complete backward-compatibility for custom theme assemblies.
+export const DocsLayout = Object.assign(DocsLayoutComponent, {
+  Body: DocsLayoutPrimitive.Body,
+  Content: DocsLayoutPrimitive.Content,
+  ContentMdx: DocsLayoutPrimitive.ContentMdx,
+  Header: DocsLayoutPrimitive.Header,
+  Footer: DocsLayoutPrimitive.Footer,
+}) as any
+export default DocsLayout

package/src/client/components/icons-dev.tsx CHANGED Viewed

@@ -23,39 +23,65 @@ export const Github = (props: WrapperProps) => (
   </svg>
 )
-export const Discord = (props: WrapperProps) => (
+export const Csv = (props: WrapperProps) => (
   <svg
     xmlns="http://www.w3.org/2000/svg"
+    fill="none"
     viewBox="0 0 24 24"
-    fill="currentColor"
     {...wrapperProps(props)}
   >
-    <title>{'Discord'}</title>
-    <path d="M20.317 4.37a19.791 19.791 0 0 0-4.885-1.515.074.074 0 0 0-.079.037c-.21.375-.444.864-.608 1.25a18.27 18.27 0 0 0-5.487 0 12.64 12.64 0 0 0-.617-1.25.077.077 0 0 0-.079-.037A19.736 19.736 0 0 0 3.677 4.37a.07.07 0 0 0-.032.027C.533 9.046-.32 13.58.099 18.057a.082.082 0 0 0 .031.057 19.9 19.9 0 0 0 5.993 3.03.078.078 0 0 0 .084-.028c.462-.63.874-1.295 1.226-1.994a.076.076 0 0 0-.041-.106 13.107 13.107 0 0 1-1.872-.892.077.077 0 0 1-.008-.128 10.2 10.2 0 0 0 .372-.292.074.074 0 0 1 .077-.01c3.928 1.793 8.18 1.793 12.062 0a.074.074 0 0 1 .078.01c.12.098.246.198.373.292a.077.077 0 0 1-.006.127 12.299 12.299 0 0 1-1.873.892.077.077 0 0 0-.041.107c.36.698.772 1.362 1.225 1.993a.076.076 0 0 0 .084.028 19.839 19.839 0 0 0 6.002-3.03.077.077 0 0 0 .032-.054c.5-5.177-.838-9.674-3.549-13.66a.061.061 0 0 0-.031-.03zM8.02 15.33c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.956-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.956 2.418-2.157 2.418zm7.975 0c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.955-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.946 2.418-2.157 2.418Z" />
+    <title>{'CSV'}</title>
+    <mask
+      id="a"
+      maskUnits="userSpaceOnUse"
+      x="3"
+      y="3"
+      width="18"
+      height="18"
+      fill="#000"
+    >
+      <path fill="#fff" d="M3 3h18v18H3z" />
+      <path
+        fillRule="evenodd"
+        clipRule="evenodd"
+        d="M15.8889 5H8.11111C6.39289 5 5 6.39289 5 8.11111v7.77779C5 17.6071 6.39289 19 8.11111 19h7.77779C17.6071 19 19 17.6071 19 15.8889V8.11111C19 6.39289 17.6071 5 15.8889 5Zm0 12.4444H8.1111c-.05369 0-.10674-.0027-.15904-.008.0523.0053.10536.008.15905.008h7.77779Zm1.5555-1.5555c0 .8054-.6121 1.4679-1.3965 1.5475.7844-.0797 1.3965-.7421 1.3965-1.5475V8.11111v7.77779Z"
+      />
+    </mask>
+    <path
+      d="M15.8889 19.4444c1.1046 0 2-.8954 2-2 0-1.1045-.8954-2-2-2v4Zm-7.7778-2 .00001-2H8.1111v2Zm-.15904-.008.20206-1.9898c-1.09891-.1115-2.08022.6888-2.19182 1.7877-.1116 1.099.68877 2.0803 1.78768 2.1919l.20208-1.9898Zm8.09584 0-.2021-1.9897c-1.0989.1116-1.8992 1.0929-1.7876 2.1918.1116 1.0989 1.0929 1.8993 2.1918 1.7877l-.2021-1.9898Zm3.3965-9.32529c0-1.10457-.8954-2-2-2-1.1045 0-2 .89543-2 2h4ZM8.11111 7h7.77779V3H8.11111v4ZM7 8.11111C7 7.49746 7.49746 7 8.11111 7V3C5.28832 3 3 5.28832 3 8.11111h4Zm0 7.77779V8.11111H3v7.77779h4ZM8.11111 17C7.49746 17 7 16.5025 7 15.8889H3C3 18.7117 5.28832 21 8.11111 21v-4Zm7.77779 0H8.11111v4h7.77779v-4ZM17 15.8889C17 16.5025 16.5025 17 15.8889 17v4C18.7117 21 21 18.7117 21 15.8889h-4Zm0-7.77779v7.77779h4V8.11111h-4ZM15.8889 7C16.5025 7 17 7.49746 17 8.11111h4C21 5.28832 18.7117 3 15.8889 3v4Zm0 8.4444H8.11111l-.00001 4h7.7778v-4Zm-7.7778 0c.01378 0 .02816.0007.04302.0022l-.40411 3.9796c.11944.0121.23994.0182.36109.0182v-4Zm-.36112 3.9818c.11935.0121.23985.0182.36113.0182v-4c.01389 0 .02828.0008.04304.0022l-.40417 3.9796Zm.36113.0182h7.77779v-4H8.11111v4Zm8.13889-.0182c1.7951-.1823 3.1944-1.6951 3.1944-3.5373h-4c0-.2314.1752-.4193.4015-.4423l.4041 3.9796Zm-.8056-3.5373c0-.2314.1752-.4193.4014-.4422l.4042 3.9795c1.795-.1823 3.1944-1.6951 3.1944-3.5373h-4Zm0-7.77779v7.77779h4V8.11111h-4Zm4 0c0-.07155-.0038-.14596-.0124-.22267-.0086-.07678-.0218-.15478-.0403-.23343-.0184-.07869-.0416-.15651-.0697-.233-.0281-.07648-.0604-.15005-.0963-.22045-.036-.07036-.0749-.13629-.1158-.1978-.0408-.06145-.0832-.11775-.1258-.16912-.085-.10251-.1704-.18478-.2468-.2495-.0383-.03245-.0749-.061-.1089-.08594-.034-.02494-.0659-.04672-.0949-.06556-.029-.01883-.0558-.03518-.0797-.04914-.0239-.01396-.0456-.02598-.0644-.03606-.0188-.01008-.0355-.01864-.0493-.02558-.0139-.00694-.0257-.01268-.0348-.01701-.009-.00429-.0163-.00769-.0207-.00971-.0022-.00104-.004-.00187-.0051-.00238-.0006-.00025-.001-.00046-.0013-.00059-.0002-.00006-.0003-.00011-.0003-.00014-.0001-.00001-.0001-.00003-.0001-.00004v-.00001c-.0006-.00027.0028.00131.0068.00316.0044.00202.0117.00541.0207.00971.0091.00433.0209.01007.0348.01701.0138.00694.0305.0155.0493.02558.0188.01008.0405.0221.0644.03606.0239.01396.0507.03031.0797.04914.029.01883.0609.04062.0949.06556.0339.02494.0706.05349.1089.08594.0764.06472.1618.14698.2468.24949.0426.05138.085.10768.1258.16913.0409.06151.0798.12744.1157.19779.036.07041.0683.14397.0964.22046.028.07648.0513.15431.0697.23299.0185.07865.0317.15665.0403.23344.0086.07671.0124.15112.0124.22267h-4c0 .07154.0039.14595.0125.22267.0086.07678.0218.15478.0402.23343.0185.07868.0417.15651.0698.233.0281.07648.0604.15005.0963.22045.036.07036.0749.13629.1158.1978.0408.06144.0832.11775.1258.16912.0849.10251.1704.18478.2468.2495.0383.03244.0749.061.1089.08594.0339.02493.0658.04672.0949.06556.029.01883.0558.03517.0797.04914.0239.01396.0456.02598.0644.03606.0188.01007.0354.01864.0493.02558.0139.00693.0257.01268.0348.01701.009.00429.0163.00769.0207.00971.0022.00104.004.00187.0051.00237.0006.00026.001.00047.0013.00059.0001.00007.0003.00012.0003.00015.0001.00001.0001.00003.0001.00004v.00001c.0006.00026-.0028-.00131-.0068-.00316-.0044-.00202-.0117-.00542-.0207-.00971-.0091-.00433-.0209-.01008-.0348-.01701-.0139-.00694-.0305-.01551-.0493-.02558-.0188-.01008-.0405-.0221-.0644-.03606-.0239-.01396-.0507-.03031-.0797-.04914-.029-.01884-.061-.04062-.0949-.06556-.034-.02494-.0706-.0535-.1089-.08594-.0764-.06472-.1619-.14699-.2468-.2495-.0426-.05137-.085-.10767-.1258-.16912-.0409-.06151-.0798-.12744-.1158-.1978-.0359-.0704-.0682-.14397-.0963-.22045-.0281-.07649-.0513-.15431-.0698-.233-.0184-.07865-.0316-.15665-.0402-.23343-.0086-.07671-.0125-.15112-.0125-.22267h4Zm0 7.77779V8.11111h-4v7.77779h4Z"
+      fill="#14B8A6"
+      mask="url(#a)"
+    />
+    <rect x="7" y="7" width="4" height="2" rx="1" fill="#14B8A6" />
+    <rect x="7" y="11" width="4" height="2" rx="1" fill="#14B8A6" />
+    <rect x="7" y="15" width="4" height="2" rx="1" fill="#14B8A6" />
+    <rect x="13" y="7" width="4" height="2" rx="1" fill="#14B8A6" />
+    <rect x="13" y="11" width="4" height="2" rx="1" fill="#14B8A6" />
+    <rect x="13" y="15" width="4" height="2" rx="1" fill="#14B8A6" />
   </svg>
 )
-export const XSocial = (props: WrapperProps) => (
+export const Discord = (props: WrapperProps) => (
   <svg
     xmlns="http://www.w3.org/2000/svg"
     viewBox="0 0 24 24"
     fill="currentColor"
     {...wrapperProps(props)}
   >
-    <title>{'X'}</title>
-    <path d="M14.234 10.162 22.977 0h-2.072l-7.591 8.824L7.251 0H.258l9.168 13.343L.258 24H2.33l8.016-9.318L16.749 24h6.993zm-2.837 3.299-.929-1.329L3.076 1.56h3.182l5.965 8.532.929 1.329 7.754 11.09h-3.182z" />
+    <title>{'Discord'}</title>
+    <path d="M20.317 4.37a19.791 19.791 0 0 0-4.885-1.515.074.074 0 0 0-.079.037c-.21.375-.444.864-.608 1.25a18.27 18.27 0 0 0-5.487 0 12.64 12.64 0 0 0-.617-1.25.077.077 0 0 0-.079-.037A19.736 19.736 0 0 0 3.677 4.37a.07.07 0 0 0-.032.027C.533 9.046-.32 13.58.099 18.057a.082.082 0 0 0 .031.057 19.9 19.9 0 0 0 5.993 3.03.078.078 0 0 0 .084-.028c.462-.63.874-1.295 1.226-1.994a.076.076 0 0 0-.041-.106 13.107 13.107 0 0 1-1.872-.892.077.077 0 0 1-.008-.128 10.2 10.2 0 0 0 .372-.292.074.074 0 0 1 .077-.01c3.928 1.793 8.18 1.793 12.062 0a.074.074 0 0 1 .078.01c.12.098.246.198.373.292a.077.077 0 0 1-.006.127 12.299 12.299 0 0 1-1.873.892.077.077 0 0 0-.041.107c.36.698.772 1.362 1.225 1.993a.076.076 0 0 0 .084.028 19.839 19.839 0 0 0 6.002-3.03.077.077 0 0 0 .032-.054c.5-5.177-.838-9.674-3.549-13.66a.061.061 0 0 0-.031-.03zM8.02 15.33c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.956-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.956 2.418-2.157 2.418zm7.975 0c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.955-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.946 2.418-2.157 2.418Z" />
   </svg>
 )
-export const CodeSandbox = (props: WrapperProps) => (
+export const XSocial = (props: WrapperProps) => (
   <svg
     xmlns="http://www.w3.org/2000/svg"
     viewBox="0 0 24 24"
     fill="currentColor"
     {...wrapperProps(props)}
   >
-    <title>{'CodeSandbox'}</title>
-    <path d="M0 24h24V0H0v2.455h21.546v19.09H2.454V0H0Z" />
+    <title>{'X'}</title>
+    <path d="M14.234 10.162 22.977 0h-2.072l-7.591 8.824L7.251 0H.258l9.168 13.343L.258 24H2.33l8.016-9.318L16.749 24h6.993zm-2.837 3.299-.929-1.329L3.076 1.56h3.182l5.965 8.532.929 1.329 7.754 11.09h-3.182z" />
   </svg>
 )
@@ -148,7 +174,6 @@ export const BracketsOrange = (props: WrapperProps) => (
   </svg>
 )
 export const React = (props: WrapperProps) => (
   <svg
     xmlns="http://www.w3.org/2000/svg"
@@ -239,8 +264,7 @@ export const Rust = (props: WrapperProps) => (
       clipRule="evenodd"
     ></path>
   </svg>
-);
+)
 export const BracketsRed = (props: WrapperProps) => (
   <svg
@@ -255,5 +279,4 @@ export const BracketsRed = (props: WrapperProps) => (
       d="M4.778 6.667A2.667 2.667 0 017.444 4a.889.889 0 010 1.778.889.889 0 00-.888.889v3.5c0 .701-.273 1.35-.73 1.833.457.483.73 1.132.73 1.832v3.501c0 .491.398.89.888.89a.889.889 0 010 1.777 2.667 2.667 0 01-2.666-2.667v-3.5a.889.889 0 00-.674-.863l-.43-.108a.889.889 0 010-1.724l.43-.108a.889.889 0 00.674-.862V6.667zm14.222 0A2.667 2.667 0 0016.333 4a.889.889 0 000 1.778c.491 0 .89.398.89.889v3.5c0 .701.272 1.35.729 1.833a2.664 2.664 0 00-.73 1.832v3.501a.889.889 0 01-.889.89.889.889 0 000 1.777A2.667 2.667 0 0019 17.333v-3.5c0-.408.278-.764.673-.863l.431-.108a.889.889 0 000-1.724l-.43-.108a.889.889 0 01-.674-.862V6.667z"
     ></path>
   </svg>
-);
+)