@takazudo/zudo-doc 0.2.21 → 1.0.0

package/dist/settings.d.ts

@@ -0,0 +1,270 @@
+/**
+ * Tag governance enforcement level.
+ *
+ * - `"off"`    — no vocabulary-aware enforcement (pre-vocabulary behaviour).
+ * - `"warn"`   — tag audit reports unknown tags but the build still passes.
+ * - `"strict"` — unknown tags fail `pnpm check` / `pnpm build` via Zod.
+ *
+ * Orthogonal to `tagVocabulary`. `tagGovernance` controls the enforcement
+ * level when the vocabulary is consulted; `tagVocabulary` controls whether
+ * it is consulted at all.
+ */
+export type TagGovernanceMode = "off" | "warn" | "strict";
+/**
+ * A single entry in the tag vocabulary.
+ *
+ * - `id`         — canonical tag id. What content files should ideally use.
+ * - `label`      — optional human-readable label (falls back to `id`).
+ * - `description`— optional short description for tooling / tag index pages.
+ * - `group`      — optional grouping key used by the grouped tag footer
+ *                  (e.g. `"type"`, `"level"`, `"topic"`).
+ * - `aliases`    — alternate strings that content files may use. Alias
+ *                  resolution rewrites these to `id` before aggregation.
+ * - `deprecated` — `true` marks the tag as deprecated with no redirect: the
+ *                  canonical id is dropped from aggregation. Pass
+ *                  `{ redirect: "<other-id>" }` to rewrite this tag to another
+ *                  canonical id when it appears in content.
+ */
+export interface TagVocabularyEntry {
+    id: string;
+    label?: string;
+    description?: string;
+    group?: string;
+    aliases?: readonly string[];
+    deprecated?: boolean | {
+        redirect?: string;
+    };
+}
+export interface HeaderNavChildItem {
+    label: string;
+    labelKey?: string;
+    path: string;
+    categoryMatch?: string;
+}
+export interface HeaderNavItem extends HeaderNavChildItem {
+    children?: HeaderNavChildItem[];
+}
+export type HeaderRightComponentName = "theme-toggle" | "language-switcher" | "version-switcher" | "github-link" | "search";
+export type HeaderRightTriggerName = "design-token-panel" | "ai-chat";
+export interface HeaderRightComponentItem {
+    type: "component";
+    component: HeaderRightComponentName;
+}
+export interface HeaderRightTriggerItem {
+    type: "trigger";
+    trigger: HeaderRightTriggerName;
+}
+export interface HeaderRightLinkItem {
+    type: "link";
+    href: string;
+    label?: string;
+    ariaLabel?: string;
+    icon?: "github";
+}
+export interface HeaderRightHtmlItem {
+    type: "html";
+    html: string;
+}
+export type HeaderRightItem = HeaderRightComponentItem | HeaderRightTriggerItem | HeaderRightLinkItem | HeaderRightHtmlItem;
+export interface BodyFootUtilAreaConfig {
+    docHistory?: boolean;
+    viewSourceLink?: boolean;
+}
+export interface ColorModeConfig {
+    defaultMode: "light" | "dark";
+    lightScheme: string;
+    darkScheme: string;
+    respectPrefersColorScheme: boolean;
+}
+export interface LocaleConfig {
+    label: string;
+    dir: string;
+}
+export interface FooterLinkItem {
+    label: string;
+    href: string;
+    locales?: Record<string, {
+        label: string;
+    }>;
+}
+export interface FooterLinkColumn {
+    title: string;
+    items: FooterLinkItem[];
+    locales?: Record<string, {
+        title: string;
+    }>;
+}
+/**
+ * Per-locale overrides for the footer taglist labels.
+ *
+ * `title`        — overrides `taglist.title` on this locale.
+ * `groupTitles`  — per-group title overrides keyed by vocabulary `group`.
+ */
+export interface FooterTaglistLocaleConfig {
+    title?: string;
+    groupTitles?: Record<string, string>;
+}
+/**
+ * Opt-in footer tag index.
+ *
+ * Renders one or more columns of tag links inside the existing footer grid.
+ * Off by default: when `enabled: false` (or the field is omitted entirely),
+ * the footer renders unchanged.
+ *
+ * - `groupBy: "group"` — one column per vocabulary `group`, in the order the
+ *   groups first appear in `tag-vocabulary.ts`. Each column's title comes from
+ *   `groupTitles[group]`, falling back to a capitalised version of the group
+ *   name.
+ * - `groupBy: "flat"` — a single column titled `title` listing every tag
+ *   alphabetically. This is also the fallback used when the vocabulary is
+ *   inactive (`tagVocabulary: false` or `tagGovernance: "off"`).
+ */
+export interface FooterTaglistConfig {
+    enabled: boolean;
+    /** Column title used in flat mode (and as fallback for ungrouped tags). */
+    title?: string;
+    /** Default `"group"` when the vocabulary is active, otherwise forced to `"flat"`. */
+    groupBy?: "group" | "flat";
+    /** English (default-locale) group titles, e.g. `{ type: "By type" }`. */
+    groupTitles?: Record<string, string>;
+    /** Locale-specific overrides for `title` and `groupTitles`. */
+    locales?: Record<string, FooterTaglistLocaleConfig>;
+}
+export interface FooterConfig {
+    links: FooterLinkColumn[];
+    /** Copyright text displayed at the bottom of the footer. HTML is supported. */
+    copyright?: string;
+    /** Opt-in footer tag index. Off by default. */
+    taglist?: FooterTaglistConfig;
+}
+export interface HtmlPreviewConfig {
+    /** Raw HTML injected into <head> (links, meta, fonts) */
+    head?: string;
+    /** CSS injected as <style> after preflight */
+    css?: string;
+    /** JS injected as <script> before </body> */
+    js?: string;
+}
+export interface FrontmatterPreviewConfig {
+    /**
+     * Completely replaces the default ignore list.
+     * When set, `extraIgnoreKeys` is ignored.
+     */
+    ignoreKeys?: string[];
+    /**
+     * Additional keys to ignore on top of the defaults.
+     * Has no effect when `ignoreKeys` is also set.
+     */
+    extraIgnoreKeys?: string[];
+}
+export type TagPlacement = "after-title" | "before-pager";
+export interface VersionConfig {
+    /** Version identifier, used in URL path (e.g., "1.0", "v1") */
+    slug: string;
+    /** Display label (e.g., "1.0.0", "Version 1") */
+    label: string;
+    /** Content directory for this version's English docs */
+    docsDir: string;
+    /** Per-locale content directories for this version */
+    locales?: Record<string, {
+        dir: string;
+    }>;
+    /** Banner text shown on versioned pages (e.g., "unmaintained", "unreleased") */
+    banner?: "unmaintained" | "unreleased" | false;
+}
+export interface MetaTagsConfig {
+    /** Emit <meta name="description">. Default true. */
+    description: boolean;
+    /** Emit <meta name="keywords"> with a comma-separated string. false = omit. Default false. */
+    keywords: string | false;
+    /** og:image (and twitter:image) path. false = omit. Default false. Showcase: '/img/ogp.png'. */
+    ogImage: string | false;
+    /** Emit og:site_name. Default true (preserves current og:site_name). */
+    ogSiteName: boolean;
+    /** TwitterCard type. false = omit entire twitter:card block. Default false. Showcase: 'summary_large_image'. */
+    twitterCard: "summary" | "summary_large_image" | false;
+    /** twitter:site handle (e.g. '@yourbrand'). Optional. */
+    twitterSite?: string;
+    /** twitter:creator handle. Optional. */
+    twitterCreator?: string;
+}
+/**
+ * The full zudo-doc project settings interface.
+ *
+ * Consumer projects declare their concrete settings object using `satisfies Settings`
+ * to get type-checking against this interface:
+ *
+ * ```ts
+ * import type { Settings } from "@takazudo/zudo-doc/settings";
+ * export const settings = { ... } satisfies Settings;
+ * ```
+ */
+export interface Settings {
+    colorScheme: string;
+    colorMode: ColorModeConfig | false;
+    siteName: string;
+    siteDescription: string;
+    base: string;
+    trailingSlash: boolean;
+    docsDir: string;
+    defaultLocale: string;
+    locales: Record<string, LocaleConfig>;
+    mermaid: boolean;
+    noindex: boolean;
+    editUrl: string | false;
+    githubUrl: string | false;
+    /** "owner/repo" — enables `#123` / SHA autolinks in markdown. Omit or leave undefined to disable. */
+    githubAutolinksRepo?: string;
+    siteUrl: string;
+    metaTags: MetaTagsConfig;
+    sitemap: boolean;
+    docMetainfo: boolean;
+    docTags: boolean;
+    tagPlacement: TagPlacement;
+    tagGovernance: TagGovernanceMode;
+    tagVocabulary: boolean;
+    llmsTxt: boolean;
+    math: boolean;
+    cjkFriendly: boolean;
+    onBrokenMarkdownLinks: "warn" | "error" | "ignore";
+    aiAssistant: boolean;
+    aiChatDemoMode: boolean;
+    aiChatAllowedOrigins: string[];
+    aiChatGlobalDailyLimit: number | false;
+    designTokenPanel: boolean;
+    tocMinDepth: number;
+    tocMaxDepth: number;
+    headingIdStrategy: "flat" | "hierarchical";
+    sidebarResizer: boolean;
+    sidebarToggle: boolean;
+    imageEnlarge: boolean;
+    dynamicPageTransition: boolean;
+    frontmatterPreview: FrontmatterPreviewConfig | false;
+    docHistory: boolean;
+    bodyFootUtilArea: BodyFootUtilAreaConfig | false;
+    htmlPreview: HtmlPreviewConfig | undefined;
+    versions: VersionConfig[] | false;
+    claudeResources: {
+        claudeDir: string;
+        projectRoot?: string;
+    } | false;
+    defaultLocaleOnlyPrefixes: string[];
+    footer: FooterConfig | false;
+    headerNav: HeaderNavItem[];
+    headerRightItems: HeaderRightItem[];
+    /**
+     * Build-time package-owned route injection (epic Package-First Finale #2356,
+     * ADR `docs/adr/route-injection-seam.md`). When `true`, the preset adds the
+     * `@takazudo/zudo-doc/plugins/routes` plugin, which injects the doc routes
+     * from the package instead of requiring project-shipped `pages/*.tsx` stubs.
+     *
+     * On by default since the fast-follow (#2372 — upstream zfb dev-render support
+     * landed): the showcase and create-zudo-doc emit `packageOwnedRoutes: true` into
+     * their generated `settings.ts`. The preset reads this value truthily with no
+     * central defaulting, so a hand-written settings object that omits the field is
+     * treated as off. Any injected route whose URL shape collides with a kept
+     * `pages/` stub is silently dropped (user `pages/` wins), so existing stubs
+     * are a harmless no-op.
+     */
+    packageOwnedRoutes?: boolean;
+}

