@dreamlake/dockit 0.1.1 → 0.2.1

package/dist/index.js

@@ -1,7 +1,7 @@
 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 { findPage, getAdjacentPages, groupedPages, groupedVisiblePages, normalizePath, 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";
@@ -26,6 +26,7 @@ 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 { VersionBadge } from "./components/VersionBadge.js";
 import { Layout, useMerge } from "./renderer/Layout.js";
 function initDocs(opts) {
   defineSiteConfig(opts.site);
@@ -52,9 +53,11 @@ export {
   ThemeProvider,
   ThemeToggle,
   Topbar,
+  VersionBadge,
   defaultResults,
   defineSiteConfig,
   docKey,
+  findPage,
   getAdjacentPages,
   groupedPages,
   groupedVisiblePages,
@@ -63,6 +66,7 @@ export {
   initSearchIndex,
   initTabs,
   mdxComponents,
+  normalizePath,
   pages,
   rawMarkdown,
   search,

package/dist/lib/navigation.d.ts

@@ -29,6 +29,9 @@ export interface PageFrontmatter {
     draft?: boolean;
     hidden?: boolean;
     noindex?: boolean;
+    /** Shorthand for an internal developer note (studio's flag): implies
+     *  both `hidden: true` and `noindex: true`. */
+    dev?: boolean;
     tocLevel?: 2 | 3;
     fullscreen?: boolean;
 }
@@ -54,6 +57,18 @@ 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[];
+/** Normalize a pathname for comparison against `PageMeta.path`: strip any
+ *  query/hash and drop a trailing slash (except for root `/`). Vike's
+ *  prerender and client routing can disagree on the trailing slash — e.g.
+ *  a `/develop` prerender hydrating at `/develop/` — and a raw `===` match
+ *  then resolves the page on the server but not the client, which renders
+ *  *different* DOM (breadcrumb, `aria-current`) on each side and trips
+ *  React hydration. Normalizing both sides keeps SSR and hydration in step. */
+export declare function normalizePath(url: string): string;
+/** Resolve the `PageMeta` for a pathname, tolerant of a trailing slash.
+ *  Prefer this over `pages.find(p => p.path === urlPathname)` anywhere the
+ *  result drives rendered output, so server and client agree. */
+export declare function findPage(urlPathname: string): PageMeta | undefined;
 /**
  * Populate the navigation singletons from the site's eager page glob:
  *

package/dist/lib/navigation.js

@@ -2,6 +2,16 @@ const pages = [];
 const groupedPages = [];
 const groupedVisiblePages = [];
 let sectionOrderList = [];
+function normalizePath(url) {
+  if (!url) return "/";
+  const clean = url.split("?")[0].split("#")[0];
+  if (clean === "/") return "/";
+  return clean.replace(/\/+$/, "") || "/";
+}
+function findPage(urlPathname) {
+  const norm = normalizePath(urlPathname);
+  return pages.find((p) => p.path === norm);
+}
 function groupPages(items) {
   const map = /* @__PURE__ */ new Map();
   for (const p of items) {
@@ -18,6 +28,7 @@ function initNavigation(modules, sectionOrder = []) {
     const fm = mod.frontmatter ?? {};
     const dir = filePath.replace(/^.*?\bpages\//, "").replace(/\/\+Page\.mdx$/, "");
     const path = dir === "index" ? "/" : `/${dir}`;
+    const isDev = fm.dev === true;
     return {
       path,
       title: fm.title ?? dir,
@@ -25,8 +36,8 @@ function initNavigation(modules, sectionOrder = []) {
       order: fm.order ?? 99,
       description: fm.description,
       draft: fm.draft === true,
-      hidden: fm.hidden === true,
-      noindex: fm.noindex === true,
+      hidden: fm.hidden === true || isDev,
+      noindex: fm.noindex === true || isDev,
       tocLevel: fm.tocLevel,
       fullscreen: fm.fullscreen === true
     };
@@ -39,9 +50,10 @@ function initNavigation(modules, sectionOrder = []) {
   groupedVisiblePages.push(...groupPages(pages.filter((p) => !p.hidden)));
 }
 function getAdjacentPages(path, opts = {}) {
-  const here = pages.find((p) => p.path === path);
+  const norm = normalizePath(path);
+  const here = pages.find((p) => p.path === norm);
   const list = opts.includeHidden || here?.hidden ? pages : pages.filter((p) => !p.hidden);
-  const idx = list.findIndex((p) => p.path === path);
+  const idx = list.findIndex((p) => p.path === norm);
   return {
     current: idx >= 0 ? list[idx] : null,
     prev: idx > 0 ? list[idx - 1] : null,
@@ -49,9 +61,11 @@ function getAdjacentPages(path, opts = {}) {
   };
 }
 export {
+  findPage,
   getAdjacentPages,
   groupedPages,
   groupedVisiblePages,
   initNavigation,
+  normalizePath,
   pages
 };

package/dist/renderer/Layout.js

@@ -1,5 +1,5 @@
 import { jsx, jsxs, Fragment } from "react/jsx-runtime";
-import { useState, useContext, createContext, useEffect } from "react";
+import { useState, useMemo, useContext, createContext, useEffect } from "react";
 import { MDXProvider } from "@mdx-js/react";
 import { usePageContext } from "vike-react/usePageContext";
 import { ThemeProvider } from "../components/ThemeProvider.js";
@@ -9,14 +9,14 @@ import { TOC } from "../components/TOC.js";
 import { DocFooter } from "../components/DocFooter.js";
 import { SearchPalette } from "../components/SearchPalette.js";
 import { mdxComponents } from "../components/mdx-components.js";
-import { pages } from "../lib/navigation.js";
+import { findPage } from "../lib/navigation.js";
 import { siteConfig } from "../site-config.js";
 const SPRING = "cubic-bezier(0.4, 0.7, 0.3, 1)";
 const MergeContext = createContext(false);
 const useMerge = () => useContext(MergeContext);
 function PageBreadcrumb() {
   const { urlPathname } = usePageContext();
-  const current = pages.find((p) => p.path === urlPathname);
+  const current = findPage(urlPathname);
   const merged = useMerge();
   if (!current) return null;
   return /* @__PURE__ */ jsxs(
@@ -81,7 +81,7 @@ function HeadSync() {
   const { urlPathname } = usePageContext();
   useEffect(() => {
     if (typeof document === "undefined") return;
-    const current = pages.find((p) => p.path === urlPathname);
+    const current = findPage(urlPathname);
     document.title = current ? `${current.title} — ${siteConfig.brand}` : siteConfig.brand;
     const desc = current?.description ?? "";
     let tag = document.querySelector('meta[name="description"]');
@@ -111,13 +111,20 @@ function HeadSync() {
 }
 function Layout({ children }) {
   const { urlPathname } = usePageContext();
-  const current = pages.find((p) => p.path === urlPathname);
+  const current = findPage(urlPathname);
   const isFullscreen = current?.fullscreen === true;
   const [searchOpen, setSearchOpen] = useState(false);
   const [searchQuery, setSearchQuery] = useState("");
   const [merged, setMerged] = useState(false);
   const [sidebarOpen, setSidebarOpen] = useState(false);
-  return /* @__PURE__ */ jsx(ThemeProvider, { children: /* @__PURE__ */ jsx(MDXProvider, { components: mdxComponents, children: /* @__PURE__ */ jsxs(MergeContext.Provider, { value: merged, children: [
+  const mergedMdxComponents = useMemo(
+    () => ({
+      ...mdxComponents,
+      ...siteConfig.mdxComponents ?? {}
+    }),
+    []
+  );
+  return /* @__PURE__ */ jsx(ThemeProvider, { children: /* @__PURE__ */ jsx(MDXProvider, { components: mergedMdxComponents, children: /* @__PURE__ */ jsxs(MergeContext.Provider, { value: merged, children: [
     /* @__PURE__ */ jsx(
       Topbar,
       {

package/dist/renderer/onRenderHtml.js

@@ -3,14 +3,14 @@ import ReactDOMServer from "react-dom/server";
 import { Layout } from "./Layout.js";
 import { PageContextProvider } from "vike-react/usePageContext";
 import { dangerouslySkipEscape, escapeInject } from "vike/server";
-import { pages } from "../lib/navigation.js";
+import { findPage } from "../lib/navigation.js";
 import { siteConfig } from "../site-config.js";
 async function onRenderHtml(pageContext) {
   const { Page, pageProps, urlPathname } = pageContext;
   const html = ReactDOMServer.renderToString(
     /* @__PURE__ */ jsx(PageContextProvider, { pageContext, children: /* @__PURE__ */ jsx(Layout, { children: /* @__PURE__ */ jsx(Page, { ...pageProps }) }) })
   );
-  const current = pages.find((p) => p.path === urlPathname);
+  const current = findPage(urlPathname);
   const title = current ? `${current.title} — ${siteConfig.brand}` : siteConfig.brand;
   const description = current?.description ?? "";
   const mdHref = current && !current.noindex ? current.path === "/" ? "/index.md" : `${current.path}.md` : null;

package/dist/site-config.d.ts

@@ -55,6 +55,15 @@ export interface SiteConfig {
      *  "Edit this page" link (`<docsRepoUrl>/edit/<docsBranch>/<docsPagesPath>/…`).
      *  Defaults to 'docs/pages'. */
     docsPagesPath?: string;
+    /** Topbar theme control style. `'cycle'` (default) is a single button
+     *  that steps light → system → dark; `'segmented'` is the three-button
+     *  slider with a sliding indicator (the uikit/dreamlake docs style). */
+    themeToggle?: 'cycle' | 'segmented';
+    /** Site-specific MDX components merged over the library's provider map,
+     *  so pages can use custom tags (e.g. `<Card>`, `<ApiStatus>`) without
+     *  per-page imports. Same-name entries override the library's. Typed
+     *  loosely to avoid coupling this module to React. */
+    mdxComponents?: Record<string, unknown>;
 }
 export declare const siteConfig: SiteConfig;
 /** Merge site-provided values into the singleton (mutates in place). */

package/dist/site-config.js

@@ -10,7 +10,8 @@ const siteConfig = {
   summary: "",
   versionChips: [],
   gitHash: "",
-  docsPagesPath: "docs/pages"
+  docsPagesPath: "docs/pages",
+  themeToggle: "cycle"
 };
 function defineSiteConfig(cfg) {
   Object.assign(siteConfig, cfg);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamlake/dockit",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "The DreamLake documentation shell — Vike + React + Tailwind v4 + MDX docs framework with sidebar, TOC, search, and theming",
   "license": "MIT",
   "type": "module",

package/templates/netlify.example.toml

@@ -31,3 +31,14 @@ COREPACK_INTEGRITY_KEYS = "0"
 
 [context.branch-deploy]
   # Applies to every non-production branch push.
+
+# ─── Version switcher (VersionBadge) ─────────────────────────────────
+# The version-switcher dropdown on old v/* branch deploys fetches the
+# production manifest cross-origin so its list never goes stale — that
+# needs a CORS header on /versions.json.
+
+[[headers]]
+for = "/versions.json"
+
+[headers.values]
+Access-Control-Allow-Origin = "*"