@uxfront/layer-docs 0.4.1 → 0.6.0

package/modules/config.ts

@@ -1,144 +0,0 @@
-import { createResolver, defineNuxtModule } from "@nuxt/kit";
-import { defu } from "defu";
-import { existsSync } from "node:fs";
-import { join } from "node:path";
-import { inferSiteURL, getPackageJsonMetadata } from "../utils/meta";
-import { getGitBranch, getGitEnv, getLocalGitInfo } from "../utils/git";
-import { resolveBrandAccent } from "../utils/accent";
-
-export default defineNuxtModule({
-  meta: {
-    name: "config",
-  },
-  async setup(_options, nuxt) {
-    const dir = nuxt.options.rootDir;
-    const url = inferSiteURL();
-    const meta = await getPackageJsonMetadata(dir);
-    const gitInfo = (await getLocalGitInfo(dir)) || getGitEnv();
-    const site = nuxt.options.site;
-    const siteName =
-      (typeof site === "object" ? site.name : undefined) || meta.name || gitInfo?.name || "";
-
-    nuxt.options.llms = defu(nuxt.options.llms, {
-      domain: url,
-      title: siteName,
-      description: meta.description || "",
-      full: {
-        title: siteName,
-        description: meta.description || "",
-      },
-    });
-
-    nuxt.options.site = defu(nuxt.options.site, {
-      url,
-      name: siteName,
-      debug: false,
-    }) as typeof nuxt.options.site;
-
-    nuxt.options.appConfig.header = defu(nuxt.options.appConfig.header, {
-      title: siteName,
-    });
-
-    nuxt.options.appConfig.seo = defu(nuxt.options.appConfig.seo, {
-      titleTemplate: `%s - ${siteName}`,
-      title: siteName,
-      description: meta.description || "",
-    });
-
-    nuxt.options.appConfig.github = defu(nuxt.options.appConfig.github, {
-      owner: gitInfo?.owner,
-      name: gitInfo?.name,
-      url: gitInfo?.url,
-      branch: getGitBranch(),
-    });
-
-    /*
-     ** OG IMAGE ACCENT
-     **
-     ** Bind the card accent to the same token the site uses — see
-     ** `utils/accent.ts` for why it has to be a literal by the time satori
-     ** runs. Written as a default: a consumer that sets `ogImage.accent` in its
-     ** own `app.config.ts` still wins on the layer merge, and one that sets
-     ** nothing gets a branded card with no configuration at all.
-     */
-    const { accent, reason } = resolveBrandAccent({
-      cssEntries: nuxt.options.css ?? [],
-      rootDir: dir,
-    });
-    if (reason) {
-      console.warn(
-        `[Docus] OG image accent falls back to ${accent}: ${reason}. ` +
-          `Set \`ogImage.accent\` in app.config.ts to silence this.`,
-      );
-    }
-    nuxt.options.appConfig.ogImage = defu(nuxt.options.appConfig.ogImage, { accent });
-
-    /*
-     ** I18N
-     */
-    if (nuxt.options.i18n && nuxt.options.i18n.locales) {
-      const { resolve } = createResolver(import.meta.url);
-
-      // Filter locales to only include existing ones
-      const filteredLocales = nuxt.options.i18n.locales.filter((locale) => {
-        const localeCode = typeof locale === "string" ? locale : locale.code;
-
-        // Check for JSON locale file
-        const localeFilePath = resolve("../i18n/locales", `${localeCode}.json`);
-        const hasLocaleFile = existsSync(localeFilePath);
-
-        // Check for content folder
-        const contentPath = join(nuxt.options.rootDir, "content", localeCode);
-        const hasContentFolder = existsSync(contentPath);
-
-        if (!hasLocaleFile) {
-          console.warn(
-            `[Docus] Locale file not found: ${localeCode}.json - skipping locale "${localeCode}"`,
-          );
-        }
-
-        if (!hasContentFolder) {
-          console.warn(
-            `[Docus] Content folder not found: content/${localeCode}/ - skipping locale "${localeCode}"`,
-          );
-        }
-
-        return hasLocaleFile && hasContentFolder;
-      });
-
-      // Override strategy to prefix
-      nuxt.options.i18n = {
-        ...nuxt.options.i18n,
-        strategy: "prefix",
-      };
-
-      // Expose filtered locales
-      nuxt.options.runtimeConfig.public.docus = {
-        filteredLocales,
-      };
-
-      nuxt.hook("i18n:registerModule", (register) => {
-        const langDir = resolve("../i18n/locales");
-
-        const locales = filteredLocales?.map((locale) => {
-          return typeof locale === "string"
-            ? {
-                code: locale,
-                name: locale,
-                file: `${locale}.json`,
-              }
-            : {
-                code: locale.code,
-                name: locale.name || locale.code,
-                file: `${locale.code}.json`,
-              };
-        });
-
-        register({
-          langDir,
-          locales,
-        });
-      });
-    }
-  },
-});

