@dreamlake/dockit 0.1.1

package/dist/components/mdx-components.d.ts

@@ -0,0 +1,30 @@
+import { ComponentPropsWithoutRef } from 'react';
+import { Callout } from './Callout';
+import { Preview } from './Preview';
+import { StatusTable, TestStatus } from './StatusTable';
+/**
+ * MDX <pre> wrapper. Pulls language from the inner <code> className
+ * (e.g., `language-tsx`) and renders our CodeBlock chrome around it.
+ */
+declare function PreWrapper(props: ComponentPropsWithoutRef<'pre'>): import("react").JSX.Element;
+export declare const mdxComponents: {
+    h1: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref">>;
+    h2: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref">>;
+    h3: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref">>;
+    p: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, "ref">>;
+    ul: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref">>;
+    ol: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').OlHTMLAttributes<HTMLOListElement>, HTMLOListElement>, "ref">>;
+    li: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref">>;
+    a: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref">>;
+    blockquote: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').BlockquoteHTMLAttributes<HTMLQuoteElement>, HTMLQuoteElement>, "ref">>;
+    table: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>, "ref">>;
+    th: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').ThHTMLAttributes<HTMLTableHeaderCellElement>, HTMLTableHeaderCellElement>, "ref">>;
+    td: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').TdHTMLAttributes<HTMLTableDataCellElement>, HTMLTableDataCellElement>, "ref">>;
+    code: import('react').FC<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref">>;
+    pre: typeof PreWrapper;
+    Callout: typeof Callout;
+    Preview: typeof Preview;
+    StatusTable: typeof StatusTable;
+    TestStatus: typeof TestStatus;
+};
+export {};

package/dist/components/mdx-components.js