package/dist/sidebar/index.d.ts

@@ -1,3 +1,21 @@
-export { Sidebar, SidebarProps } from './sidebar.js';
-export { SidebarLocaleLink, SidebarNavNode, SidebarRootMenuItem, SidebarTreeIslandProps } from './types.js';
-import 'preact';
+/**
+ * Public entry for the framework-agnostic sidebar shell.
+ *
+ * Consumers import from `@takazudo/zudo-doc/sidebar`:
+ *
+ *   import {
+ *     Sidebar,
+ *     type SidebarProps,
+ *     type SidebarNavNode,
+ *     type SidebarRootMenuItem,
+ *     type SidebarLocaleLink,
+ *     type SidebarTreeIslandProps,
+ *   } from "@takazudo/zudo-doc/sidebar";
+ *
+ * The shell does NOT include the SidebarTree island itself — the host
+ * project's existing Preact island is plugged in via the
+ * `treeComponent` prop (or rendered as `children`).
+ */
+export { Sidebar } from "./sidebar.js";
+export type { SidebarProps } from "./sidebar.js";
+export type { SidebarLocaleLink, SidebarNavNode, SidebarRootMenuItem, SidebarTreeIslandProps, } from "./types.js";

package/dist/sidebar/sidebar.d.ts

@@ -1,10 +1,8 @@
-import { FunctionComponent, ComponentChildren, VNode } from 'preact';
-import { SidebarTreeIslandProps } from './types.js';
-
 /** @jsxRuntime automatic */
 /** @jsxImportSource preact */