package/modules/optimizeDeps.ts

@@ -1,45 +0,0 @@
-import { createRequire } from "node:module";
-import { defineNuxtModule, extendViteConfig } from "@nuxt/kit";
-
-/**
- * Vite prebundle hints for this layer's own dependencies.
- *
- * Every id below is a dependency the layer pulls in (`@vueuse/core`, `motion-v`
- * directly; `posthog-js` via the analytics plugin; `slugify` transitively
- * through `@nuxt/content`). Without the hint Vite discovers them mid-request on
- * first dev load and triggers a full-reload optimise pass. The hints belong with
- * the deps, so they ship here rather than in each consumer's config.
- */
-export default defineNuxtModule({
-  meta: {
-    name: "optimize-deps",
-  },
-  setup(_options, nuxt) {
-    const include = ["@nuxt/content > slugify", "@vueuse/core", "motion-v"];
-
-    // `posthog-js` is an OPTIONAL peer. Naming an uninstalled package in
-    // `optimizeDeps.include` is a hard dev-server error, so hint it only when
-    // the consumer actually has it.
-    if (canResolve("posthog-js", nuxt.options.rootDir)) {
-      include.push("posthog-js");
-    }
-
-    extendViteConfig((config) => {
-      config.optimizeDeps ||= {};
-      config.optimizeDeps.include ||= [];
-      config.optimizeDeps.include.push(...include);
-    });
-  },
-});
-
-function canResolve(id: string, fromDir: string): boolean {
-  for (const parent of [`${fromDir}/`, import.meta.url]) {
-    try {
-      createRequire(parent).resolve(id);
-      return true;
-    } catch {
-      // try the next resolution root
-    }
-  }
-  return false;
-}

package/modules/routing.ts

@@ -1,20 +0,0 @@
-import { defineNuxtModule, createResolver } from "@nuxt/kit";
-
-export default defineNuxtModule({
-  meta: {
-    name: "routing",
-  },
-  async setup(_options, nuxt) {
-    const { resolve } = createResolver(import.meta.url);
-
-    // Ensure useDocusI18n is available in the app
-    nuxt.hook("imports:extend", (imports) => {
-      if (imports.some((i) => i.name === "useDocusI18n")) return;
-
-      imports.push({
-        name: "useDocusI18n",
-        from: resolve("../app/composables/useDocusI18n"),
-      });
-    });
-  },
-});

package/nuxt.schema.ts

