@uxfront/layer-docs 0.4.1 → 0.6.0

package/test/brand-palette.ts

@@ -1,235 +0,0 @@
-import { existsSync, readdirSync, readFileSync } from "node:fs";
-import { fileURLToPath } from "node:url";
-import { describe, expect, it } from "vitest";
-
-/**
- * Shared test preset for consumers of `@uxfront/layer-docs`.
- *
- * The layer ships a palette-free Tailwind base and expects the consumer to own
- * the single Tailwind entry: one CSS file that imports the layer's base and
- * then declares the brand `@theme`. Two invariants make that arrangement work,
- * and both fail silently, so both get a guard here rather than a comment in
- * three repos:
- *
- * 1. **The consumer's CSS entry is a Tailwind entry.** A `@theme` block only
- *    compiles into real `:root` custom properties when the file it lives in is
- *    part of a Tailwind pass. If it stops being one, the block ships to the
- *    browser verbatim, browsers discard the unknown at-rule, and every
- *    `*-primary` utility falls back to black/transparent site-wide.
- *    Guarded by {@link describeBrandPaletteCss} — source-level, no build.
- *
- * 2. **Exactly one Tailwind pass reaches the bundle.** A second entry (a bare
- *    `@import "tailwindcss"` in the consumer, or a layer that registers its own
- *    base in `css:` alongside the consumer's) re-emits every base utility a
- *    second time. Guarded by {@link describeSingleTailwindPass} — reads the
- *    compiled output, so it needs a prior `nuxt build`.
- *
- * @example
- * ```ts
- * // apps/docs/test/brand-palette-css.test.ts
- * import { describeBrandPaletteCss } from "@uxfront/layer-docs/test";
- *
- * describeBrandPaletteCss({
- *   entry: new URL("../app/assets/css/main.css", import.meta.url),
- *   scale: "teal",
- * });
- * ```
- */
-
-/** Resolve a `file:` URL or a plain path to an absolute filesystem path. */
-function toPath(target: string | URL): string {
-  return typeof target === "string" ? target : fileURLToPath(target);
-}
-
-export interface BrandPaletteCssOptions {
-  /**
-   * The consumer's CSS entry — the file registered in `nuxt.config.ts`'s
-   * `css: []`. Pass `new URL("../app/assets/css/main.css", import.meta.url)`.
-   */
-  entry: string | URL;
-  /**
-   * Tailwind colour scale the brand palette defines, without the `--color-`
-   * prefix (`"teal"`, `"violet"`, `"purple"`). Must match `ui.colors.primary`
-   * in the consumer's `app.config.ts`.
-   */
-  scale: string;
-}
-
-/**
- * Source-level guard for invariant 1: the brand palette compiles at all.
- *
- * Cheap — reads one file, runs in the default unit-test job, and catches the
- * regression without a build. It cannot see invariant 2; that needs
- * {@link describeSingleTailwindPass}.
- */
-export function describeBrandPaletteCss(options: BrandPaletteCssOptions): void {
-  const { entry, scale } = options;
-
-  // A Tailwind pass reached via the layer's base CSS, which owns the single
-  // `@import "tailwindcss"`. Importing `tailwindcss` directly here would also
-  // make the file an entry, but it would open a SECOND pass — the exact
-  // regression invariant 2 guards — so only the layer import is accepted.
-  const LAYER_BASE_IMPORT = /@import\s+["']@uxfront\/layer-docs\/[^"']*main\.css["']/;
-
-  describe(`brand palette CSS entrypoint (${scale})`, () => {
-    const css = readFileSync(toPath(entry), "utf8");
-
-    it("imports the layer's base CSS so it is part of the single Tailwind pass", () => {
-      expect(css).toMatch(LAYER_BASE_IMPORT);
-    });
-
-    it("imports the layer base before the first @theme block", () => {
-      const importIndex = css.search(LAYER_BASE_IMPORT);
-      // Match the block opener specifically, not the `@theme` word in a
-      // leading docblock comment.
-      const themeIndex = css.search(/@theme\s+static\s*\{/);
-      expect(importIndex).toBeGreaterThanOrEqual(0);
-      expect(themeIndex).toBeGreaterThanOrEqual(0);
-      expect(importIndex).toBeLessThan(themeIndex);
-    });
-
-    it(`defines the ${scale} scale and maps it onto --ui-primary`, () => {
-      expect(css).toMatch(new RegExp(`@theme\\s+static\\s*\\{[\\s\\S]*--color-${scale}\\s*:`));
-      expect(css).toMatch(new RegExp(`--ui-primary\\s*:\\s*var\\(\\s*--color-${scale}\\s*\\)`));
-    });
-
-    // The OG card accent is resolved from this same declaration at build time
-    // (`utils/accent.ts`), because satori has no custom properties. The two
-    // assertions above already pin the declaration's existence; this one pins
-    // that it is *readable as a literal* — a value written as `var(...)` or a
-    // relative colour would parse here and then render as nothing in satori.
-    it(`declares --color-${scale} as a literal colour the OG renderer can use`, () => {
-      const declared = new RegExp(`--color-${scale}\\s*:\\s*([^;}]+)`).exec(css)?.[1]?.trim();
-      expect(declared).toBeDefined();
-      expect(declared).not.toMatch(/var\(|hsl\(\s*from|oklch\(\s*from|rgb\(\s*from/);
-    });
-  });
-}
-
-export interface SingleTailwindPassOptions {
-  /**
-   * Directory holding the built assets — usually
-   * `new URL("../.output/public/_nuxt", import.meta.url)`.
-   */
-  output: string | URL;
-  /**
-   * Tailwind colour scale the brand palette defines, without the `--color-`
-   * prefix. Asserts the palette survived into the compiled bundle.
-   */
-  scale: string;
-  /**
-   * Extra base utilities to assert on, appended to {@link BASE_UTILITIES}.
-   * Each entry is a full class selector, e.g. `".text-5xl"`.
-   */
-  utilities?: string[];
-}
-
-/**
- * Ubiquitous unwrapped utilities the layer and Nuxt UI always emit. In a
- * single-pass build each appears exactly once; a second pass makes them 2, and
- * a bundle the layer base never reached makes them 0.
- */
-const BASE_UTILITIES = [".relative", ".absolute", ".flex", ".grid", ".hidden", ".block"];
-
-/**
- * Responsive utilities emitted inside `@media` blocks. Asserting these as well
- * as {@link BASE_UTILITIES} is not redundancy — the two halves duplicate
- * independently, and a base-only probe reports a duplicating build as clean.
- *
- * Measured on the same layer, same config, differing only in the Vite build
- * used by `@nuxt/vite-builder`:
- *
- * | build            | `.flex` | `.lg\:hidden` |
- * |------------------|---------|---------------|
- * | rollup (vite 7)  | 2       | 2             |
- * | rolldown         | 1       | **2**         |
- * | single pass      | 1       | 1             |
- *
- * Rolldown collapses the duplicated top-level rules and leaves the `@media`-
- * wrapped ones — so the consumer on rolldown still shipped ~63 KB of duplicate
- * responsive CSS while every base-utility count read 1.
- *
- * All three are emitted by this layer's own components (`AppHeader`,
- * `AppSubHeader`, `DocsAsideRightBottom`), so every consumer of the layer has
- * them regardless of its own markup.
- */
-const VARIANT_UTILITIES = [".lg\\:hidden", ".lg\\:block", ".max-lg\\:hidden"];
-
-/**
- * Compiled-output guard for invariant 2: exactly one Tailwind pass in the
- * shipped stylesheet.
- *
- * **What this guards is payload, not layout.** A second pass emits a
- * byte-for-byte duplicate of the stylesheet — measured at +212 KB raw /
- * +26.7 KB gzip (+94%) on a consumer's render-blocking `entry.css`, on every
- * page for every visitor (UXF-118). It does *not*, on the evidence gathered
- * there, break the cascade: the duplicate pass observed was a complete superset
- * of the first and emitted wholly after it, so the last `sm:`/`lg:` variant
- * still landed after the last conflicting base and won by source order.
- * Computed-style A/B across 4 pages × 4 viewports found zero rendering
- * difference.
- *
- * That rescue is incidental, not designed — a non-superset second pass, or a
- * different emission order, and the cascade does break. But the guard should
- * describe what it actually measures, so nobody re-derives a rendering
- * emergency from a payload regression.
- *
- * Two deliberate choices in what it asserts:
- *
- * - **Both unwrapped and `@media`-wrapped utilities** ({@link BASE_UTILITIES}
- *   and {@link VARIANT_UTILITIES}). They duplicate independently; a base-only
- *   probe reported a duplicating build as clean.
- * - **`=== 1`, not `<= 1`.** The same assertion then catches the opposite
- *   failure — a consumer that never registered a CSS entry importing the layer
- *   base, and so ships no utilities at all.
- *
- * Requires a prior `nuxt build` / `nuxt generate`. Keep these in
- * `*.build.test.ts` files excluded from the default unit run.
- */
-export function describeSingleTailwindPass(options: SingleTailwindPassOptions): void {
-  const { output, scale, utilities = [] } = options;
-
-  describe("compiled CSS: single Tailwind pass", () => {
-    const css = readEntryCss(toPath(output));
-    const assertedUtilities = [...BASE_UTILITIES, ...VARIANT_UTILITIES, ...utilities];
-
-    it("emits each utility exactly once (no duplicate Tailwind pass, and the layer base did reach the bundle)", () => {
-      const counts = Object.fromEntries(assertedUtilities.map((u) => [u, countUtility(css, u)]));
-      const expected = Object.fromEntries(assertedUtilities.map((u) => [u, 1]));
-      expect(counts).toEqual(expected);
-    });
-
-    it(`compiles the ${scale} scale and the --ui-primary mapping into the bundle`, () => {
-      expect(css).toMatch(new RegExp(`--color-${scale}\\s*:`));
-      expect(css).toMatch(new RegExp(`--ui-primary\\s*:\\s*var\\(\\s*--color-${scale}\\s*\\)`));
-    });
-  });
-}
-
-/** Read the built `entry.*.css`, comments stripped so counts reflect rules only. */
-function readEntryCss(outputDir: string): string {
-  if (!existsSync(outputDir)) {
-    throw new Error(
-      `Compiled output not found at ${outputDir}. Build the app first ` +
-        `(nuxt build) before running the compiled-output guard.`,
-    );
-  }
-  const entries = readdirSync(outputDir)
-    .filter((file) => /^entry\..*\.css$/.test(file))
-    .sort();
-  if (entries.length === 0) {
-    throw new Error(`No entry.*.css found in ${outputDir}. Build the app first (nuxt build).`);
-  }
-  return readFileSync(`${outputDir}/${entries.at(-1)}`, "utf8").replace(/\/\*[\s\S]*?\*\//g, "");
-}
-
-/** Count how many times a utility is emitted as its own class selector. */
-function countUtility(css: string, utility: string): number {
-  const escaped = utility.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-  // A leading `.` immediately followed by the class name, not part of a longer
-  // variant selector such as `.sm\:text-5xl` (there the class is preceded by an
-  // escaped colon, so `.text-5xl` never appears) and not a prefix of a longer
-  // utility such as `.flex-col`.
-  const pattern = new RegExp(`(?<![\\w\\\\:-])${escaped}(?![\\w-])`, "g");
-  return (css.match(pattern) ?? []).length;
-}

package/test/no-brand-leakage.test.ts

@@ -1,124 +0,0 @@
-import { readdirSync, readFileSync } from "node:fs";
-import { join, relative } from "node:path";
-import { fileURLToPath } from "node:url";
-import { describe, expect, it } from "vitest";
-
-/**
- * The Storybook embed is the layer's most leak-prone surface: it is the only
- * component whose whole job is to address somebody else's deployment. A default
- * host "just for now", or a message name copied out of the repo it came from,
- * breaks no build — it points the *next* consumer's docs at the previous
- * consumer's Storybook, quietly. So it is a test, not a review habit.
- *
- * Three assertions, matching the three shapes the leak takes:
- *
- * 1. The embed's own source names no consumer.
- * 2. Nothing in the package hardcodes a Storybook host.
- * 3. Nothing in the package speaks a branded message namespace.
- *
- * Scopes differ on purpose. (1) is narrow because naming a consumer in a
- * comment elsewhere is often a receipt — "+26.7 KB gzip on <consumer>,
- * UXF-118" is evidence, not branding, and a guard that banned it would be
- * training people to delete their sources. (2) and (3) are package-wide because
- * a hardcoded host or a branded message name is a defect wherever it appears.
- */
-
-const PACKAGE_ROOT = fileURLToPath(new URL("..", import.meta.url));
-
-/** The embed surface: the files that exist to talk to a consumer's Storybook. */
-const EMBED_SOURCES = [
-  "app/components/content/StorybookEmbed.vue",
-  "app/utils/storybookEmbed.ts",
-  "storybook/index.ts",
-];
-
-/**
- * Products that extend this layer. A match inside the embed surface means the
- * neutral component learned something about a specific consumer.
- */
-const CONSUMER_BRANDS = ["styleframe", "inkline"];
-
-/** Hostnames that exist only to be read, never fetched. */
-const DOCUMENTATION_HOSTS = ["example.com", "example.org", "localhost", "127.0.0.1"];
-
-/** The one namespace the package is allowed to speak. */
-const NEUTRAL_NAMESPACE = "uxfront:docs-embed";
-
-/**
- * Any `<namespace>:theme` / `:height` / `:preview-height` string literal — the
- * shape of this contract's message names, whoever coined them.
- *
- * Quoted strings only, not backticked ones: backticks here mark prose in doc
- * comments, and a real message name built as a template literal is
- * parameterized (`${namespace}:theme`) rather than branded.
- */
-const MESSAGE_NAME_LITERAL = /["']([\w.-]+):(?:theme|height|preview-height)["']/g;
-
-const IGNORED_DIRECTORIES = new Set(["node_modules", ".nuxt", ".output", "dist"]);
-const SOURCE_EXTENSIONS = [".ts", ".vue", ".css", ".json"];
-
-interface SourceFile {
-  path: string;
-  source: string;
-}
-
-function readSourceFiles(directory: string, collected: SourceFile[] = []): SourceFile[] {
-  for (const entry of readdirSync(directory, { withFileTypes: true })) {
-    const path = join(directory, entry.name);
-
-    if (entry.isDirectory()) {
-      if (!IGNORED_DIRECTORIES.has(entry.name)) readSourceFiles(path, collected);
-      continue;
-    }
-    if (!SOURCE_EXTENSIONS.some((extension) => entry.name.endsWith(extension))) continue;
-    // Tests quote the literals they exercise — including a legacy namespace,
-    // which is the whole point of the compat-window cases.
-    if (entry.name.endsWith(".test.ts")) continue;
-
-    collected.push({ path: relative(PACKAGE_ROOT, path), source: readFileSync(path, "utf8") });
-  }
-
-  return collected;
-}
-
-describe("no brand leakage in the Storybook embed", () => {
-  const files = readSourceFiles(PACKAGE_ROOT);
-  const embedFiles = files.filter((file) => EMBED_SOURCES.includes(file.path));
-
-  // Guards the guard: a scan that silently matched nothing passes everything.
-  it("finds the embed surface and the rest of the package", () => {
-    expect(embedFiles.map((file) => file.path).sort()).toEqual([...EMBED_SOURCES].sort());
-    expect(files.length).toBeGreaterThan(50);
-  });
-
-  it.each(CONSUMER_BRANDS)("names no consumer (%s) in the embed surface", (brand) => {
-    const pattern = new RegExp(brand, "i");
-    const offenders = embedFiles
-      .filter((file) => pattern.test(file.source))
-      .map((file) => file.path);
-
-    expect(offenders).toEqual([]);
-  });
-
-  it("hardcodes no Storybook host — where one is deployed is consumer config", () => {
-    const offenders = files.flatMap((file) =>
-      [...file.source.matchAll(/https?:\/\/[^\s"'`)]+/g)]
-        .map((match) => match[0])
-        .filter((url) => /storybook/i.test(url))
-        .filter((url) => !DOCUMENTATION_HOSTS.some((host) => url.includes(host)))
-        .map((url) => `${file.path}: ${url}`),
-    );
-
-    expect(offenders).toEqual([]);
-  });
-
-  it("speaks no branded message namespace", () => {
-    const offenders = files.flatMap((file) =>
-      [...file.source.matchAll(MESSAGE_NAME_LITERAL)]
-        .filter((match) => match[1] !== NEUTRAL_NAMESPACE)
-        .map((match) => `${file.path}: ${match[0]}`),
-    );
-
-    expect(offenders).toEqual([]);
-  });
-});

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "files": [],
-  "references": [
-    {
-      "path": "./.nuxt/tsconfig.app.json"
-    },
-    {
-      "path": "./.nuxt/tsconfig.server.json"
-    },
-    {
-      "path": "./.nuxt/tsconfig.shared.json"
-    },
-    {
-      "path": "./.nuxt/tsconfig.node.json"
-    }
-  ]
-}

package/utils/accent.ts

@@ -1,80 +0,0 @@
-import { existsSync, readFileSync } from "node:fs";
-import { isAbsolute, join } from "node:path";
-
-/** Fallback accent when the brand token cannot be resolved. */
-export const FALLBACK_ACCENT = "#ffffff";
-
-/**
- * Resolve the brand accent colour as a literal, build-time string.
- *
- * OG images are rendered by satori, which has no CSS cascade and no custom
- * properties: `var(--ui-primary)` resolves to nothing. A dynamic Tailwind class
- * is worse than useless, because every consumer *shadows* a stock Tailwind
- * scale name with its own value — `--color-teal: hsl(189 53% 41%)` is not
- * Tailwind's teal, so `text-teal-500` would render the wrong brand. The colour
- * therefore has to arrive already resolved.
- *
- * It is read out of the consumer's CSS entry by following the same two hops the
- * browser does, and that `describeBrandPaletteCss` already asserts:
- *
- *   `@theme static { --color-teal: hsl(189, 53%, 41%); }`  — the literal
- *   `:root { --ui-primary: var(--color-teal); }`           — the alias
- *
- * Reading the CSS rather than `ui.colors.primary` is deliberate: `app.config.ts`
- * is not merged into `nuxt.options.appConfig` at module-setup time (that object
- * holds only `nuxt.config.ts`'s own `appConfig` key), so the scale name is not
- * available there. The CSS is available, it is the definition rather than a
- * discriminant, and it needs no configuration from the consumer at all.
- *
- * Shade variants are deliberately not followed: they are declared with
- * relative-colour syntax (`hsl(from var(--color-teal) h s 60%)`), which satori
- * cannot parse either.
- */
-export function resolveBrandAccent(options: {
-  /** The consumer's registered CSS entries (`nuxt.options.css`). */
-  cssEntries: string[];
-  /** Consumer root, used to resolve relative CSS entry paths. */
-  rootDir: string;
-}): { accent: string; reason?: string } {
-  const { cssEntries, rootDir } = options;
-
-  for (const entry of cssEntries) {
-    const path = isAbsolute(entry) ? entry : join(rootDir, entry.replace(/^\.\//, ""));
-    if (!existsSync(path)) {
-      continue;
-    }
-    const accent = readAccent(readFileSync(path, "utf8"));
-    if (accent) {
-      return { accent };
-    }
-  }
-
-  return {
-    accent: FALLBACK_ACCENT,
-    reason:
-      "could not resolve `--ui-primary` to a literal colour in the registered " +
-      `CSS entries (${cssEntries.join(", ") || "none"})`,
-  };
-}
-
-/** Follow `--ui-primary` to the literal it aliases, or take it literally. */
-function readAccent(css: string): string | undefined {
-  const uiPrimary = /--ui-primary\s*:\s*([^;}]+)/.exec(css)?.[1]?.trim();
-  if (!uiPrimary) {
-    return undefined;
-  }
-
-  const alias = /^var\(\s*(--[\w-]+)\s*\)$/.exec(uiPrimary)?.[1];
-  if (!alias) {
-    // Already a literal — usable unless it is some other custom-property
-    // expression satori would render as nothing.
-    return uiPrimary.includes("var(") ? undefined : uiPrimary;
-  }
-
-  const declared = new RegExp(`${escapeRegExp(alias)}\\s*:\\s*([^;}]+)`).exec(css)?.[1]?.trim();
-  return declared && !declared.includes("var(") ? declared : undefined;
-}
-
-function escapeRegExp(value: string): string {
-  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-}

package/utils/content.ts

@@ -1,193 +0,0 @@
-import type { DefinedCollection } from "@nuxt/content";
-import { defineContentConfig, defineCollection, z } from "@nuxt/content";
-import { useNuxt } from "@nuxt/kit";
-import { defineSitemapSchema } from "@nuxtjs/sitemap/content";
-
-/**
- * Minimal structural shape of a documentation section descriptor. The consuming
- * app owns the concrete `DOCS_SECTIONS` array (and may extend each entry with
- * extra fields like `icon`/`label` used by the runtime nav); this helper only
- * reads the fields it needs to build Nuxt Content collections.
- */
-export interface DocsSectionDescriptor {
-  /** Stable collection key, e.g. "guide" → collection `docs_guide`. */
-  key: string;
-  /** URL segment under `/docs/<slug>`. */
-  slug: string;
-  /** Human label, used as a fallback nav title. */
-  label: string;
-  /**
-   * Source folder(s) under `content/docs/`. String or list. Accepts a readonly
-   * list so a consumer can declare its topology with `as const`.
-   */
-  folder: string | readonly string[];
-  /**
-   * When `folder` is a list, the index whose pages mount at the section root
-   * (`/docs/<slug>`) instead of `/docs/<slug>/<folder>`. Defaults to none.
-   */
-  rootFolder?: number;
-}
-
-/**
- * Opt-in extras layered on top of the base collection set. Both default to
- * `false`, so an existing `defineDocsCollections(sections)` call is unchanged.
- */
-export interface DefineDocsCollectionsOptions {
-  /**
-   * Fold `@nuxtjs/sitemap`'s frontmatter schema into every page collection so
-   * authors can set per-page sitemap fields (priority, changefreq, lastmod).
-   * Requires the consumer to register `@nuxtjs/sitemap`.
-   */
-  sitemap?: boolean;
-  /**
-   * Emit a locale-independent `changelog` collection sourced from
-   * `content/changelog/*.md`. One entry per released version, with `version`,
-   * `date`, and an optional `releaseUrl` override for entries that predate the
-   * repository's current release-tag convention.
-   */
-  changelog?: boolean;
-}
-
-// `@nuxtjs/sitemap` and `@nuxt/content` can resolve different zod majors in a
-// consumer's tree (v4 and v3 respectively), and the two `ZodType` shapes are
-// structurally incompatible even though the runtime value is fine. Cast at the
-// single seam rather than pinning a consumer's zod.
-const sitemapSchema = () =>
-  z.object({
-    sitemap: defineSitemapSchema() as unknown as ReturnType<typeof z.any>,
-  });
-
-const createLandingSchema = (options: DefineDocsCollectionsOptions) =>
-  options.sitemap ? sitemapSchema() : undefined;
-
-const createDocsSchema = (options: DefineDocsCollectionsOptions) => {
-  const schema = z.object({
-    links: z
-      .array(
-        z.object({
-          label: z.string(),
-          icon: z.string(),
-          to: z.string(),
-          target: z.string().optional(),
-        }),
-      )
-      .optional(),
-  });
-
-  return options.sitemap ? schema.extend(sitemapSchema().shape) : schema;
-};
-
-const createChangelogSchema = () =>
-  z.object({
-    version: z.string(),
-    date: z.string(),
-    releaseUrl: z.string().url().optional(),
-  });
-
-const buildDocsSource = (section: DocsSectionDescriptor, pathPrefix = "", urlPrefix = "") => {
-  const folders = typeof section.folder === "string" ? [section.folder] : section.folder;
-  const baseUrl = `${urlPrefix}/docs/${section.slug}`;
-
-  if (folders.length === 1) {
-    return {
-      include: `${pathPrefix}docs/${folders[0]}/**/*.{md,yml}`,
-      prefix: baseUrl,
-    };
-  }
-
-  const rootIndex = typeof section.rootFolder === "number" ? section.rootFolder : -1;
-
-  return folders.map((folder, index) => ({
-    include: `${pathPrefix}docs/${folder}/**/*.{md,yml}`,
-    prefix: index === rootIndex ? baseUrl : `${baseUrl}/${folder.replace(/^\d+\./, "")}`,
-  }));
-};
-
-/**
- * Builds the Nuxt Content configuration for a documentation site from a list of
- * section descriptors. A consumer's `content.config.ts` becomes a one-liner:
- *
- * ```ts
- * import { defineDocsCollections } from "@uxfront/layer-docs/content";
- * import { DOCS_SECTIONS } from "./app/constants/sections";
- * export default defineDocsCollections([...DOCS_SECTIONS]);
- * ```
- *
- * Produces one `landing` collection (root markdown) plus one `docs_<key>`
- * collection per section. When `@nuxtjs/i18n` is configured with `locales`, the
- * collections are generated per-locale (`landing_<code>`, `docs_<key>_<code>`)
- * and sourced from a matching `content/<code>/` subtree; otherwise a single flat
- * set is produced. The section topology and content stay in the consuming app.
- *
- * Two opt-in extras are available — sitemap frontmatter on every page, and a
- * `changelog` collection:
- *
- * ```ts
- * export default defineDocsCollections([...DOCS_SECTIONS], {
- *   sitemap: true,
- *   changelog: true,
- * });
- * ```
- */
-export function defineDocsCollections(
-  sections: readonly DocsSectionDescriptor[],
-  options: DefineDocsCollectionsOptions = {},
-) {
-  const { options: nuxtOptions } = useNuxt();
-  const locales = nuxtOptions.i18n?.locales;
-
-  const landingSchema = createLandingSchema(options);
-  const docsSchema = createDocsSchema(options);
-
-  let collections: Record<string, DefinedCollection>;
-
-  if (locales && Array.isArray(locales) && locales.length > 0) {
-    collections = {};
-    for (const locale of locales) {
-      const code = typeof locale === "string" ? locale : locale.code;
-
-      collections[`landing_${code}`] = defineCollection({
-        type: "page",
-        source: [{ include: `${code}/*.md` }],
-        ...(landingSchema ? { schema: landingSchema } : {}),
-      });
-
-      for (const section of sections) {
-        collections[`docs_${section.key}_${code}`] = defineCollection({
-          type: "page",
-          source: buildDocsSource(section, `${code}/`, `/${code}`),
-          schema: docsSchema,
-        });
-      }
-    }
-  } else {
-    collections = {
-      landing: defineCollection({
-        type: "page",
-        source: [{ include: "*.md" }],
-        ...(landingSchema ? { schema: landingSchema } : {}),
-      }),
-    };
-
-    for (const section of sections) {
-      collections[`docs_${section.key}`] = defineCollection({
-        type: "page",
-        source: buildDocsSource(section),
-        schema: docsSchema,
-      });
-    }
-  }
-
-  if (options.changelog) {
-    // Locale-independent on purpose: a release history is the same document in
-    // every language. The index route renders every body inline; each entry also
-    // has a deep-linkable detail route reading from this same collection.
-    collections.changelog = defineCollection({
-      type: "page",
-      source: { include: "changelog/*.md" },
-      schema: createChangelogSchema(),
-    });
-  }
-
-  return defineContentConfig({ collections });
-}