@@ -0,0 +1,346 @@
+import { jsx, jsxs, Fragment } from "react/jsx-runtime";
+import { useContext, createContext, useState } from "react";
+import { CodeBlock } from "./CodeBlock.js";
+import { Callout } from "./Callout.js";
+import { Preview } from "./Preview.js";
+import { TestStatus, StatusTable } from "./StatusTable.js";
+const InsidePreContext = createContext(false);
+const ChainIcon = () => /* @__PURE__ */ jsxs(
+  "svg",
+  {
+    viewBox: "0 0 24 24",
+    fill: "none",
+    stroke: "currentColor",
+    strokeWidth: "2",
+    strokeLinecap: "round",
+    strokeLinejoin: "round",
+    "aria-hidden": true,
+    style: { width: 14, height: 14, display: "block" },
+    children: [
+      /* @__PURE__ */ jsx("path", { d: "M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.71 1.71" }),
+      /* @__PURE__ */ jsx("path", { d: "M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71" })
+    ]
+  }
+);
+const CheckIcon = () => /* @__PURE__ */ jsx(
+  "svg",
+  {
+    viewBox: "0 0 24 24",
+    fill: "none",
+    stroke: "currentColor",
+    strokeWidth: "2.5",
+    strokeLinecap: "round",
+    strokeLinejoin: "round",
+    "aria-hidden": true,
+    style: { width: 14, height: 14, display: "block" },
+    children: /* @__PURE__ */ jsx("polyline", { points: "20 6 9 17 4 12" })
+  }
+);
+function HeadingAnchor({ id, label }) {
+  const [copied, setCopied] = useState(false);
+  if (!id) return null;
+  const onClick = () => {
+    if (typeof window === "undefined") return;
+    const url = `${window.location.origin}${window.location.pathname}#${id}`;
+    navigator.clipboard?.writeText(url).catch(() => {
+    });
+    setCopied(true);
+    window.setTimeout(() => setCopied(false), 1200);
+  };
+  const base = "inline-flex items-center justify-center no-underline rounded transition-[opacity,background-color,color] duration-150";
+  const idle = "text-doc-template-muted opacity-0 group-hover:opacity-70 hover:!opacity-100 hover:text-doc-template-ink hover:bg-doc-template-chip focus-visible:opacity-100";
+  const active = "text-doc-template-accent !opacity-100";
+  return /* @__PURE__ */ jsx(
+    "a",
+    {
+      href: `#${id}`,
+      onClick,
+      "aria-label": copied ? "Link copied to clipboard" : label ? `Copy link to ${label}` : "Copy link to this section",
+      title: copied ? "Copied!" : "Copy link to this section",
+      className: `${base} ${copied ? active : idle}`,
+      style: { width: 18, height: 18 },
+      children: copied ? /* @__PURE__ */ jsx(CheckIcon, {}) : /* @__PURE__ */ jsx(ChainIcon, {})
+    }
+  );
+}
+function flatten(node) {
+  if (typeof node === "string" || typeof node === "number") return String(node);
+  if (Array.isArray(node)) return node.map(flatten).join("");
+  if (node && typeof node === "object" && "props" in node) {
+    const props = node.props;
+    return props ? flatten(props.children) : "";
+  }
+  return "";
+}
+function PreWrapper(props) {
+  const { children, file, language, ...rest } = props;
+  return /* @__PURE__ */ jsx(
+    CodeBlock,
+    {
+      lang: typeof language === "string" ? language : void 0,
+      filename: typeof file === "string" ? file : void 0,
+      children: /* @__PURE__ */ jsx(InsidePreContext.Provider, { value: true, children: /* @__PURE__ */ jsx(
+        "pre",
+        {
+          ...rest,
+          style: {
+            margin: 0,
+            padding: "14px 16px",
+            fontFamily: "var(--font-doc-template-mono)",
+            fontSize: 12.5,
+            lineHeight: 1.3,
+            overflowX: "auto",
+            background: "transparent",
+            ...rest.style
+          },
+          children
+        }
+      ) })
+    }
+  );
+}
+const H2 = ({ id, children, style, ...rest }) => /* @__PURE__ */ jsxs(Fragment, { children: [
+  id && /* @__PURE__ */ jsx(
+    "span",
+    {
+      id,
+      "aria-hidden": true,
+      "data-toc-anchor": true,
+      "data-toc-level": "2",
+      style: {
+        display: "block",
+        height: 0,
+        marginTop: 16,
+        scrollMarginTop: 56
+      }
+    }
+  ),
+  /* @__PURE__ */ jsxs(
+    "h2",
+    {
+      ...rest,
+      className: "flex items-center text-doc-template-ink group -mx-[18px] px-[18px] lg:-mx-[56px] lg:px-[56px]",
+      style: {
+        position: "sticky",
+        top: 40,
+        zIndex: 3,
+        fontFamily: "var(--font-doc-template-ui)",
+        fontSize: 22,
+        fontWeight: 600,
+        letterSpacing: "-0.018em",
+        marginBottom: 12,
+        paddingTop: 12,
+        paddingBottom: 8,
+        gap: 8,
+        lineHeight: 1.2,
+        backgroundColor: "color-mix(in srgb, var(--color-doc-template-bg) 92%, transparent)",
+        backdropFilter: "saturate(140%) blur(8px)",
+        WebkitBackdropFilter: "saturate(140%) blur(8px)",
+        ...style
+      },
+      children: [
+        children,
+        /* @__PURE__ */ jsx(HeadingAnchor, { id, label: flatten(children) })
+      ]
+    }
+  )
+] });
+const H3 = ({ id, children, style, ...rest }) => /* @__PURE__ */ jsxs(
+  "h3",
+  {
+    id,
+    ...rest,
+    className: "flex items-center text-doc-template-ink group",
+    style: {
+      fontFamily: "var(--font-doc-template-ui)",
+      fontSize: 15,
+      fontWeight: 600,
+      letterSpacing: "-0.005em",
+      margin: "18px 0 6px",
+      gap: 8,
+      scrollMarginTop: 96,
+      ...style
+    },
+    children: [
+      children,
+      /* @__PURE__ */ jsx(HeadingAnchor, { id, label: flatten(children) })
+    ]
+  }
+);
+const H1 = ({ id, children, style, ...rest }) => /* @__PURE__ */ jsxs(
+  "h1",
+  {
+    id,
+    ...rest,
+    className: "flex items-center text-doc-template-ink group",
+    style: {
+      fontFamily: "var(--font-doc-template-ui)",
+      fontSize: 32,
+      fontWeight: 700,
+      letterSpacing: "-0.025em",
+      margin: "18px 0 10px",
+      lineHeight: 1.1,
+      gap: 8,
+      ...style
+    },
+    children: [
+      children,
+      /* @__PURE__ */ jsx(HeadingAnchor, { id, label: flatten(children) })
+    ]
+  }
+);
+const BODY_FONT_SIZE = 14.5;
+const BODY_LINE_HEIGHT = 1.65;
+const P = ({ children, style, ...rest }) => /* @__PURE__ */ jsx(
+  "p",
+  {
+    ...rest,
+    style: {
+      margin: "0 0 14px",
+      fontSize: BODY_FONT_SIZE,
+      lineHeight: BODY_LINE_HEIGHT,
+      textWrap: "pretty",
+      ...style
+    },
+    children
+  }
+);
+const UL = ({ children, style, ...rest }) => /* @__PURE__ */ jsx(
+  "ul",
+  {
+    ...rest,
+    style: {
+      margin: "0 0 14px",
+      paddingLeft: 22,
+      fontSize: BODY_FONT_SIZE,
+      lineHeight: BODY_LINE_HEIGHT,
+      // Tailwind's preflight zeroes list-style on ul/ol; restore the
+      // default disc/decimal markers (muted color is set via ::marker
+      // in app.css, since pseudo-elements can't be styled inline).
+      listStyleType: "disc",
+      listStylePosition: "outside",
+      ...style
+    },
+    children
+  }
+);
+const OL = ({ children, style, ...rest }) => /* @__PURE__ */ jsx(
+  "ol",
+  {
+    ...rest,
+    style: {
+      margin: "0 0 14px",
+      paddingLeft: 22,
+      fontSize: BODY_FONT_SIZE,
+      lineHeight: BODY_LINE_HEIGHT,
+      listStyleType: "decimal",
+      listStylePosition: "outside",
+      ...style
+    },
+    children
+  }
+);
+const LI = ({ children, style, ...rest }) => /* @__PURE__ */ jsx("li", { ...rest, style: { marginBottom: 4, ...style }, children });
+const Blockquote = ({ children, style, ...rest }) => /* @__PURE__ */ jsx(
+  "blockquote",
+  {
+    ...rest,
+    className: "text-doc-template-muted",
+    style: {
+      borderLeft: "3px solid color-mix(in srgb, var(--color-doc-template-ink) 22%, transparent)",
+      padding: "2px 0 2px 16px",
+      margin: "14px 0",
+      ...style
+    },
+    children
+  }
+);
+const A = ({ children, style, ...rest }) => /* @__PURE__ */ jsx(
+  "a",
+  {
+    ...rest,
+    className: "text-doc-template-accent hover:[border-bottom-color:var(--color-doc-template-accent)]",
+    style: {
+      borderBottom: "1px solid color-mix(in srgb, var(--color-doc-template-accent) 35%, transparent)",
+      textDecoration: "none",
+      ...style
+    },
+    children
+  }
+);
+const Table = ({ children, style, ...rest }) => /* @__PURE__ */ jsx("table", { ...rest, style: { width: "100%", borderCollapse: "collapse", fontSize: 13, margin: "0 0 14px", ...style }, children });
+const Th = ({ children, style, ...rest }) => /* @__PURE__ */ jsx(
+  "th",
+  {
+    ...rest,
+    className: "text-doc-template-muted uppercase border-b border-doc-template-faint",
+    style: {
+      fontFamily: "var(--font-doc-template-mono)",
+      fontSize: 10,
+      letterSpacing: "0.12em",
+      textAlign: "left",
+      fontWeight: 600,
+      background: "color-mix(in srgb, var(--color-doc-template-ink) 2%, transparent)",
+      padding: "9px 10px",
+      ...style
+    },
+    children
+  }
+);
+const Td = ({ children, style, ...rest }) => /* @__PURE__ */ jsx(
+  "td",
+  {
+    ...rest,
+    className: "border-b border-doc-template-faint",
+    style: { padding: "9px 10px", verticalAlign: "top", ...style },
+    children
+  }
+);
+const Code = ({ className, children, style, ...rest }) => {
+  const insidePre = useContext(InsidePreContext);
+  const isBlock = insidePre || !!className && /(?:shiki|language-|hljs)/.test(className);
+  if (isBlock) {
+    return /* @__PURE__ */ jsx("code", { className, ...rest, style, children });
+  }
+  return /* @__PURE__ */ jsx(
+    "code",
+    {
+      ...rest,
+      className,
+      style: {
+        fontFamily: "var(--font-doc-template-mono)",
+        fontSize: "0.88em",
+        letterSpacing: "-0.005em",
+        background: "var(--color-doc-template-chip)",
+        border: "1px solid var(--color-doc-template-faint)",
+        padding: "1px 5px",
+        borderRadius: 4,
+        ...style
+      },
+      children
+    }
+  );
+};
+const mdxComponents = {
+  h1: H1,
+  h2: H2,
+  h3: H3,
+  p: P,
+  ul: UL,
+  ol: OL,
+  li: LI,
+  a: A,
+  blockquote: Blockquote,
+  table: Table,
+  th: Th,
+  td: Td,
+  code: Code,
+  pre: PreWrapper,
+  Callout,
+  Preview,
+  StatusTable,
+  TestStatus
+};
+export {
+  mdxComponents
+};

