@f5-sales-demo/docs-theme 4.4.2 → 4.4.4

package/components/ProviderHeader.astro

@@ -0,0 +1,116 @@
+---
+import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
+import Search from 'virtual:starlight/components/Search';
+import SiteTitle from 'virtual:starlight/components/SiteTitle';
+import SocialIcons from 'virtual:starlight/components/SocialIcons';
+import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
+import config from 'virtual:starlight/user-config';
+import megaMenuConfig from 'virtual:starlight-mega-menu/config';
+import MegaMenu from '@f5-sales-demo/starlight-mega-menu/components/MegaMenu.tsx';
+import MegaMenuMobile from '@f5-sales-demo/starlight-mega-menu/components/MegaMenuMobile.tsx';
+
+/**
+ * Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
+ */
+const shouldRenderSearch = config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
+---
+
+<div class="header sl-mega-menu-header">
+	<div class="title-wrapper sl-flex">
+		<SiteTitle />
+	</div>
+	<nav class="smm-desktop-nav">
+		<MegaMenu client:only="react" config={megaMenuConfig} />
+	</nav>
+	<div class="sl-flex print:hidden">
+		{shouldRenderSearch && <Search />}
+	</div>
+	<div class="smm-mobile-toggle">
+		<MegaMenuMobile client:only="react" config={megaMenuConfig} />
+	</div>
+</div>
+
+<style>
+	@layer starlight.core {
+		.header {
+			display: flex;
+			gap: var(--sl-nav-gap);
+			justify-content: space-between;
+			align-items: center;
+			height: 100%;
+		}
+
+		.title-wrapper {
+			/* Prevent long titles overflowing and covering the search and menu buttons on narrow viewports. */
+			overflow: clip;
+			/* Avoid clipping focus ring around link inside title wrapper. */
+			padding: 0.25rem;
+			margin: -0.25rem;
+			min-width: 0;
+		}
+
+		.right-group,
+		.social-icons {
+			gap: 1rem;
+			align-items: center;
+		}
+		.social-icons::after {
+			content: '';
+			height: 2rem;
+			border-inline-end: 1px solid var(--sl-color-gray-5);
+		}
+
+		/* Desktop nav is hidden on small screens */
+		.smm-desktop-nav {
+			display: none;
+		}
+
+		/* Mobile toggle is visible on small screens */
+		.smm-mobile-toggle {
+			display: flex;
+			align-items: center;
+		}
+
+		@media (min-width: 50rem) {
+			:global(:root[data-has-sidebar]) {
+				--__sidebar-pad: calc(2 * var(--sl-nav-pad-x));
+			}
+			:global(:root:not([data-has-toc])) {
+				--__toc-width: 0rem;
+			}
+			.header {
+				--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
+				--__main-column-fr: calc(
+					(
+							100% + var(--__sidebar-pad, 0rem) - var(--__toc-width, var(--sl-sidebar-width)) -
+								(2 * var(--__toc-width, var(--sl-nav-pad-x))) - var(--sl-content-inline-start, 0rem) -
+								var(--sl-content-width)
+						) / 2
+				);
+				display: grid;
+				grid-template-columns:
+					/* 1 (site title) */
+					auto
+					/* 2 (mega-menu nav) */
+					1fr
+					/* 3 (search box) */
+					auto
+					/* 4 (right items) */
+					auto;
+				align-content: center;
+			}
+
+			/* Show desktop nav, hide mobile toggle */
+			.smm-desktop-nav {
+				display: flex;
+				align-items: center;
+				justify-content: center;
+				min-width: 0;
+			}
+
+			.smm-mobile-toggle {
+				display: none;
+			}
+		}
+	}
+</style>

package/components/ProviderSidebar.astro

@@ -0,0 +1,6 @@
+---
+import ProviderSidebarTree from './ProviderSidebarTree.astro';
+
+const { sidebar } = Astro.locals.starlightRoute;
+---
+<nav aria-label="Provider reference"><ProviderSidebarTree entries={sidebar} /></nav>

package/components/ProviderSidebarTree.astro

