@dogsbay/format-astro 0.2.0-beta.149 → 0.2.0-beta.150

package/dist/blog.js

@@ -300,6 +300,8 @@ const title = pageNo === 1 ? siteConfig.siteName : \`\${siteConfig.siteName} —
   themeColor={siteConfig.themeColor || undefined}
   repoUrl={siteConfig.repoUrl || undefined}
   poweredBy={siteConfig.poweredBy !== false}
+  siteChrome={(siteConfig as { chrome?: never }).chrome}
+  copyright={(siteConfig as { chrome?: unknown }).chrome ? siteConfig.copyright || undefined : undefined}
   plausibleDomain={siteConfig.plausible?.domain}
   plausibleScriptUrl={siteConfig.plausible?.scriptUrl}
   tagPrefixes={siteConfig.tagPrefixes}

package/dist/project.d.ts

@@ -1,4 +1,5 @@
 import type { ExportPage, NavItem } from "@dogsbay/types";
+import { type SiteChrome } from "@dogsbay/site-files";
 import { type VersionMenu, type ProductModel } from "@dogsbay/site-files";
 import { type BlogEmitConfig } from "./blog.js";
 import { type RedirectsConfig } from "./redirects.js";
@@ -44,6 +45,17 @@ export interface AstroProjectOptions {
     repoUrl?: string;
     editUri?: string;
     copyright?: string;
+    /**
+     * The site's chrome (@dogsbay/site-files `siteChrome`: logo, colour mode, announcement, header
+     * links, footer columns), written into site.json as `chrome`. With it, `copyright` is inline
+     * Markdown (the agreed rule); without it (legacy callers), copyright stays HTML as given.
+     */
+    chrome?: SiteChrome;
+    /** The chrome's logo files, absolute, checked inside the project by the caller. */
+    chromeLogoFiles?: {
+        light: string;
+        dark?: string;
+    };
     /** The line under the site name in the sidebar header (`site.tagline`). Default "Documentation". */
     tagline?: string;
     /** `content.imageCaptions`: a titled block image is a captioned figure. */

package/dist/project.js

@@ -60,6 +60,7 @@ function combinedPrefix(options) {
     return combinePrefix(urlBase, normalizeBasePath(options.basePath));
 }
 import { detectLeadingNodes, deriveDescription } from "./lead.js";
+import { chromeData, copyrightHtml } from "./site-chrome.js";
 import { collectRedirects, renderMetaRefreshPage, renderRedirectsFile, stubPathForRule, } from "./redirects.js";
 /**
  * Recursively prefix all hrefs in a nav tree.
@@ -589,7 +590,14 @@ function buildSiteConfig(siteName, options, outputDir) {
     if (options.editUri)
         cfg.editUri = options.editUri;
     if (options.copyright)
-        cfg.copyright = options.copyright;
+        cfg.copyright = options.chrome ? copyrightHtml(options.copyright, combinedPrefix(options)) : options.copyright;
+    if (options.chrome && outputDir) {
+        cfg.chrome = chromeData(options.chrome, outputDir, {
+            combined: combinedPrefix(options),
+            urlBase: parseSiteUrl(options.siteUrl).urlBase,
+            logoFiles: options.chromeLogoFiles,
+        });
+    }
     if (options.tagline)
         cfg.tagline = options.tagline;
     // Written explicitly, both ways: the default is ON, so an ABSENT key in
@@ -1505,6 +1513,8 @@ const favicon = (siteConfigData as { favicon?: string }).favicon;
   favicon={favicon}
   noindex={true}
   excludeFromSearch={true}
+  siteChrome={(siteConfigData as { chrome?: never }).chrome}
+  copyright={(siteConfig as { chrome?: unknown }).chrome ? siteConfig.copyright || undefined : undefined}
   ogType="website"${productMenu ? `
   switcherMap={{ versions: [], byLogicalKey: {}, products: switcherMapData.products } as never}` : ""}
 >
@@ -2146,6 +2156,10 @@ export async function emitAstroPages(pages, nav, outputDir, options) {
                 `  linkIcons={siteConfig.linkIcons}`,
                 // Default ON: an absent key means yes, `false` means no.
                 `  poweredBy={siteConfig.poweredBy !== false}`,
+                // site.copyright (inline Markdown, rendered into site.json): written there and never shown until 2026-10-30
+                `  copyright={(siteConfig as { chrome?: unknown }).chrome ? siteConfig.copyright || undefined : undefined}`,
+                // The site's chrome (site-chrome.ts): logo, colour mode, announcement, header links, footer
+                `  siteChrome={(siteConfigData as { chrome?: never }).chrome}`,
                 `  multiSource={${pageLiteral(page.multiSource ?? null)} ?? undefined}`,
                 `  switcherMap={switcherMapData}`,
                 // basePath here is the COMBINED URL prefix (urlBase from

package/dist/site-chrome.d.ts

@@ -0,0 +1,60 @@
+import { type SiteChrome } from "@dogsbay/site-files";
+/** What DocsLayout reads (`chrome` in site.json). */
+export interface ChromeData {
+    colorMode: "light" | "dark" | "system";
+    logo?: {
+        light: string;
+        dark?: string;
+        alt: string;
+        replacesName: boolean;
+    };
+    announcement?: {
+        id: string;
+        html: string;
+        tone: string;
+        closeable: boolean;
+    };
+    header: {
+        links: Array<{
+            label: string;
+            href: string;
+        } | {
+            label: string;
+            items: Array<{
+                label: string;
+                href: string;
+            }>;
+        }>;
+        social: ChromeSocial[];
+    };
+    footer: {
+        columns: Array<{
+            title: string;
+            links: Array<{
+                label: string;
+                href: string;
+            }>;
+        }>;
+        social: ChromeSocial[];
+    };
+}
+export interface ChromeSocial {
+    label: string;
+    href: string;
+    svg: string;
+}
+export interface ChromeEmitOptions {
+    /** The URL prefix site paths take (urlBase + basePath). */
+    combined: string;
+    /** The host's base (the path of site.url): where `public/` is served. */
+    urlBase: string;
+    /** The logo files, absolute and already checked inside the project by the caller. */
+    logoFiles?: {
+        light: string;
+        dark?: string;
+    };
+}
+/** `chrome` for site.json; copies the logo files into `<outputDir>/public/_dogsbay/site/`. */
+export declare function chromeData(chrome: SiteChrome, outputDir: string, o: ChromeEmitOptions): ChromeData;
+/** `site.copyright` as HTML: inline Markdown, links with the site's prefix. */
+export declare function copyrightHtml(copyright: string, combined: string): string;

package/dist/site-chrome.js

@@ -0,0 +1,56 @@
+/**
+ * The site's chrome (@dogsbay/site-files `siteChrome`) as DocsLayout draws it, written into
+ * `src/data/site.json` as `chrome`: links with the site's prefix, the texts rendered once with
+ * site-files' inline Markdown (the same HTML as dogsbay-ssg), the brand icons as SVG, and the
+ * logo files copied to `public/_dogsbay/site/` (served from the host's base, as the favicon).
+ * See plans/site-chrome.md.
+ */
+import { mkdirSync } from "node:fs";
+import { extname, join } from "node:path";
+import { inlineMarkdownHtml, isChromeMenu, versionMenuHref } from "@dogsbay/site-files";
+import { socialIconSvg } from "@dogsbay/icons/social";
+import { copyFileSync } from "./write-if-changed.js";
+/** `chrome` for site.json; copies the logo files into `<outputDir>/public/_dogsbay/site/`. */
+export function chromeData(chrome, outputDir, o) {
+    const href = (h) => versionMenuHref(h, o.combined);
+    const social = (list) => list.flatMap((s) => {
+        const svg = socialIconSvg(s.icon, 20);
+        return svg ? [{ label: s.label, href: href(s.href), svg }] : [];
+    });
+    const data = {
+        colorMode: chrome.colorMode,
+        header: {
+            links: chrome.header.links.map((l) => (isChromeMenu(l) ? { label: l.label, items: l.items.map((i) => ({ label: i.label, href: href(i.href) })) } : { label: l.label, href: href(l.href) })),
+            social: social(chrome.header.social),
+        },
+        footer: {
+            columns: chrome.footer.columns.map((c) => ({ title: c.title, links: c.links.map((l) => ({ label: l.label, href: href(l.href) })) })),
+            social: social(chrome.footer.social),
+        },
+    };
+    if (chrome.announcement) {
+        const a = chrome.announcement;
+        data.announcement = { id: a.id, html: inlineMarkdownHtml(a.text, { href }), tone: a.tone, closeable: a.closeable };
+    }
+    if (chrome.logo && o.logoFiles) {
+        const dir = join(outputDir, "public", "_dogsbay", "site");
+        mkdirSync(dir, { recursive: true });
+        // The type is the config's path's (checked by siteChrome), not a symbolic link target's
+        const served = (from, written, name) => {
+            const file = `${name}${extname(written).toLowerCase()}`;
+            copyFileSync(from, join(dir, file));
+            return `${o.urlBase}/_dogsbay/site/${file}`;
+        };
+        data.logo = {
+            light: served(o.logoFiles.light, chrome.logo.light, "logo-light"),
+            ...(o.logoFiles.dark && chrome.logo.dark ? { dark: served(o.logoFiles.dark, chrome.logo.dark, "logo-dark") } : {}),
+            alt: chrome.logo.alt,
+            replacesName: chrome.logo.replacesName,
+        };
+    }
+    return data;
+}
+/** `site.copyright` as HTML: inline Markdown, links with the site's prefix. */
+export function copyrightHtml(copyright, combined) {
+    return inlineMarkdownHtml(copyright, { href: (h) => versionMenuHref(h, combined) });
+}

package/dist/taxonomy.js

@@ -412,6 +412,8 @@ ${displayConfig}
   themeColor={siteConfig.themeColor || undefined}
   repoUrl={siteConfig.repoUrl || undefined}
   poweredBy={siteConfig.poweredBy !== false}
+  siteChrome={(siteConfig as { chrome?: never }).chrome}
+  copyright={(siteConfig as { chrome?: unknown }).chrome ? siteConfig.copyright || undefined : undefined}
   plausibleDomain={siteConfig.plausible?.domain}
   plausibleScriptUrl={siteConfig.plausible?.scriptUrl}
   tagPrefixes={siteConfig.tagPrefixes}
@@ -470,6 +472,8 @@ const title = \`\${term.label} — ${escapeTemplate(taxonomyDisplay)}\`;
   themeColor={siteConfig.themeColor || undefined}
   repoUrl={siteConfig.repoUrl || undefined}
   poweredBy={siteConfig.poweredBy !== false}
+  siteChrome={(siteConfig as { chrome?: never }).chrome}
+  copyright={(siteConfig as { chrome?: unknown }).chrome ? siteConfig.copyright || undefined : undefined}
   plausibleDomain={siteConfig.plausible?.domain}
   plausibleScriptUrl={siteConfig.plausible?.scriptUrl}
   tagPrefixes={siteConfig.tagPrefixes}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dogsbay/format-astro",
-  "version": "0.2.0-beta.149",
+  "version": "0.2.0-beta.150",
   "description": "Astro format plugin for Dogsbay — export TreeNode[] to Astro component markup",
   "type": "module",
   "main": "dist/index.js",
@@ -32,12 +32,13 @@
   "license": "MIT",
   "dependencies": {
     "markdown-it": "^14.3.0",
-    "@dogsbay/format-dogsbay-md": "0.2.0-beta.149",
-    "@dogsbay/render-html": "0.2.0-beta.149",
-    "@dogsbay/serialize-core": "0.2.0-beta.149",
-    "@dogsbay/site-files": "0.2.0-beta.149",
-    "@dogsbay/types": "0.2.0-beta.149",
-    "@dogsbay/ui": "0.2.0-beta.149"
+    "@dogsbay/format-dogsbay-md": "0.2.0-beta.150",
+    "@dogsbay/icons": "0.2.0-beta.150",
+    "@dogsbay/render-html": "0.2.0-beta.150",
+    "@dogsbay/site-files": "0.2.0-beta.150",
+    "@dogsbay/serialize-core": "0.2.0-beta.150",
+    "@dogsbay/types": "0.2.0-beta.150",
+    "@dogsbay/ui": "0.2.0-beta.150"
   },
   "repository": {
     "type": "git",