@f5-sales-demo/docs-theme 3.9.0

package/fonts/font-face.css

@@ -0,0 +1,79 @@
+@font-face {
+  font-family: neusaNextProWide;
+  font-weight: 300;
+  font-style: normal;
+  font-display: swap;
+  src: url("./neusaNextProWide-300.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: neusaNextProWide;
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+  src: url("./neusaNextProWide-400.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: neusaNextProWide;
+  font-weight: 500;
+  font-style: normal;
+  font-display: swap;
+  src: url("./neusaNextProWide-500.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: neusaNextProWide;
+  font-weight: 700;
+  font-style: normal;
+  font-display: swap;
+  src: url("./neusaNextProWide-700.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: neusaNextProWide;
+  font-weight: 400;
+  font-style: italic;
+  font-display: swap;
+  src: url("./neusaNextProWide-400i.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: neusaNextProWide;
+  font-weight: 700;
+  font-style: italic;
+  font-display: swap;
+  src: url("./neusaNextProWide-700i.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: proximaNova;
+  font-weight: 400;
+  font-style: normal;
+  font-display: swap;
+  src: url("./proximaNova-400.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: proximaNova;
+  font-weight: 500;
+  font-style: normal;
+  font-display: swap;
+  src: url("./proximaNova-500.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: proximaNova;
+  font-weight: 600;
+  font-style: normal;
+  font-display: swap;
+  src: url("./proximaNova-600.woff2") format("woff2");
+}
+
+@font-face {
+  font-family: proximaNova;
+  font-weight: 700;
+  font-style: normal;
+  font-display: swap;
+  src: url("./proximaNova-700.woff2") format("woff2");
+}

package/index.ts

@@ -0,0 +1,36 @@
+import type { StarlightPlugin } from '@astrojs/starlight/types';
+import { translations } from './src/i18n/translations.ts';
+
+export default function f5xcDocsTheme(): StarlightPlugin {
+  return {
+    name: '@f5xc-salesdemos/docs-theme',
+    hooks: {
+      'i18n:setup'({ injectTranslations }) {
+        injectTranslations(translations);
+      },
+      'config:setup'({ config, updateConfig, addRouteMiddleware, logger }) {
+        addRouteMiddleware({
+          entrypoint: '@f5xc-salesdemos/docs-theme/route-middleware',
+          order: 'pre',
+        });
+        updateConfig({
+          customCss: [
+            ...(config.customCss ?? []),
+            '@f5xc-salesdemos/docs-theme/fonts/font-face.css',
+            '@f5xc-salesdemos/docs-theme/styles/custom.css',
+          ],
+          components: {
+            ...config.components,
+            Banner: '@f5xc-salesdemos/docs-theme/components/Banner.astro',
+            EditLink: '@f5xc-salesdemos/docs-theme/components/EditLink.astro',
+            Footer: '@f5xc-salesdemos/docs-theme/components/Footer.astro',
+            SiteTitle: '@f5xc-salesdemos/docs-theme/components/SiteTitle.astro',
+            MarkdownContent:
+              process.env.DOCS_MARKDOWN_CONTENT || '@f5xc-salesdemos/docs-theme/components/MarkdownContent.astro',
+          },
+        });
+        logger.info('F5 XC docs theme loaded');
+      },
+    },
+  };
+}

package/package.json

@@ -0,0 +1,135 @@
+{
+  "name": "@f5-sales-demo/docs-theme",
+  "_scope_migrated": true,
+  "version": "3.9.0",
+  "description": "F5 Distributed Cloud branded Starlight documentation theme",
+  "type": "module",
+  "bin": {
+    "docs-translate": "./bin/translate.mjs"
+  },
+  "license": "MIT",
+  "homepage": "https://f5-sales-demo.github.io/docs-theme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/f5-sales-demo/docs-theme"
+  },
+  "bugs": {
+    "url": "https://github.com/f5-sales-demo/docs-theme/issues"
+  },
+  "exports": {
+    ".": "./index.ts",
+    "./fonts/font-face.css": "./fonts/font-face.css",
+    "./styles/custom.css": "./styles/custom.css",
+    "./components/Banner.astro": "./components/Banner.astro",
+    "./components/EditLink.astro": "./components/EditLink.astro",
+    "./components/Footer.astro": "./components/Footer.astro",
+    "./components/SiteTitle.astro": "./components/SiteTitle.astro",
+    "./components/MarkdownContent.astro": "./components/MarkdownContent.astro",
+    "./assets/f5-logo.svg": "./assets/f5-logo.svg",
+    "./assets/github-avatar.png": "./assets/github-avatar.png",
+    "./assets/f5-distributed-cloud.svg": "./assets/f5-distributed-cloud.svg",
+    "./config": "./config.ts",
+    "./route-middleware": "./route-middleware.ts",
+    "./src/plugins/remark-mermaid.mjs": "./src/plugins/remark-mermaid.mjs",
+    "./components/Icon.astro": "./components/Icon.astro",
+    "./components/LinkCard.astro": "./components/LinkCard.astro",
+    "./components/Screenshot.astro": "./components/Screenshot.astro",
+    "./src/utils/resolve-icon.ts": "./src/utils/resolve-icon.ts",
+    "./src/i18n/locales.ts": "./src/i18n/locales.ts",
+    "./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"
+  },
+  "files": [
+    "index.ts",
+    "config.ts",
+    "route-middleware.ts",
+    "astro.config.mjs",
+    "bin/",
+    "fonts/",
+    "styles/",
+    "assets/",
+    "components/",
+    "src/"
+  ],
+  "keywords": [
+    "starlight",
+    "theme",
+    "astro",
+    "withastro",
+    "starlight-theme",
+    "f5",
+    "f5xc",
+    "documentation",
+    "docs-theme"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.50.0",
+    "vitest": "^4.1.9"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:visual": "playwright test",
+    "test:visual:update": "playwright test --update-snapshots"
+  },
+  "peerDependencies": {
+    "@astrojs/markdown-remark": ">=7.0.0",
+    "@astrojs/starlight": ">=0.38.0",
+    "@f5-sales-demo/icons-f5-brand": "*",
+    "@f5-sales-demo/icons-f5xc": "*",
+    "@f5-sales-demo/icons-hashicorp-flight": "*",
+    "@iconify-json/carbon": "*",
+    "@iconify-json/lucide": "*",
+    "@iconify-json/mdi": "*",
+    "@iconify-json/ph": "*",
+    "@iconify-json/tabler": "*",
+    "astro": ">=6.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@iconify-json/lucide": {
+      "optional": true
+    },
+    "@iconify-json/carbon": {
+      "optional": true
+    },
+    "@iconify-json/mdi": {
+      "optional": true
+    },
+    "@iconify-json/ph": {
+      "optional": true
+    },
+    "@iconify-json/tabler": {
+      "optional": true
+    },
+    "@f5-sales-demo/icons-f5-brand": {
+      "optional": true
+    },
+    "@f5-sales-demo/icons-f5xc": {
+      "optional": true
+    },
+    "@f5-sales-demo/icons-hashicorp-flight": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@anthropic-ai/sdk": "^0.106.0",
+    "@astrojs/react": "^6.0.0",
+    "@f5-sales-demo/i18n-core": "^1.0.0",
+    "@f5-sales-demo/starlight-llms-txt": "1.3.1",
+    "@f5-sales-demo/starlight-mega-menu": "^2.0.0",
+    "gray-matter": "^4.0.3",
+    "remark-code-import": "^1.2.0",
+    "starlight-heading-badges": "^0.7.0",
+    "starlight-image-zoom": "^0.15.0",
+    "starlight-openapi": "^0.25.3",
+    "starlight-page-actions": "^0.6.0",
+    "starlight-plugin-icons": "^1.1.3",
+    "starlight-scroll-to-top": "^1.0.1",
+    "starlight-videos": "^0.4.0",
+    "unist-util-visit": "^5.0.0"
+  }
+}

package/route-middleware.ts

@@ -0,0 +1,73 @@
+import type { StarlightRouteData } from '@astrojs/starlight/route-data';
+import { defineRouteMiddleware } from '@astrojs/starlight/route-data';
+import { itemLabels, menuLabels } from './src/i18n/mega-menu-translations.ts';
+
+const titleTranslations: Record<string, Record<string, string>> = { ...menuLabels, ...itemLabels };
+
+type SidebarEntry = StarlightRouteData['sidebar'][number];
+
+function isIndexPage(filePath: string | undefined): boolean {
+  if (!filePath) return false;
+  return /(?:^|[\\/])index\.mdx?$/.test(filePath);
+}
+
+function hrefToSlug(href: string): string {
+  const base = import.meta.env.BASE_URL.replace(/\/$/, '');
+  let s = href;
+  if (base && s.startsWith(base)) s = s.slice(base.length);
+  s = s.replace(/^\/+|\/+$/g, '');
+  if (s.endsWith('.html')) s = s.slice(0, -5);
+  if (s === 'index') s = '';
+  return s;
+}
+
+// Discover all index pages at build time via Vite glob — no astro:content needed
+const indexPaths = Object.keys(
+  import.meta.glob(['/src/content/docs/**/index.md', '/src/content/docs/**/index.mdx'], { eager: false }),
+);
+
+const indexSlugs = new Set<string>(
+  indexPaths.map((p) => {
+    const relative = p.replace(/^\/src\/content\/docs\//, '').replace(/\/?index\.mdx?$/, '');
+    // Strip locale prefix (e.g., "en/guides" → "guides")
+    return relative.replace(/^[a-z]{2}(-[a-z]{2,4})?\/?/, '');
+  }),
+);
+
+function filterIndexPages(entries: SidebarEntry[], slugs: Set<string>): SidebarEntry[] {
+  return entries.reduce<SidebarEntry[]>((acc, entry) => {
+    if (entry.type === 'link') {
+      const slug = hrefToSlug(entry.href);
+      if (!slugs.has(slug)) {
+        acc.push(entry);
+      }
+    } else {
+      acc.push({
+        ...entry,
+        entries: filterIndexPages(entry.entries, slugs),
+      });
+    }
+    return acc;
+  }, []);
+}
+
+export const onRequest = defineRouteMiddleware(async (context, next) => {
+  const route = context.locals.starlightRoute;
+  const entry = route.entry;
+
+  if (isIndexPage(entry.filePath)) {
+    // Unconditionally hide TOC on index pages
+    route.toc = undefined;
+  }
+
+  if (indexSlugs.size > 0) {
+    route.sidebar = filterIndexPages(route.sidebar, indexSlugs);
+  }
+
+  if (route.lang && route.lang !== 'en') {
+    const translated = titleTranslations[route.siteTitle]?.[route.lang];
+    if (translated) route.siteTitle = translated;
+  }
+
+  await next();
+});

package/src/content.config.ts

@@ -0,0 +1,10 @@
+import { defineCollection, z } from 'astro:content';
+import { docsLoader } from '@astrojs/starlight/loaders';
+import { docsSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+  docs: defineCollection({
+    loader: docsLoader(),
+    schema: docsSchema({ extend: z.object({ subcategory: z.string().optional() }) }),
+  }),
+};

package/src/i18n/glossary.ts

@@ -0,0 +1,18 @@
+import { categoryTitles, itemLabels, menuLabels } from './mega-menu-translations.ts';
+
+const allTerms: Record<string, Record<string, string>> = {
+  ...menuLabels,
+  ...categoryTitles,
+  ...itemLabels,
+};
+
+export function getGlossary(localeCode: string): Record<string, string> {
+  const result: Record<string, string> = {};
+  for (const [english, translations] of Object.entries(allTerms)) {
+    const translated = translations[localeCode];
+    if (translated && translated !== english) {
+      result[english] = translated;
+    }
+  }
+  return result;
+}

package/src/i18n/locales.test.ts

@@ -0,0 +1,56 @@
+import { describe, expect, it } from 'vitest';
+import { defaultLocale, f5xcDefaultLocales } from './locales';
+
+describe('f5xcDefaultLocales', () => {
+  it('contains 13 locales', () => {
+    expect(Object.keys(f5xcDefaultLocales)).toHaveLength(13);
+  });
+
+  it('uses slug format for keys', () => {
+    for (const key of Object.keys(f5xcDefaultLocales)) {
+      expect(key).toMatch(/^[a-z]+(-[a-z]+)?$/);
+    }
+  });
+
+  it('has BCP-47 lang property for each locale', () => {
+    for (const [_slug, config] of Object.entries(f5xcDefaultLocales)) {
+      expect(config.lang).toBeTruthy();
+      expect(config.label).toBeTruthy();
+    }
+  });
+
+  it('maps pt-br to BCP-47 pt-BR', () => {
+    expect(f5xcDefaultLocales['pt-br'].lang).toBe('pt-BR');
+  });
+
+  it('maps zh-cn to BCP-47 zh-CN', () => {
+    expect(f5xcDefaultLocales['zh-cn'].lang).toBe('zh-CN');
+  });
+
+  it('maps zh-tw to BCP-47 zh-TW', () => {
+    expect(f5xcDefaultLocales['zh-tw'].lang).toBe('zh-TW');
+  });
+
+  it('has RTL dir only for Arabic', () => {
+    expect(f5xcDefaultLocales.ar.dir).toBe('rtl');
+    expect(f5xcDefaultLocales.en.dir).toBeUndefined();
+    expect(f5xcDefaultLocales.fr.dir).toBeUndefined();
+  });
+
+  it('includes all expected locales', () => {
+    const expected = ['en', 'fr', 'es', 'de', 'pt-br', 'ja', 'ko', 'zh-cn', 'zh-tw', 'ar', 'it', 'hi', 'th'];
+    for (const slug of expected) {
+      expect(f5xcDefaultLocales).toHaveProperty(slug);
+    }
+  });
+});
+
+describe('defaultLocale', () => {
+  it('is "en"', () => {
+    expect(defaultLocale).toBe('en');
+  });
+
+  it('exists in f5xcDefaultLocales', () => {
+    expect(f5xcDefaultLocales).toHaveProperty(defaultLocale);
+  });
+});

package/src/i18n/locales.ts

@@ -0,0 +1,7 @@
+import { DEFAULT_LOCALE, type StarlightLocaleConfig, toStarlightLocales } from '@f5xc-salesdemos/i18n-core';
+
+export type LocaleConfig = StarlightLocaleConfig;
+
+export const f5xcDefaultLocales = toStarlightLocales();
+
+export const defaultLocale = DEFAULT_LOCALE;