-
-interface SidebarProps extends SidebarTreeIslandProps {
+import type { ComponentChildren, FunctionComponent, VNode } from "preact";
+import type { SidebarTreeIslandProps } from "./types.js";
+export interface SidebarProps extends SidebarTreeIslandProps {
     /**
      * The host's SidebarTree component. When present, the shell renders
      * `<TreeComponent {...islandProps} />` with the typed props below.
@@ -46,9 +44,7 @@ interface SidebarProps extends SidebarTreeIslandProps {
  * `<Island>` wrapper here exists so the shell can host data-only
  * variants in the future without losing the marker contract.
  */
-declare function Sidebar(props: SidebarProps): VNode | null;
-declare namespace Sidebar {
+export declare function Sidebar(props: SidebarProps): VNode | null;
+export declare namespace Sidebar {
     var displayName: string;
 }
-
-export { Sidebar, type SidebarProps };

package/dist/sidebar/types.d.ts

@@ -24,7 +24,7 @@
  * One node in the navigation tree the SidebarTree island renders.
  * Matches `NavNode` in the host project's `src/utils/docs.ts`.
  */
-interface SidebarNavNode {
+export interface SidebarNavNode {
     slug: string;
     label: string;
     description?: string;
@@ -39,7 +39,7 @@ interface SidebarNavNode {
  * Item in the root-level "Docusaurus-style" menu shown above the
  * doc tree on mobile / inside the back-to-menu view.
  */
-interface SidebarRootMenuItem {
+export interface SidebarRootMenuItem {
     label: string;
     href: string;
     children?: SidebarRootMenuItem[];
@@ -48,7 +48,7 @@ interface SidebarRootMenuItem {
  * Locale switcher link rendered inside the mobile sidebar footer.
  * Matches `LocaleLink` in the host project's `src/types/locale.ts`.
  */
-interface SidebarLocaleLink {
+export interface SidebarLocaleLink {
     code: string;
     label: string;
     href: string;
@@ -59,7 +59,7 @@ interface SidebarLocaleLink {
  * to whichever component the host plugs in via {@link SidebarProps.treeComponent}
  * (or to nothing, when the host renders its own tree as `children`).
  */
-interface SidebarTreeIslandProps {
+export interface SidebarTreeIslandProps {
     nodes: SidebarNavNode[];
     currentSlug?: string;
     rootMenuItems?: SidebarRootMenuItem[];
@@ -67,5 +67,3 @@ interface SidebarTreeIslandProps {
     localeLinks?: SidebarLocaleLink[];
     themeDefaultMode?: "light" | "dark";
 }
-
-export type { SidebarLocaleLink, SidebarNavNode, SidebarRootMenuItem, SidebarTreeIslandProps };

package/dist/sidebar-prepaint/index.d.ts

@@ -0,0 +1,21 @@
+/** @jsxRuntime automatic */
+/** @jsxImportSource preact */
+import type { JSX } from "preact";
+export interface SidebarPrepaintProps {
+    /**
+     * Mirrors the page's `hide_sidebar: true` frontmatter. When true the desktop
+     * toggle is skipped — there is no visible sidebar for it to collapse.
+     */
+    hideSidebar?: boolean;
+}
+/** Settings subset read by {@link createSidebarPrepaint}. */
+export interface SidebarPrepaintSettings {
+    sidebarToggle?: boolean;
+}
+/**
+ * Create a `SidebarPrepaint` component bound to the host's settings.
+ *
+ * The host stub calls this once with `{ sidebarToggle: settings.sidebarToggle }`
+ * and re-exports the result.
+ */
+export declare function createSidebarPrepaint(settings: SidebarPrepaintSettings): (props: SidebarPrepaintProps) => JSX.Element | undefined;

package/dist/sidebar-prepaint/index.js

@@ -0,0 +1,23 @@
+import { Fragment, jsx, jsxs } from "preact/jsx-runtime";
+import { Island } from "@takazudo/zfb";
+import { DesktopSidebarToggle } from "../desktop-sidebar-toggle-island/index.js";
+function createSidebarPrepaint(settings) {
+  function SidebarPrepaint({
+    hideSidebar
+  }) {
+    if (!settings.sidebarToggle || hideSidebar) return void 0;
+    return /* @__PURE__ */ jsxs(Fragment, { children: [
+      /* @__PURE__ */ jsx("script", { dangerouslySetInnerHTML: {
+        __html: `(function(){try{if(localStorage.getItem('zudo-doc-sidebar-visible')==='false'){document.documentElement.setAttribute('data-sidebar-hidden','');}}catch(e){}})();`
+      } }),
+      Island({
+        when: "load",
+        children: /* @__PURE__ */ jsx(DesktopSidebarToggle, {})
+      })
+    ] });
+  }
+  return SidebarPrepaint;
+}
+export {
+  createSidebarPrepaint
+};

package/dist/sidebar-resizer/index.d.ts

@@ -1,6 +1,3 @@
-export { SIDEBAR_RESIZER_INIT_SCRIPT, SIDEBAR_RESIZER_RESTORE_SCRIPT, SidebarResizerInit, SidebarResizerRestore } from './sidebar-resizer-init.js';
-import 'preact';
-
 /**
  * Attach the sidebar drag handle to `#desktop-sidebar`. Idempotent —
  * safe to call repeatedly (e.g. after each route swap). No-op if the
@@ -9,6 +6,5 @@ import 'preact';
  * Designed to be called from the browser only. Guards against `document`
  * being undefined so accidental SSR invocation does not throw.
  */
-declare function initSidebarResizer(): void;
-
-export { initSidebarResizer };
+export declare function initSidebarResizer(): void;
+export { SidebarResizerInit, SIDEBAR_RESIZER_INIT_SCRIPT, SidebarResizerRestore, SIDEBAR_RESIZER_RESTORE_SCRIPT, } from "./sidebar-resizer-init.js";

package/dist/sidebar-resizer/sidebar-resizer-init.d.ts

@@ -1,8 +1,6 @@
-import { JSX } from 'preact';
-
 /** @jsxImportSource preact */
-
-declare const SIDEBAR_RESIZER_INIT_SCRIPT: string;
+import type { JSX } from "preact";
+export declare const SIDEBAR_RESIZER_INIT_SCRIPT: string;
 /**
  * Drop-in JSX body-end script for sidebar resize initialization.
  *
@@ -15,9 +13,9 @@ declare const SIDEBAR_RESIZER_INIT_SCRIPT: string;
  *   Strategy B SPA navigation support.
  * - Idempotent: repeated calls on the same DOM are safe.
  */
-declare function SidebarResizerInit(): JSX.Element;
-
-declare const SIDEBAR_RESIZER_RESTORE_SCRIPT = "(function(){try{var w=localStorage.getItem(\"zudo-doc-sidebar-width\");if(!w)return;var n=parseFloat(w);if(!isFinite(n))return;if(n<192)n=192;else if(n>448)n=448;document.documentElement.style.setProperty(\"--zd-sidebar-w\",n+\"px\");}catch(e){}})();";
+export declare function SidebarResizerInit(): JSX.Element;
+export default SidebarResizerInit;
+export declare const SIDEBAR_RESIZER_RESTORE_SCRIPT = "(function(){try{var w=localStorage.getItem(\"zudo-doc-sidebar-width\");if(!w)return;var n=parseFloat(w);if(!isFinite(n))return;if(n<192)n=192;else if(n>448)n=448;document.documentElement.style.setProperty(\"--zd-sidebar-w\",n+\"px\");}catch(e){}})();";
 /**
  * Drop-in JSX `<head>` script that restores the persisted sidebar width
  * before first paint.
@@ -35,6 +33,4 @@ declare const SIDEBAR_RESIZER_RESTORE_SCRIPT = "(function(){try{var w=localStora
  * It silently no-ops in privacy / disabled-storage modes (try/catch),
  * matches the resilience of the runtime `applyWidth` writer.
  */
-declare function SidebarResizerRestore(): JSX.Element;
-
-export { SIDEBAR_RESIZER_INIT_SCRIPT, SIDEBAR_RESIZER_RESTORE_SCRIPT, SidebarResizerInit, SidebarResizerRestore, SidebarResizerInit as default };
+export declare function SidebarResizerRestore(): JSX.Element;

package/dist/sidebar-toggle-island/index.d.ts

@@ -0,0 +1,13 @@
+import type { SidebarNavNode, SidebarRootMenuItem, SidebarLocaleLink } from "../sidebar/types.js";
+export interface SidebarToggleProps {
+    nodes: SidebarNavNode[];
+    currentSlug?: string;
+    rootMenuItems?: SidebarRootMenuItem[];
+    backToMenuLabel?: string;
+    localeLinks?: SidebarLocaleLink[];
+    themeDefaultMode?: "light" | "dark";
+}
+export declare function SidebarToggle({ nodes, currentSlug, rootMenuItems, backToMenuLabel, localeLinks, themeDefaultMode, }: SidebarToggleProps): import("preact").JSX.Element;
+export declare namespace SidebarToggle {
+    var displayName: string;
+}

package/dist/sidebar-toggle-island/index.js

@@ -0,0 +1,122 @@
+"use client";
+import { Fragment, jsx, jsxs } from "preact/jsx-runtime";
+import { useState, useEffect } from "preact/hooks";
+import { AFTER_NAVIGATE_EVENT } from "../transitions/index.js";
+import { SidebarTree } from "../sidebar-tree-island/index.js";
+const cx = (...classes) => classes.filter(Boolean).join(" ");
+function SidebarToggle({
+  nodes,
+  currentSlug,
+  rootMenuItems,
+  backToMenuLabel,
+  localeLinks,
+  themeDefaultMode
+}) {
+  const [open, setOpen] = useState(false);
+  useEffect(() => {
+    if (open) {
+      document.body.style.overflow = "hidden";
+    } else {
+      document.body.style.overflow = "";
+    }
+    return () => {
+      document.body.style.overflow = "";
+    };
+  }, [open]);
+  useEffect(() => {
+    function handleSwap() {
+      setOpen(false);
+    }
+    document.addEventListener(AFTER_NAVIGATE_EVENT, handleSwap);
+    return () => document.removeEventListener(AFTER_NAVIGATE_EVENT, handleSwap);
+  }, []);
+  return /* @__PURE__ */ jsxs(Fragment, { children: [
+    /* @__PURE__ */ jsxs(
+      "button",
+      {
+        type: "button",
+        onClick: () => setOpen(!open),
+        className: "lg:hidden px-hsp-sm py-vsp-xs -ml-hsp-sm mr-hsp-sm text-muted hover:text-fg",
+        "aria-label": open ? "Close sidebar" : "Open sidebar",
+        "aria-expanded": open,
+        children: [
+          /* @__PURE__ */ jsx(
+            "svg",
+            {
+              xmlns: "http://www.w3.org/2000/svg",
+              className: cx("h-icon-lg w-icon-lg", !open && "hidden"),
+              "aria-hidden": "true",
+              fill: "none",
+              viewBox: "0 0 24 24",
+              stroke: "currentColor",
+              strokeWidth: 2,
+              children: /* @__PURE__ */ jsx(
+                "path",
+                {
+                  strokeLinecap: "round",
+                  strokeLinejoin: "round",
+                  d: "M6 18L18 6M6 6l12 12"
+                }
+              )
+            }
+          ),
+          /* @__PURE__ */ jsx(
+            "svg",
+            {
+              xmlns: "http://www.w3.org/2000/svg",
+              className: cx("h-icon-lg w-icon-lg", open && "hidden"),
+              "aria-hidden": "true",
+              fill: "none",
+              viewBox: "0 0 24 24",
+              stroke: "currentColor",
+              strokeWidth: 2,
+              children: /* @__PURE__ */ jsx(
+                "path",
+                {
+                  strokeLinecap: "round",
+                  strokeLinejoin: "round",
+                  d: "M4 6h16M4 12h16M4 18h16"
+                }
+              )
+            }
+          )
+        ]
+      }
+    ),
+    /* @__PURE__ */ jsx(
+      "div",
+      {
+        className: cx("fixed inset-0 z-modal-backdrop bg-overlay/30 lg:hidden", !open && "hidden"),
+        "aria-hidden": !open,
+        onClick: () => setOpen(false)
+      }
+    ),
+    /* @__PURE__ */ jsx(
+      "aside",
+      {
+        inert: !open,
+        className: `
+          fixed top-[3.5rem] left-0 z-modal h-[calc(100vh-3.5rem)] w-[16rem] flex flex-col
+          border-r border-muted bg-bg transition-transform duration-200
+          lg:hidden
+          ${open ? "translate-x-0" : "-translate-x-full"}
+        `,
+        children: /* @__PURE__ */ jsx("div", { className: "flex-1 overflow-y-auto", children: /* @__PURE__ */ jsx(
+          SidebarTree,
+          {
+            nodes,
+            currentSlug,
+            rootMenuItems,
+            backToMenuLabel,
+            localeLinks,
+            themeDefaultMode
+          }
+        ) })
+      }
+    )
+  ] });
+}
+SidebarToggle.displayName = "SidebarToggle";
+export {
+  SidebarToggle
+};

package/dist/sidebar-tree/build-tree.d.ts

@@ -1,5 +1,3 @@
-import { SidebarFrontmatter, CollectionEntryLike, BuildSidebarTreeOptions, SidebarNode } from './types.js';
-
 /**
  * Framework-agnostic sidebar tree builder.
  *
@@ -11,7 +9,7 @@ import { SidebarFrontmatter, CollectionEntryLike, BuildSidebarTreeOptions, Sideb
  *
  * Ported from src/utils/docs.ts in the legacy zudo-doc Astro project.
  */
-
+import type { BuildSidebarTreeOptions, CollectionEntryLike, SidebarFrontmatter, SidebarNode } from "./types.js";
 /**
  * Build a recursive sidebar tree from `entries`. Visibility filtering is
  * applied first; the resulting structure mirrors the filesystem.
@@ -25,19 +23,17 @@ import { SidebarFrontmatter, CollectionEntryLike, BuildSidebarTreeOptions, Sideb
  *   slug, with the parent's `sortOrder` (from `_category_.json`) flipping
  *   the comparator when set to `"desc"`.
  */
-declare function buildSidebarTree<T extends SidebarFrontmatter = SidebarFrontmatter>(entries: CollectionEntryLike<T>[], locale: string, options?: BuildSidebarTreeOptions): SidebarNode[];
+export declare function buildSidebarTree<T extends SidebarFrontmatter = SidebarFrontmatter>(entries: CollectionEntryLike<T>[], locale: string, options?: BuildSidebarTreeOptions): SidebarNode[];
 /**
  * Find a node by id (path slug) anywhere in the tree. Useful for sidebar
  * config layers that resolve named doc references and for the breadcrumb
  * builder. Exported alongside `buildSidebarTree` because both downstream
  * topics (sub-tasks 4 and 5) need it.
  */
-declare function findSidebarNode(nodes: SidebarNode[], id: string): SidebarNode | undefined;
+export declare function findSidebarNode(nodes: SidebarNode[], id: string): SidebarNode | undefined;
 /**
  * Depth-first flatten — only nodes with a backing page are emitted, in
  * traversal order. Mirrors the legacy `flattenTree` used for prev/next
  * navigation.
  */
-declare function flattenSidebarTree(nodes: SidebarNode[]): SidebarNode[];
-
-export { buildSidebarTree, findSidebarNode, flattenSidebarTree };
+export declare function flattenSidebarTree(nodes: SidebarNode[]): SidebarNode[];

package/dist/sidebar-tree/category-meta.d.ts

@@ -1,5 +1,4 @@
-import { CategoryMeta } from './types.js';
-
+import type { CategoryMeta } from "./types.js";
 /**
  * Scan `contentDir` recursively for `_category_.json` files. Each file's
  * parent directory becomes a map key, expressed as a path relative to
@@ -12,8 +11,6 @@ import { CategoryMeta } from './types.js';
  * page route in the same process; re-reading thousands of `_category_.json`
  * files for each page is wasteful.
  */
-declare function loadCategoryMeta(contentDir: string): Map<string, CategoryMeta>;
+export declare function loadCategoryMeta(contentDir: string): Map<string, CategoryMeta>;
 /** Test/HMR escape hatch — clears the per-directory cache. */
-declare function clearCategoryMetaCache(): void;
-
-export { clearCategoryMetaCache, loadCategoryMeta };
+export declare function clearCategoryMetaCache(): void;

package/dist/sidebar-tree/index.d.ts

@@ -1,3 +1,18 @@
-export { buildSidebarTree, findSidebarNode, flattenSidebarTree } from './build-tree.js';
-export { clearCategoryMetaCache, loadCategoryMeta } from './category-meta.js';
-export { BuildHref, BuildSidebarTreeOptions, CategoryMeta, CollectionEntryLike, SidebarFrontmatter, SidebarNode } from './types.js';
+/**
+ * Public entry for the framework-agnostic sidebar tree builder.
+ *
+ * Consumers import from `@takazudo/zudo-doc/sidebar-tree`:
+ *
+ *   import {
+ *     buildSidebarTree,
+ *     loadCategoryMeta,
+ *     type SidebarNode,
+ *   } from "@takazudo/zudo-doc/sidebar-tree";
+ *
+ * The builder takes a flat list of content collection entries (in either
+ * Astro or zfb shape) plus a locale, and emits a recursive `SidebarNode[]`
+ * suitable for rendering or for further sidebar-config processing.
+ */
+export { buildSidebarTree, findSidebarNode, flattenSidebarTree, } from "./build-tree.js";
+export { loadCategoryMeta, clearCategoryMetaCache } from "./category-meta.js";
+export type { BuildHref, BuildSidebarTreeOptions, CategoryMeta, CollectionEntryLike, SidebarFrontmatter, SidebarNode, } from "./types.js";