@@ -0,0 +1,21 @@
+---
+import type { StarlightRouteData } from '@astrojs/starlight/route-data';
+
+interface Props {
+  entries: StarlightRouteData['sidebar'];
+}
+const { entries } = Astro.props;
+---
+<ul>{entries.map(entry => <li>{entry.type === 'link'
+  ? <a href={entry.href} aria-current={entry.isCurrent ? 'page' : undefined}>{entry.label}</a>
+  : <details open={!entry.collapsed}><summary>{entry.label}</summary><Astro.self entries={entry.entries} /></details>}
+</li>)}</ul>
+<style>
+ul { list-style: none; padding: 0; margin: 0; }
+ul ul { padding-inline-start: .75rem; border-inline-start: 1px solid var(--sl-color-gray-5); }
+li { margin: .3rem 0; overflow-wrap: anywhere; }
+a { display: block; padding: .2rem .4rem; color: var(--sl-color-gray-2); text-decoration: none; font-size: var(--sl-text-sm); }
+a:hover { color: var(--sl-color-white); }
+a[aria-current] { background: var(--sl-color-accent-low); color: var(--sl-color-accent-high); border-inline-start: 2px solid var(--sl-color-accent); }
+summary { cursor: pointer; padding: .25rem; font-weight: 600; font-size: var(--sl-text-sm); }
+</style>

package/config.ts

@@ -33,6 +33,7 @@ import { sidebarTranslations } from './src/i18n/translations.ts';
 import remarkMermaid from './src/plugins/remark-mermaid.mjs';
 import { providerMegaMenu } from './src/utils/canonical-provider.ts';
 import { resolveMegaMenuIcon } from './src/utils/resolve-icon.ts';
+import providerSharedAssets from './src/utils/share-provider-assets.mjs';
 import { buildSubcategorySidebar } from './src/utils/subcategory-sidebar.ts';
 
 export type { LocaleConfig } from './src/i18n/locales.ts';
@@ -922,6 +923,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
         ],
       }),
       react(),
+      ...(canonicalProvider ? [providerSharedAssets()] : []),
       ...additionalIntegrations,
     ],
   });

package/index.ts