package/dist/index.d.ts

@@ -0,0 +1,61 @@
+import { SiteConfig as _SiteConfig } from './site-config';
+import { PageFrontmatter as _PageFrontmatter } from './lib/navigation';
+import { TabDef as _TabDef } from './lib/tabs';
+/**
+ * @dreamlake/dockit — the DreamLake documentation shell as a library.
+ *
+ * A consuming site initializes the shell once, from a side-effect module
+ * (conventionally `site.config.ts`) imported before the renderer entries:
+ *
+ *   import { initDocs } from '@dreamlake/dockit'
+ *
+ *   initDocs({
+ *     site: { brand: 'DreamLake', subtitle: 'Dockit', … },
+ *     pages: import.meta.glob('./pages/** /+Page.mdx', { eager: true }),
+ *     rawPages: import.meta.glob('./pages/** /+Page.mdx', { eager: true, query: '?raw', import: 'default' }),
+ *     sectionOrder: ['Getting started', 'Reference'],
+ *     tabs: [{ id: 'overview', label: 'Get Started', numeral: 'I', landing: '/', urlPrefix: '/get-started' }],
+ *   })
+ */
+export { siteConfig, defineSiteConfig, type SiteConfig, type VersionChip, } from './site-config';
+export { pages, groupedPages, groupedVisiblePages, initNavigation, getAdjacentPages, type PageMeta, type PageFrontmatter, type PageModule, type NavGroup, } from './lib/navigation';
+export { searchIndex, rawMarkdown, initSearchIndex, search, type SearchEntry, type SearchHit, } from './lib/search-index';
+export { searchPages, defaultResults, type SearchResult, type SubResult, } from './lib/pagefind-search';
+export { TABS, initTabs, tabForUrl, urlInTab, type TabDef } from './lib/tabs';
+export { useHiddenToggle } from './lib/use-hidden-toggle';
+export { useLineNumbers } from './lib/use-line-numbers';
+export { useLocalStorage, DOC_PREFIX, docKey } from './lib/use-local-storage';
+export { useMediaQuery } from './lib/use-media-query';
+export { Callout } from './components/Callout';
+export { ClientOnly } from './components/ClientOnly';
+export { CodeBlock } from './components/CodeBlock';
+export { DocFooter } from './components/DocFooter';
+export { mdxComponents } from './components/mdx-components';
+export { Preview, type PreviewProps } from './components/Preview';
+export { SearchPalette } from './components/SearchPalette';
+export { useSearchResize, SearchResizeHandles } from './components/SearchResize';
+export { Sidebar } from './components/Sidebar';
+export { StatusTable, TestStatus } from './components/StatusTable';
+export { TabStrip } from './components/TabStrip';
+export { ThemeProvider, useTheme, type Theme } from './components/ThemeProvider';
+export { ThemeToggle } from './components/ThemeToggle';
+export { TOC } from './components/TOC';
+export { Topbar } from './components/Topbar';
+export { Layout, useMerge } from './renderer/Layout';
+export interface InitDocsOptions {
+    /** Site branding, URLs, version chips, git hash. */
+    site: Partial<_SiteConfig>;
+    /** Eager glob of every `+Page.mdx` module (frontmatter drives nav). */
+    pages: Record<string, {
+        frontmatter?: _PageFrontmatter;
+    }>;
+    /** Eager `?raw` glob of the same pages — feeds the dev search index and
+     *  the palette's markdown preview. Optional but recommended. */
+    rawPages?: Record<string, string>;
+    /** Authored sidebar section order; unknown sections fall to the end. */
+    sectionOrder?: string[];
+    /** Topbar tab lenses. Omit (or pass []) for a tabless site. */
+    tabs?: _TabDef[];
+}
+/** One call wires the whole shell: site config, navigation, search, tabs. */
+export declare function initDocs(opts: InitDocsOptions): void;

