@f5-sales-demo/docs-theme 4.9.9 → 4.11.0

package/config.ts

@@ -38,6 +38,7 @@ import { stagedProviderSections } from './src/utils/provider-sections.ts';
 import { publicationSidebar, repositoryPublicationProfile } from './src/utils/publication-profiles.ts';
 import { resolveMegaMenuIcon } from './src/utils/resolve-icon.ts';
 import providerSharedAssets from './src/utils/share-provider-assets.mjs';
+import { statisticsScriptMarkdown } from './src/utils/statistics-script-markdown.mjs';
 import { buildSubcategorySidebar } from './src/utils/subcategory-sidebar.ts';
 
 export type { LocaleConfig } from './src/i18n/locales.ts';
@@ -942,6 +943,7 @@ export function createF5xcDocsConfig(options: F5xcDocsConfigOptions = {}) {
       ...(canonicalProvider
         ? [providerSharedAssets(), canonicalLlms({ contentRoot: canonicalProvider.contentRoot, base, title })]
         : []),
+      ...(githubRepository === 'f5-sales-demo/statistics' ? [statisticsScriptMarkdown()] : []),
       ...additionalIntegrations,
     ],
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.9.9",
+  "version": "4.11.0",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {

package/src/utils/publication-profiles.test.ts

@@ -57,3 +57,51 @@ describe('publication profile sidebar', () => {
     expect(publicationSidebar('f5-sales-demo/canada', fallback)).not.toBe(fallback);
   });
 });
+
+describe('Statistics publication', () => {
+  it('keeps English publication and the existing F5 branding', () => {
+    expect(repositoryPublicationProfile('f5-sales-demo/statistics')).toMatchObject({
+      locales: { en: { label: 'English', lang: 'en' } },
+      defaultLocale: 'en',
+    });
+    expect(repositoryPublicationProfile('statistics')?.favicon).toBeUndefined();
+  });
+  it('preserves 13 existing routes and places Shell Scripts before Infrastructure', () => {
+    const sidebar = publicationSidebar('f5-sales-demo/statistics', []);
+    expect(sidebar?.slice(0, 11)).toEqual([
+      { slug: 'index' },
+      { slug: 'access-logs' },
+      { slug: 'service-graph' },
+      { slug: 'origin-performance' },
+      { slug: 'application-health' },
+      { slug: 'api-discovery' },
+      { slug: 'firewall-metrics' },
+      { slug: 'security-events' },
+      { slug: 'troubleshooting' },
+      { slug: 'api-catalog' },
+      { slug: 'setup' },
+    ]);
+    expect(sidebar?.[11]).toEqual({ slug: 'shell-scripts' });
+    expect(sidebar?.[12]).toEqual({
+      label: 'Infrastructure',
+      collapsed: true,
+      items: [{ slug: 'deployment' }, { slug: 'verification' }],
+    });
+    expect(sidebar).toHaveLength(13);
+    const routes = sidebar?.flatMap((item) =>
+      'slug' in item
+        ? [item.slug]
+        : 'items' in item
+          ? item.items.map((child) => ('slug' in child ? child.slug : ''))
+          : [],
+    );
+    expect(routes).toHaveLength(14);
+    expect(new Set(routes).size).toBe(14);
+  });
+  it('preserves supplied fallback navigation for other repositories', () => {
+    const fallback = [{ slug: 'index' }, { label: 'Existing', items: [{ slug: 'existing' }] }];
+    for (const repo of ['observability', 'multi-cloud-networking', 'docs-theme', 'statistics-extra']) {
+      expect(publicationSidebar(`f5-sales-demo/${repo}`, fallback)).toBe(fallback);
+    }
+  });
+});

package/src/utils/publication-profiles.ts