@@ -24,6 +24,12 @@ export default function f5xcDocsTheme(): StarlightPlugin {
           ],
           components: {
             ...config.components,
+            ...(process.env.DOCS_PROFILE === 'canonical-provider'
+              ? {
+                  Header: '@f5-sales-demo/docs-theme/components/ProviderHeader.astro',
+                  Sidebar: '@f5-sales-demo/docs-theme/components/ProviderSidebar.astro',
+                }
+              : {}),
             Banner: '@f5-sales-demo/docs-theme/components/Banner.astro',
             EditLink: '@f5-sales-demo/docs-theme/components/EditLink.astro',
             Footer: '@f5-sales-demo/docs-theme/components/Footer.astro',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.4.2",
+  "version": "4.4.4",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {
@@ -41,7 +41,9 @@
     "./src/i18n/translator.ts": "./src/i18n/translator.ts",
     "./src/i18n/prompt.ts": "./src/i18n/prompt.ts",
     "./src/utils/localize-ecosystem-href.ts": "./src/utils/localize-ecosystem-href.ts",
-    "./canonical-route-middleware": "./canonical-route-middleware.ts"
+    "./canonical-route-middleware": "./canonical-route-middleware.ts",
+    "./components/ProviderSidebar.astro": "./components/ProviderSidebar.astro",
+    "./components/ProviderHeader.astro": "./components/ProviderHeader.astro"
   },
   "files": [
     "index.ts",

package/src/utils/share-provider-assets.mjs

@@ -0,0 +1,61 @@
+import { createHash } from 'node:crypto';
+import { mkdir, readdir, readFile, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const hash = (value) => createHash('sha256').update(value).digest('hex').slice(0, 24);
+// Input is Astro-generated HTML. Keep each asset's original execution position
+// and SVG attributes; only identical generated bytes share a file.
+export async function shareProviderAssets(root, base = '/') {
+  const files = (await readdir(root, { recursive: true })).filter((file) => file.endsWith('.html'));
+  const assetRoot = join(root, '_shared');
+  const assets = new Map();
+  const prefix = `${base.replace(/\/$/, '')}/_shared/`;
+  let saved = 0;
+  await mkdir(assetRoot, { recursive: true });
+  for (const file of files) {
+    const path = join(root, file);
+    const before = await readFile(path, 'utf8');
+    let html = before.replace(/<script\b([^>]*)>([\s\S]*?)<\/script>/g, (original, attrs, body) => {
+      if (/\bsrc\s*=/.test(attrs) || !body.trim() || /type=["'](?:application\/|text\/template)/.test(attrs))
+        return original;
+      const name = `${hash(body)}.js`;
+      assets.set(name, body);
+      return `<script${attrs} src="${prefix}${name}"></script>`;
+    });
+    const islands = [];
+    html = html.replace(/<astro-island\b[\s\S]*?<\/astro-island>/g, (island) => {
+      islands.push(island);
+      return `<!--provider-island-${islands.length - 1}-->`;
+    });
+    html = html.replace(/<svg\b([^>]*)>([\s\S]*?)<\/svg>/g, (original, attrs, body) => {
+      // Sprite definitions and interactive SVG content must remain inline.
+      if (/<(?:symbol|script|foreignObject)\b/.test(body) || /\bid=/.test(attrs) || /\bon\w+=/.test(attrs))
+        return original;
+      const name = `${hash(body)}.svg`;
+      assets.set(name, `<svg xmlns="http://www.w3.org/2000/svg"><symbol id="icon">${body}</symbol></svg>`);
+      return `<svg${attrs}><use href="${prefix}${name}#icon"></use></svg>`;
+    });
+    html = html.replace(/<!--provider-island-(\d+)-->/g, (_, index) => islands[Number(index)]);
+    saved += Buffer.byteLength(before) - Buffer.byteLength(html);
+    await writeFile(path, html);
+  }
+  let assetBytes = 0;
+  for (const [name, body] of assets) {
+    await writeFile(join(assetRoot, name), body);
+    assetBytes += Buffer.byteLength(body);
+  }
+  return { pages: files.length, assets: assets.size, savedBytes: saved - assetBytes };
+}
+
+export default function providerSharedAssets() {
+  return {
+    name: 'f5-canonical-shared-assets',
+    hooks: {
+      'astro:build:done': async ({ dir, logger }) => {
+        const result = await shareProviderAssets(fileURLToPath(dir), process.env.DOCS_BASE || '/');
+        logger.info(`Shared canonical assets: ${JSON.stringify(result)}`);
+      },
+    },
+  };
+}

package/src/utils/share-provider-assets.test.ts

@@ -0,0 +1,25 @@
+import { mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { expect, it } from 'vitest';
+import { shareProviderAssets } from './share-provider-assets.mjs';
+
+it('shares identical generated assets, preserving script order and SVG dimensions', async () => {
+  const root = await mkdtemp(join(tmpdir(), 'shared-provider-'));
+  try {
+    const text =
+      '<h1>Reference</h1><script>window.example=1;</script><svg width="16" viewBox="0 0 24 24"><path d="M1 2"/></svg><script src="keep.js"></script>';
+    await writeFile(join(root, 'one.html'), text);
+    await writeFile(join(root, 'two.html'), text);
+    const result = await shareProviderAssets(root, '/provider/version/');
+    expect(result.assets).toBe(2);
+    const html = await readFile(join(root, 'one.html'), 'utf8');
+    expect(html).toContain('<h1>Reference</h1>');
+    expect(html).toMatch(/<script src="\/provider\/version\/_shared\/[a-f0-9]+\.js"><\/script>/);
+    expect(html).toContain('<svg width="16" viewBox="0 0 24 24"><use');
+    expect(html).toContain('<script src="keep.js"></script>');
+    expect(await readFile(join(root, 'two.html'), 'utf8')).toBe(html);
+  } finally {
+    await rm(root, { recursive: true, force: true });
+  }
+});