package/dist/index.js

@@ -0,0 +1,81 @@
+import { defineSiteConfig } from "./site-config.js";
+import { siteConfig } from "./site-config.js";
+import { initNavigation } from "./lib/navigation.js";
+import { getAdjacentPages, groupedPages, groupedVisiblePages, pages } from "./lib/navigation.js";
+import { initSearchIndex } from "./lib/search-index.js";
+import { rawMarkdown, search, searchIndex } from "./lib/search-index.js";
+import { defaultResults, searchPages } from "./lib/pagefind-search.js";
+import { initTabs } from "./lib/tabs.js";
+import { TABS, tabForUrl, urlInTab } from "./lib/tabs.js";
+import { useHiddenToggle } from "./lib/use-hidden-toggle.js";
+import { useLineNumbers } from "./lib/use-line-numbers.js";
+import { DOC_PREFIX, docKey, useLocalStorage } from "./lib/use-local-storage.js";
+import { useMediaQuery } from "./lib/use-media-query.js";
+import { Callout } from "./components/Callout.js";
+import { ClientOnly } from "./components/ClientOnly.js";
+import { CodeBlock } from "./components/CodeBlock.js";
+import { DocFooter } from "./components/DocFooter.js";
+import { mdxComponents } from "./components/mdx-components.js";
+import { Preview } from "./components/Preview.js";
+import { SearchPalette } from "./components/SearchPalette.js";
+import { SearchResizeHandles, useSearchResize } from "./components/SearchResize.js";
+import { Sidebar } from "./components/Sidebar.js";
+import { StatusTable, TestStatus } from "./components/StatusTable.js";
+import { TabStrip } from "./components/TabStrip.js";
+import { ThemeProvider, useTheme } from "./components/ThemeProvider.js";
+import { ThemeToggle } from "./components/ThemeToggle.js";
+import { TOC } from "./components/TOC.js";
+import { Topbar } from "./components/Topbar.js";
+import { Layout, useMerge } from "./renderer/Layout.js";
+function initDocs(opts) {
+  defineSiteConfig(opts.site);
+  initNavigation(opts.pages, opts.sectionOrder ?? []);
+  initSearchIndex(opts.rawPages ?? {});
+  initTabs(opts.tabs ?? []);
+}
+export {
+  Callout,
+  ClientOnly,
+  CodeBlock,
+  DOC_PREFIX,
+  DocFooter,
+  Layout,
+  Preview,
+  SearchPalette,
+  SearchResizeHandles,
+  Sidebar,
+  StatusTable,
+  TABS,
+  TOC,
+  TabStrip,
+  TestStatus,
+  ThemeProvider,
+  ThemeToggle,
+  Topbar,
+  defaultResults,
+  defineSiteConfig,
+  docKey,
+  getAdjacentPages,
+  groupedPages,
+  groupedVisiblePages,
+  initDocs,
+  initNavigation,
+  initSearchIndex,
+  initTabs,
+  mdxComponents,
+  pages,
+  rawMarkdown,
+  search,
+  searchIndex,
+  searchPages,
+  siteConfig,
+  tabForUrl,
+  urlInTab,
+  useHiddenToggle,
+  useLineNumbers,
+  useLocalStorage,
+  useMediaQuery,
+  useMerge,
+  useSearchResize,
+  useTheme
+};