@@ -1,374 +0,0 @@
-import { field, group } from "@nuxt/content/preview";
-
-/**
- * Nuxt Content Studio preview schema for this layer's `app.config.ts` surface.
- *
- * Every field below describes a key the layer itself declares and reads, so the
- * schema is owned here rather than restated in each consumer. Nuxt merges
- * schemas across layers, so a consumer declares only the keys it adds on top.
- *
- * This file is load-bearing beyond Studio: once a schema exists, Nuxt derives
- * the generated `AppConfig` type from it, and any key the layer reads but the
- * schema omits collapses to `{}` and fails typecheck at the read site. Adding a
- * key to `app.config.ts` or reading a new one from a component means adding it
- * here in the same change.
- *
- * Brand-free by construction: the defaults are Nuxt UI palette tokens and
- * generic placeholder strings, never a product's values.
- */
-export default defineNuxtSchema({
-  appConfig: {
-    ui: group({
-      title: "UI",
-      description: "UI Customization.",
-      icon: "i-lucide-palette",
-      fields: {
-        colors: group({
-          title: "Colors",
-          description: "Manage main colors of your application",
-          icon: "i-lucide-palette",
-          fields: {
-            primary: field({
-              type: "string",
-              title: "Primary",
-              description: "Primary color of your UI.",
-              icon: "i-lucide-palette",
-              default: "green",
-              required: [
-                "red",
-                "orange",
-                "amber",
-                "yellow",
-                "lime",
-                "green",
-                "emerald",
-                "teal",
-                "cyan",
-                "sky",
-                "blue",
-                "indigo",
-                "violet",
-                "purple",
-                "fuchsia",
-                "pink",
-                "rose",
-              ],
-            }),
-            neutral: field({
-              type: "string",
-              title: "Neutral",
-              description: "Neutral color of your UI.",
-              icon: "i-lucide-palette",
-              default: "slate",
-              required: ["slate", "gray", "zinc", "neutral", "stone"],
-            }),
-          },
-        }),
-        icons: group({
-          title: "Icons",
-          description: "Manage icons used in the application.",
-          icon: "i-lucide-settings",
-          fields: {
-            search: field({
-              type: "icon",
-              title: "Search Bar",
-              description: "Icon to display in the search bar.",
-              icon: "i-lucide-search",
-              default: "i-lucide-search",
-            }),
-            dark: field({
-              type: "icon",
-              title: "Dark mode",
-              description: "Icon of color mode button for dark mode.",
-              icon: "i-lucide-moon",
-              default: "i-lucide-moon",
-            }),
-            light: field({
-              type: "icon",
-              title: "Light mode",
-              description: "Icon of color mode button for light mode.",
-              icon: "i-lucide-sun",
-              default: "i-lucide-sun",
-            }),
-            external: field({
-              type: "icon",
-              title: "External Link",
-              description: "Icon for external link.",
-              icon: "i-lucide-external-link",
-              default: "i-lucide-external-link",
-            }),
-            chevron: field({
-              type: "icon",
-              title: "Chevron",
-              description: "Icon for chevron.",
-              icon: "i-lucide-chevron-down",
-              default: "i-lucide-chevron-down",
-            }),
-            hash: field({
-              type: "icon",
-              title: "Hash",
-              description: "Icon for hash anchors.",
-              icon: "i-lucide-hash",
-              default: "i-lucide-hash",
-            }),
-          },
-        }),
-      },
-    }),
-    seo: group({
-      title: "SEO",
-      description: "SEO configuration.",
-      icon: "i-lucide-search",
-      fields: {
-        title: field({
-          type: "string",
-          title: "Title",
-          description: "Title to display in the header.",
-          icon: "i-lucide-type",
-          default: "",
-        }),
-        description: field({
-          type: "string",
-          title: "Description",
-          description: "Description to display in the header.",
-          icon: "i-lucide-type",
-          default: "",
-        }),
-      },
-    }),
-    header: group({
-      title: "Header",
-      description: "Header configuration.",
-      icon: "i-lucide-layout",
-      fields: {
-        title: field({
-          type: "string",
-          title: "Title",
-          description: "Title to display in the header.",
-          icon: "i-lucide-type",
-          default: "",
-        }),
-        logo: group({
-          title: "Logo",
-          description: "Header logo configuration.",
-          icon: "i-lucide-image",
-          fields: {
-            light: field({
-              type: "media",
-              title: "Light Mode Logo",
-              description: "Pick an image from your gallery.",
-              icon: "i-lucide-sun",
-              default: "",
-            }),
-            dark: field({
-              type: "media",
-              title: "Dark Mode Logo",
-              description: "Pick an image from your gallery.",
-              icon: "i-lucide-moon",
-              default: "",
-            }),
-            alt: field({
-              type: "string",
-              title: "Alt",
-              description: "Alt to display for accessibility.",
-              icon: "i-lucide-text",
-              default: "",
-            }),
-          },
-        }),
-        links: field({
-          type: "array",
-          title: "Links",
-          description: "Navigation links to display in the header.",
-          icon: "i-lucide-link",
-          default: [],
-        }),
-        attribution: group({
-          title: "Attribution",
-          description: "Brand attribution rendered beside the header wordmark.",
-          icon: "i-lucide-badge",
-          fields: {
-            prefix: field({
-              type: "string",
-              title: "Prefix",
-              description: 'Unlinked word before the label, e.g. "by".',
-              icon: "i-lucide-text",
-              default: "",
-            }),
-            label: field({
-              type: "string",
-              title: "Label",
-              description: "Linked attribution text. Empty renders nothing.",
-              icon: "i-lucide-type",
-              default: "",
-            }),
-            to: field({
-              type: "string",
-              title: "URL",
-              description: "Destination the label links to.",
-              icon: "i-lucide-link",
-              default: "",
-            }),
-          },
-        }),
-      },
-    }),
-    footer: group({
-      title: "Footer",
-      description: "Footer configuration.",
-      icon: "i-lucide-panel-bottom",
-      fields: {
-        credits: field({
-          type: "string",
-          title: "Credits",
-          description: "Copyright line. Falls back to the header title.",
-          icon: "i-lucide-copyright",
-          default: "",
-        }),
-        links: field({
-          type: "array",
-          title: "Links",
-          description: "Navigation links to display in the footer.",
-          icon: "i-lucide-link",
-          default: [],
-        }),
-      },
-    }),
-    socials: field({
-      type: "object",
-      title: "Social Networks",
-      description: "Social links configuration.",
-      icon: "i-lucide-network",
-      default: {},
-    }),
-    toc: group({
-      title: "Table of contents",
-      description: "TOC configuration.",
-      icon: "i-lucide-list",
-      fields: {
-        title: field({
-          type: "string",
-          title: "Title",
-          description: "Title of the table of contents.",
-          icon: "i-lucide-heading",
-          default: "On this page",
-        }),
-        bottom: group({
-          title: "Bottom",
-          description: "Bottom section of the table of contents.",
-          icon: "i-lucide-list",
-          fields: {
-            title: field({
-              type: "string",
-              title: "Title",
-              description: "Title of the bottom section.",
-              icon: "i-lucide-heading",
-              default: "Community",
-            }),
-            links: field({
-              type: "array",
-              title: "Links",
-              description: "Links to display in the bottom section.",
-              icon: "i-lucide-link",
-              default: [],
-            }),
-          },
-        }),
-      },
-    }),
-    analytics: group({
-      title: "Analytics",
-      description: "PostHog analytics plugin (production only, requires a runtime key).",
-      icon: "i-lucide-chart-line",
-      fields: {
-        enabled: field({
-          type: "boolean",
-          title: "Enabled",
-          description: "Set to false to opt out of the analytics plugin.",
-          icon: "i-lucide-toggle-right",
-          default: true,
-        }),
-      },
-    }),
-    i18nRedirect: group({
-      title: "Locale redirect",
-      description: "Redirect `/` to `/{locale}` (only fires when i18n is configured).",
-      icon: "i-lucide-languages",
-      fields: {
-        enabled: field({
-          type: "boolean",
-          title: "Enabled",
-          description: "Set to false to opt out of the locale redirect.",
-          icon: "i-lucide-toggle-right",
-          default: true,
-        }),
-      },
-    }),
-    nonRouteCategories: field({
-      type: "object",
-      title: "Non-route categories",
-      description:
-        "Navigation folders that group pages without owning a route, keyed by directory name.",
-      icon: "i-lucide-folder-tree",
-      default: {},
-    }),
-    docsTheme: group({
-      title: "Docs theme",
-      description: "Documentation-specific theme options.",
-      icon: "i-lucide-book-open",
-      fields: {
-        frameworks: field({
-          type: "array",
-          title: "Frameworks",
-          description:
-            "Frameworks offered by the sidebar select and in-content switcher, in display order. Empty by default — `defu` concatenates arrays across layers, so a non-empty default here could only be appended to, never overridden.",
-          icon: "i-lucide-layers",
-          default: [],
-        }),
-      },
-    }),
-    ogImage: group({
-      title: "OG image",
-      description: "Social share card options.",
-      icon: "i-lucide-image",
-      fields: {
-        accent: field({
-          type: "string",
-          title: "Accent",
-          description:
-            "Accent colour for the OG card headline, as a literal CSS colour — satori has no custom properties, so `var(--ui-primary)` cannot be used here. Left unset, it is resolved at build time by following `--ui-primary` to the `--color-<scale>` literal it aliases in the registered CSS, so most consumers never set it.",
-          icon: "i-lucide-palette",
-          default: "",
-        }),
-      },
-    }),
-    github: group({
-      title: "GitHub",
-      description: "GitHub configuration.",
-      icon: "i-simple-icons-github",
-      fields: {
-        url: field({
-          type: "string",
-          title: "URL",
-          description: "GitHub URL.",
-          icon: "i-simple-icons-github",
-          default: "",
-        }),
-        branch: field({
-          type: "string",
-          title: "Branch",
-          description: "GitHub branch.",
-          icon: "i-lucide-git-branch",
-          default: "main",
-        }),
-        rootDir: field({
-          type: "string",
-          title: "Root Directory",
-          description: "Root directory of the GitHub repository.",
-          icon: "i-lucide-folder",
-          default: "",
-        }),
-      },
-    }),
-  },
-});