@@ -5,12 +5,35 @@ type Sidebar = NonNullable<Parameters<typeof starlight>[0]['sidebar']>;
 interface PublicationProfile {
   locales: Record<string, { label: string; lang: string }>;
   defaultLocale: string;
-  favicon: string;
+  favicon?: string;
   sidebar?: Sidebar;
 }
 
 /** Repository publication decisions shared by navigation and site configuration. */
 export const publicationProfiles: Record<string, PublicationProfile> = {
+  statistics: {
+    locales: { en: { label: 'English', lang: 'en' } },
+    defaultLocale: 'en',
+    sidebar: [
+      { slug: 'index' },
+      { slug: 'access-logs' },
+      { slug: 'service-graph' },
+      { slug: 'origin-performance' },
+      { slug: 'application-health' },
+      { slug: 'api-discovery' },
+      { slug: 'firewall-metrics' },
+      { slug: 'security-events' },
+      { slug: 'troubleshooting' },
+      { slug: 'api-catalog' },
+      { slug: 'setup' },
+      { slug: 'shell-scripts' },
+      {
+        label: 'Infrastructure',
+        collapsed: true,
+        items: [{ slug: 'deployment' }, { slug: 'verification' }],
+      },
+    ],
+  },
   canada: {
     locales: { en: { label: 'English', lang: 'en' } },
     defaultLocale: 'en',

package/src/utils/statistics-script-markdown.mjs

@@ -0,0 +1,31 @@
+import { readFile, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+/** Keep the Statistics page-action Markdown export equal to its imported script source. */
+export function statisticsScriptMarkdown() {
+  let root;
+  return {
+    name: 'statistics-script-markdown',
+    hooks: {
+      'astro:config:done': ({ config }) => {
+        root = fileURLToPath(config.root);
+      },
+      'astro:build:done': async ({ dir }) => {
+        await expandStatisticsScriptMarkdown(root, fileURLToPath(dir));
+      },
+    },
+  };
+}
+
+export async function expandStatisticsScriptMarkdown(root, output) {
+  const path = join(output, 'en/shell-scripts.md');
+  let markdown = await readFile(path, 'utf8');
+  for (const name of ['simple-stats.sh', 'get-stats.sh']) {
+    const source = await readFile(join(root, 'src/content/docs/assets/scripts', name), 'utf8');
+    const fence = `\x60\x60\x60bash file=../assets/scripts/${name}\n\x60\x60\x60`;
+    if (!markdown.includes(fence)) throw new Error(`Missing script import in Statistics Markdown: ${name}`);
+    markdown = markdown.replace(fence, () => `\x60\x60\x60bash\n${source}\x60\x60\x60`);
+  }
+  await writeFile(path, markdown);
+}

package/src/utils/statistics-script-markdown.test.ts

@@ -0,0 +1,31 @@
+import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { describe, expect, it } from 'vitest';
+import { expandStatisticsScriptMarkdown } from './statistics-script-markdown.mjs';
+
+describe('Statistics script Markdown export', () => {
+  it('expands both complete sources without interpreting replacement characters', async () => {
+    const root = await mkdtemp(join(tmpdir(), 'statistics-export-'));
+    try {
+      await mkdir(join(root, 'src/content/docs/assets/scripts'), { recursive: true });
+      await mkdir(join(root, 'output/en'), { recursive: true });
+      const source = '#!/usr/bin/env bash\nprintf "%s" "$&"\n';
+      for (const name of ['simple-stats.sh', 'get-stats.sh']) {
+        await writeFile(join(root, 'src/content/docs/assets/scripts', name), source);
+      }
+      await writeFile(
+        join(root, 'output/en/shell-scripts.md'),
+        ['simple-stats.sh', 'get-stats.sh']
+          .map((name) => `\x60\x60\x60bash file=../assets/scripts/${name}\n\x60\x60\x60`)
+          .join('\n'),
+      );
+      await expandStatisticsScriptMarkdown(root, join(root, 'output'));
+      expect(await readFile(join(root, 'output/en/shell-scripts.md'), 'utf8')).toBe(
+        `\x60\x60\x60bash\n${source}\x60\x60\x60\n\x60\x60\x60bash\n${source}\x60\x60\x60`,
+      );
+    } finally {
+      await rm(root, { recursive: true, force: true });
+    }
+  });
+});