package/dist/lib/navigation.d.ts

@@ -0,0 +1,80 @@
+export interface PageMeta {
+    path: string;
+    title: string;
+    section: string;
+    order: number;
+    description?: string;
+    /** True if the page is awaiting review. Surfaced as a chip in the
+     *  sidebar so reviewers can spot what still needs eyes on it. */
+    draft?: boolean;
+    /** True if the page should be hidden from the sidebar by default.
+     *  Toggle visibility via the "show hidden" global state (Cmd+Shift+D).
+     *  The page is still reachable via direct URL. */
+    hidden?: boolean;
+    /** True to emit `<meta name="robots" content="noindex, nofollow">`
+     *  and exclude the page from the pagefind search index. Use for
+     *  internal/dev pages that should not be discoverable by spiders. */
+    noindex?: boolean;
+    /** Right-rail TOC depth. 3 (default) surfaces H2 + H3; 2 limits the
+     *  rail to H2 only. Set in frontmatter on long pages where H3 noise
+     *  crowds the rail. */
+    tocLevel?: 2 | 3;
+    fullscreen?: boolean;
+}
+export interface PageFrontmatter {
+    title?: string;
+    section?: string;
+    order?: number;
+    description?: string;
+    draft?: boolean;
+    hidden?: boolean;
+    noindex?: boolean;
+    tocLevel?: 2 | 3;
+    fullscreen?: boolean;
+}
+export interface PageModule {
+    frontmatter?: PageFrontmatter;
+}
+export interface NavGroup {
+    label: string;
+    items: PageMeta[];
+}
+/**
+ * Module-level singletons, populated by `initNavigation()` from the
+ * consuming site. The arrays are mutated in place (`.length = 0` + push,
+ * never reassigned) so components holding an imported reference always
+ * see the current data.
+ */
+/** All pages, sorted by `order` frontmatter. */
+export declare const pages: PageMeta[];
+/** All pages grouped — includes hidden ones. Components filter for
+ *  visibility themselves so the toggle can flip live without reflowing
+ *  the data layer. */
+export declare const groupedPages: NavGroup[];
+/** Same shape, but filtered to only-visible pages. Equivalent to
+ *  `groupedPages` when no page declares `hidden: true`. */
+export declare const groupedVisiblePages: NavGroup[];
+/**
+ * Populate the navigation singletons from the site's eager page glob:
+ *
+ *   initNavigation(
+ *     import.meta.glob('./pages/** /+Page.mdx', { eager: true }),
+ *     ['Getting started', 'Reference'],
+ *   )
+ */
+export declare function initNavigation(modules: Record<string, {
+    frontmatter?: PageFrontmatter;
+}>, sectionOrder?: string[]): void;
+/** Prev/next adjacency. By default skips `hidden: true` pages so a
+ *  reader walking the docs sequentially never lands on an internal
+ *  page they couldn't see in the sidebar. Pass `{ includeHidden: true }`
+ *  (e.g. from `useHiddenToggle()`) to make hidden pages part of the
+ *  sequence. If the *current* page is itself hidden it is always
+ *  included so the user can step out of it. */
+export declare function getAdjacentPages(path: string, opts?: {
+    includeHidden?: boolean;
+}): {
+    current: PageMeta | null;
+    prev: PageMeta | null;
+    next: PageMeta | null;
+};