package/server/plugins/llms-redirect.ts

@@ -1,60 +0,0 @@
-import type { H3Event } from "h3";
-import { withoutTrailingSlash } from "ufo";
-
-/**
- * Serve `/llms.txt` from the homepage for AI agents and crawlers.
- *
- * Human browsers still get the rendered homepage; only clients that ask for
- * markdown (`Accept: text/markdown`) or identify as `curl` are redirected to
- * the `nuxt-llms` entry point. This mirrors Docus's agent-friendly behaviour
- * but works across Nitro presets (we deploy the node-server output), where the
- * upstream Vercel-config rewrite does not apply.
- *
- * It runs on the `request` hook rather than as route middleware so it fires
- * before Nitro's public-asset handler serves the prerendered homepage — route
- * middleware would never see a request for a statically generated page.
- */
-export default defineNitroPlugin((nitroApp) => {
-  nitroApp.hooks.hook("request", (event) => {
-    if (event.method !== "GET" && event.method !== "HEAD") {
-      return;
-    }
-
-    const path = withoutTrailingSlash(event.path.split("?")[0]) || "/";
-    if (!isRootPath(event, path)) {
-      return;
-    }
-
-    const accept = getHeader(event, "accept") ?? "";
-    const userAgent = getHeader(event, "user-agent") ?? "";
-
-    const wantsMarkdown = accept.includes("text/markdown");
-    const isCurl = /^curl\//i.test(userAgent);
-
-    if (wantsMarkdown || isCurl) {
-      return sendRedirect(event, "/llms.txt", 302);
-    }
-  });
-});
-
-/**
- * True for `/` and, when i18n is enabled, each locale homepage (e.g. `/en`).
- */
-function isRootPath(event: H3Event, path: string) {
-  if (path === "/") {
-    return true;
-  }
-
-  const i18n = useRuntimeConfig(event).public.i18n as
-    | { locales?: (string | { code: string })[] }
-    | undefined;
-
-  if (!i18n?.locales) {
-    return false;
-  }
-
-  return i18n.locales.some((locale) => {
-    const code = typeof locale === "string" ? locale : locale.code;
-    return path === `/${code}`;
-  });
-}