package/dist/lib/navigation.js

@@ -0,0 +1,57 @@
+const pages = [];
+const groupedPages = [];
+const groupedVisiblePages = [];
+let sectionOrderList = [];
+function groupPages(items) {
+  const map = /* @__PURE__ */ new Map();
+  for (const p of items) {
+    if (!map.has(p.section)) map.set(p.section, []);
+    map.get(p.section).push(p);
+  }
+  const known = sectionOrderList.filter((s) => map.has(s));
+  const unknown = [...map.keys()].filter((s) => !sectionOrderList.includes(s)).sort();
+  return [...known, ...unknown].map((label) => ({ label, items: map.get(label) }));
+}
+function initNavigation(modules, sectionOrder = []) {
+  sectionOrderList = sectionOrder;
+  const next = Object.entries(modules).map(([filePath, mod]) => {
+    const fm = mod.frontmatter ?? {};
+    const dir = filePath.replace(/^.*?\bpages\//, "").replace(/\/\+Page\.mdx$/, "");
+    const path = dir === "index" ? "/" : `/${dir}`;
+    return {
+      path,
+      title: fm.title ?? dir,
+      section: fm.section ?? "",
+      order: fm.order ?? 99,
+      description: fm.description,
+      draft: fm.draft === true,
+      hidden: fm.hidden === true,
+      noindex: fm.noindex === true,
+      tocLevel: fm.tocLevel,
+      fullscreen: fm.fullscreen === true
+    };
+  }).sort((a, b) => a.order - b.order);
+  pages.length = 0;
+  pages.push(...next);
+  groupedPages.length = 0;
+  groupedPages.push(...groupPages(pages));
+  groupedVisiblePages.length = 0;
+  groupedVisiblePages.push(...groupPages(pages.filter((p) => !p.hidden)));
+}
+function getAdjacentPages(path, opts = {}) {
+  const here = pages.find((p) => p.path === path);
+  const list = opts.includeHidden || here?.hidden ? pages : pages.filter((p) => !p.hidden);
+  const idx = list.findIndex((p) => p.path === path);
+  return {
+    current: idx >= 0 ? list[idx] : null,
+    prev: idx > 0 ? list[idx - 1] : null,
+    next: idx >= 0 && idx < list.length - 1 ? list[idx + 1] : null
+  };
+}
+export {
+  getAdjacentPages,
+  groupedPages,
+  groupedVisiblePages,
+  initNavigation,
+  pages
+};

package/dist/lib/pagefind-search.d.ts

@@ -0,0 +1,21 @@
+export interface SubResult {
+    title: string;
+    url: string;
+    excerptHtml: string;
+}
+export interface SearchResult {
+    path: string;
+    title: string;
+    section: string;
+    description: string;
+    snippet: string;
+    /** Pagefind excerpt with <mark> highlights — empty when using the fallback. */
+    excerptHtml: string;
+    subResults: SubResult[];
+    score: number;
+}
+/** Default (empty-query) results — computed lazily because the
+ *  `searchIndex` singleton is only populated once the consuming site's
+ *  `initDocs()` has run, which happens *after* this module evaluates. */
+export declare function defaultResults(): SearchResult[];
+export declare function searchPages(query: string, limit?: number, showHidden?: boolean): Promise<SearchResult[]>;