radiant-docs 0.1.58 → 0.1.60

package/template/src/lib/page-description.ts

@@ -0,0 +1,20 @@
+export function normalizePageDescription(value: unknown): string | undefined {
+  if (typeof value !== "string") return undefined;
+
+  const normalized = value.replace(/\s+/g, " ").trim();
+  return normalized || undefined;
+}
+
+export function resolvePageDescription(args: {
+  pageTitle?: string;
+  pageDescription?: unknown;
+  docsTitle: string;
+}): string {
+  const explicitDescription = normalizePageDescription(args.pageDescription);
+  if (explicitDescription) return explicitDescription;
+
+  const pageTitle = args.pageTitle?.trim();
+  return pageTitle
+    ? `Learn about ${pageTitle} in the ${args.docsTitle} documentation.`
+    : `${args.docsTitle} documentation.`;
+}

package/template/src/lib/routes.ts

@@ -5,7 +5,7 @@ import {
   type NavOpenApiPage,
   type NavMenuItem,
   type NavOpenApi,
-  type HiddenPageRoute,
+  type DocsConfig,
   loadOpenApiSpec,
 } from "./validation";
 import {
@@ -50,12 +50,43 @@ export interface OpenApiRoute extends BaseRoute {
 // Discriminated union
 export type Route = MdxRoute | OpenApiRoute;
 
+type AuxiliaryPageRef = {
+  filePath: string;
+  href: string;
+};
+
+type DocsConfigWithAuxiliaryRefs = DocsConfig & {
+  auxiliaryPageRefs?: AuxiliaryPageRef[];
+};
+
 function normalizeTitle(value: unknown): string | undefined {
   if (typeof value !== "string") return undefined;
   const trimmed = value.trim();
   return trimmed.length ? trimmed : undefined;
 }
 
+function getAuxiliaryPageRefs(
+  config: DocsConfigWithAuxiliaryRefs,
+): AuxiliaryPageRef[] {
+  return config.auxiliaryPageRefs ?? [];
+}
+
+function findCanonicalMdxRoute(
+  routes: Route[],
+  filePath: string,
+): MdxRoute | undefined {
+  return (
+    routes.find(
+      (route): route is MdxRoute =>
+        route.type === "mdx" && route.filePath === filePath && !route.hidden,
+    ) ??
+    routes.find(
+      (route): route is MdxRoute =>
+        route.type === "mdx" && route.filePath === filePath,
+    )
+  );
+}
+
 export function resolveMdxPageTitle(args: {
   entry: any;
   docsTitle?: unknown;
@@ -114,33 +145,36 @@ function processPageItem(
   };
 }
 
-function processHiddenPageRoute(route: HiddenPageRoute, docs: any[]): MdxRoute {
+function processAuxiliaryPageRefRoute(
+  ref: AuxiliaryPageRef,
+  docs: any[],
+): MdxRoute {
   const entry = docs.find((doc: any) => {
     const docPath = doc.id.replace(/\.mdx$/, "");
-    return docPath === route.filePath;
+    return docPath === ref.filePath;
   });
 
   if (!entry) {
     throw new Error(
-      `Could not find content collection entry for path: ${route.filePath}`,
+      `Could not find content collection entry for path: ${ref.filePath}`,
     );
   }
 
-  const slug = route.href.replace(/^\/+/, "").replace(/\/+$/, "");
+  const slug = ref.href.replace(/^\/+/, "").replace(/\/+$/, "");
 
   return {
     type: "mdx",
     slug,
     preferredSlug: slug,
     fallbackSlug: buildMdxPageFallbackSlug({
-      filePath: route.filePath,
+      filePath: ref.filePath,
       groupSlug: "",
     }),
-    routeIdentity: `mdx:${route.filePath}`,
-    filePath: route.filePath,
+    routeIdentity: `mdx:${ref.filePath}`,
+    filePath: ref.filePath,
     title: resolveMdxPageTitle({
       entry,
-      filePath: route.filePath,
+      filePath: ref.filePath,
     }),
     hidden: true,
   };
@@ -476,8 +510,16 @@ export async function getAllRoutes(): Promise<Route[]> {
     allRoutes = allRoutes.concat(openApiRoutes);
   }
 
-  for (const hiddenPageRoute of config.hiddenPageRoutes ?? []) {
-    const hiddenRoute = processHiddenPageRoute(hiddenPageRoute, docs);
+  for (const auxiliaryPageRef of getAuxiliaryPageRefs(config)) {
+    const existingFileRoute = allRoutes.find(
+      (route) =>
+        route.type === "mdx" && route.filePath === auxiliaryPageRef.filePath,
+    );
+    if (existingFileRoute) {
+      continue;
+    }
+
+    const hiddenRoute = processAuxiliaryPageRefRoute(auxiliaryPageRef, docs);
     const existingRoute = allRoutes.find(
       (route) => route.slug === hiddenRoute.slug,
     );
@@ -523,23 +565,36 @@ export async function getMdxRouteHref(args: {
   return prependBasePath(`/${route?.slug ?? preferredSlug}`);
 }
 
+async function getCanonicalMdxRouteHref(filePath: string): Promise<string> {
+  const config = await getConfig();
+  if (config.home && filePath === config.home) {
+    return prependBasePath("/");
+  }
+
+  const routes = await getAllRoutes();
+  const route = findCanonicalMdxRoute(routes, filePath);
+
+  if (route) {
+    return prependBasePath(`/${route.slug}`);
+  }
+
+  return getMdxRouteHref({ filePath });
+}
+
 export async function resolveConfiguredHref(
   href: string,
-  hiddenPageRoutes: HiddenPageRoute[] | undefined,
+  config: DocsConfigWithAuxiliaryRefs,
 ): Promise<string> {
   const normalizedHref = href.replace(/^\/+/, "").replace(/\/+$/, "");
-  const hiddenPageRoute = hiddenPageRoutes?.find(
+  const auxiliaryPageRef = getAuxiliaryPageRefs(config).find(
     (route) => route.href.replace(/^\/+/, "").replace(/\/+$/, "") === normalizedHref,
   );
 
-  if (!hiddenPageRoute) {
+  if (!auxiliaryPageRef) {
     return withBasePath(href);
   }
 
-  return getMdxRouteHref({
-    filePath: hiddenPageRoute.filePath,
-    preferredSlug: hiddenPageRoute.href,
-  });
+  return getCanonicalMdxRouteHref(auxiliaryPageRef.filePath);
 }
 
 export async function getOpenApiEndpointRouteHref(args: {

package/template/src/pages/-/fonts/[...font].ts

@@ -0,0 +1,50 @@
+import fs from "node:fs/promises";
+import type { APIRoute } from "astro";
+import {
+  type DocsFontFile,
+  getSelectedDocsFontFiles,
+} from "../../../lib/font-css";
+import { getConfig } from "../../../lib/validation";
+
+async function getSelectedFontFileMap(): Promise<Map<string, DocsFontFile>> {
+  const config = await getConfig();
+  return new Map(
+    getSelectedDocsFontFiles(config.theme).map((fontFile) => [
+      fontFile.routePath,
+      fontFile,
+    ]),
+  );
+}
+
+export async function getStaticPaths() {
+  const selectedFontFiles = await getSelectedFontFileMap();
+
+  return Array.from(selectedFontFiles.values(), (fontFile) => ({
+    params: {
+      font: fontFile.routePath,
+    },
+    props: {
+      fontFile,
+    },
+  }));
+}
+
+export const GET: APIRoute = async ({ params, props }) => {
+  const selectedFontFiles = await getSelectedFontFileMap();
+  const fontFile =
+    (props.fontFile as DocsFontFile | undefined) ??
+    selectedFontFiles.get(params.font ?? "");
+
+  if (!fontFile || !selectedFontFiles.has(fontFile.routePath)) {
+    return new Response("Font not found.", { status: 404 });
+  }
+
+  const fontBytes = await fs.readFile(fontFile.sourcePath);
+
+  return new Response(fontBytes, {
+    headers: {
+      "Cache-Control": "public, max-age=31536000, immutable",
+      "Content-Type": fontFile.contentType,
+    },
+  });
+};

package/template/src/pages/404.astro

@@ -17,7 +17,7 @@ import Layout from "../layouts/Layout.astro";
       404
     </p>
     <h1
-      class="text-3xl font-semibold tracking-tight text-neutral-900 dark:text-neutral-50"
+      class="rd-document-heading text-3xl font-semibold tracking-tight text-neutral-900 dark:text-neutral-50"
     >
       Page not found
     </h1>
@@ -35,7 +35,7 @@ import Layout from "../layouts/Layout.astro";
       </button>
       <a
         href={withBasePath("/")}
-        class="inline-flex items-center justify-center gap-2 rounded-lg [corner-shape:superellipse(1.2)] border border-border bg-linear-to-b from-neutral-900/85 to-neutral-900 px-4 py-2 text-sm font-[350] text-white shadow-sm transition hover:opacity-95 dark:from-neutral-100 dark:to-neutral-200 dark:font-[450] dark:text-neutral-950"
+        class="inline-flex items-center justify-center gap-2 rounded-lg [corner-shape:superellipse(1.2)] border border-border bg-linear-to-b from-neutral-900/85 to-neutral-900 px-4 py-2 text-sm font-normal text-white shadow-sm transition hover:opacity-95 dark:from-neutral-100 dark:to-neutral-200 dark:font-medium dark:text-neutral-950"
       >
         <Icon name="lucide:house" class="size-4" />
         Take me home

package/template/src/pages/[...slug]/index.md.ts

@@ -0,0 +1,35 @@
+import type { APIRoute } from "astro";
+import {
+  getMarkdownRoutePages,
+  MARKDOWN_CONTENT_TYPE,
+  type AiMarkdownPage,
+} from "../../lib/ai-artifacts";
+
+export async function getStaticPaths() {
+  const pages = await getMarkdownRoutePages();
+
+  return pages
+    .filter((page) => page.routeSlug)
+    .map((page) => ({
+      params: {
+        slug: page.routeSlug,
+      },
+      props: {
+        page,
+      },
+    }));
+}
+
+export const GET: APIRoute = async ({ props }) => {
+  const page = props.page as AiMarkdownPage | undefined;
+
+  if (!page) {
+    return new Response("Markdown page not found.", { status: 404 });
+  }
+
+  return new Response(page.source, {
+    headers: {
+      "Content-Type": MARKDOWN_CONTENT_TYPE,
+    },
+  });
+};

package/template/src/pages/[...spec].json.ts

@@ -0,0 +1,33 @@
+import type { APIRoute } from "astro";
+import {
+  getOpenApiSpecArtifactsByExtension,
+  readOpenApiSpecArtifact,
+  type OpenApiSpecArtifact,
+} from "../lib/ai-artifacts";
+
+export async function getStaticPaths() {
+  const specs = await getOpenApiSpecArtifactsByExtension(".json");
+
+  return specs.map((spec) => ({
+    params: {
+      spec: spec.routeParam,
+    },
+    props: {
+      spec,
+    },
+  }));
+}
+
+export const GET: APIRoute = async ({ props }) => {
+  const spec = props.spec as OpenApiSpecArtifact | undefined;
+
+  if (!spec) {
+    return new Response("OpenAPI spec not found.", { status: 404 });
+  }
+
+  return new Response(await readOpenApiSpecArtifact(spec), {
+    headers: {
+      "Content-Type": spec.contentType ?? "application/json; charset=utf-8",
+    },
+  });
+};

package/template/src/pages/[...spec].yaml.ts

@@ -0,0 +1,33 @@
+import type { APIRoute } from "astro";
+import {
+  getOpenApiSpecArtifactsByExtension,
+  readOpenApiSpecArtifact,
+  type OpenApiSpecArtifact,
+} from "../lib/ai-artifacts";
+
+export async function getStaticPaths() {
+  const specs = await getOpenApiSpecArtifactsByExtension(".yaml");
+
+  return specs.map((spec) => ({
+    params: {
+      spec: spec.routeParam,
+    },
+    props: {
+      spec,
+    },
+  }));
+}
+
+export const GET: APIRoute = async ({ props }) => {
+  const spec = props.spec as OpenApiSpecArtifact | undefined;
+
+  if (!spec) {
+    return new Response("OpenAPI spec not found.", { status: 404 });
+  }
+
+  return new Response(await readOpenApiSpecArtifact(spec), {
+    headers: {
+      "Content-Type": spec.contentType ?? "application/yaml; charset=utf-8",
+    },
+  });
+};

package/template/src/pages/[...spec].yml.ts

@@ -0,0 +1,33 @@
+import type { APIRoute } from "astro";
+import {
+  getOpenApiSpecArtifactsByExtension,
+  readOpenApiSpecArtifact,
+  type OpenApiSpecArtifact,
+} from "../lib/ai-artifacts";
+
+export async function getStaticPaths() {
+  const specs = await getOpenApiSpecArtifactsByExtension(".yml");
+
+  return specs.map((spec) => ({
+    params: {
+      spec: spec.routeParam,
+    },
+    props: {
+      spec,
+    },
+  }));
+}
+
+export const GET: APIRoute = async ({ props }) => {
+  const spec = props.spec as OpenApiSpecArtifact | undefined;
+
+  if (!spec) {
+    return new Response("OpenAPI spec not found.", { status: 404 });
+  }
+
+  return new Response(await readOpenApiSpecArtifact(spec), {
+    headers: {
+      "Content-Type": spec.contentType ?? "application/yaml; charset=utf-8",
+    },
+  });
+};

package/template/src/pages/index.md.ts

@@ -0,0 +1,17 @@
+import { getHomeMarkdownPage, MARKDOWN_CONTENT_TYPE } from "../lib/ai-artifacts";
+
+export const prerender = true;
+
+export async function GET(): Promise<Response> {
+  const page = await getHomeMarkdownPage();
+
+  if (!page) {
+    return new Response("Home page not found.", { status: 404 });
+  }
+
+  return new Response(page.source, {
+    headers: {
+      "Content-Type": MARKDOWN_CONTENT_TYPE,
+    },
+  });
+}

package/template/src/pages/llms-full.txt.ts

@@ -0,0 +1,11 @@
+import { getLlmsFullTxt, PLAIN_TEXT_CONTENT_TYPE } from "../lib/ai-artifacts";
+
+export const prerender = true;
+
+export async function GET(): Promise<Response> {
+  return new Response(await getLlmsFullTxt(), {
+    headers: {
+      "Content-Type": PLAIN_TEXT_CONTENT_TYPE,
+    },
+  });
+}

package/template/src/pages/llms.txt.ts

@@ -0,0 +1,11 @@
+import { getLlmsTxt, PLAIN_TEXT_CONTENT_TYPE } from "../lib/ai-artifacts";
+
+export const prerender = true;
+
+export async function GET(): Promise<Response> {
+  return new Response(await getLlmsTxt(), {
+    headers: {
+      "Content-Type": PLAIN_TEXT_CONTENT_TYPE,
+    },
+  });
+}

package/template/src/styles/global.css

@@ -1,5 +1,4 @@
 @import "tailwindcss";
-@import "./vaul.css";
 @plugin "@tailwindcss/typography";
 
 @theme {
@@ -23,10 +22,26 @@
   --color-accent-foreground: var(--accent-foreground);
   --color-destructive: var(--destructive);
 
-  --font-sans: "Google Sans Flex", ui-sans-serif, system-ui, sans-serif;
-  --font-mono:
-    "Geist Mono", ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas,
-    "Liberation Mono", "Courier New", monospace;
+  --font-sans: var(
+    --rd-font-text,
+    "Google Sans Variable",
+    ui-sans-serif,
+    system-ui,
+    sans-serif
+  );
+  --font-heading: var(--rd-font-heading, var(--font-sans));
+  --font-mono: var(
+    --rd-font-code,
+    "Geist Mono Variable",
+    ui-monospace,
+    SFMono-Regular,
+    Menlo,
+    Monaco,
+    Consolas,
+    "Liberation Mono",
+    "Courier New",
+    monospace
+  );
 
   --radius-sm: calc(var(--radius) - 4px);
   --radius-md: calc(var(--radius) - 2px);
@@ -116,7 +131,7 @@
   }
 
   body {
-    @apply bg-background text-foreground;
+    @apply bg-background font-sans text-foreground;
   }
 }
 
@@ -126,7 +141,7 @@
 
 /* Prose styling */
 .prose-rules {
-  @apply prose max-w-none *:my-6 *:first:mt-0 *:last:mb-0 prose-h2:mt-7 prose-h2:mb-2 prose-h2:scroll-mt-24 prose-h3:mb-2 prose-h3:scroll-mt-24 prose-headings:font-semibold prose-p:mt-0 prose-p:mb-4 prose-ol:mt-0 prose-ol:mb-5 prose-ul:mt-0 prose-ul:mb-5 prose-a:decoration-(--color-theme) prose-a:decoration-from-font prose-blockquote:border-(--color-theme)/30 dark:prose-blockquote:border-(--color-theme)/30;
+  @apply prose max-w-none *:my-6 *:first:mt-0 *:last:mb-0 prose-h2:mt-12 prose-h2:mb-2 prose-h2:scroll-mt-24 prose-h3:mt-8 prose-h3:mb-2 prose-h3:scroll-mt-20 prose-headings:font-semibold prose-p:mt-0 prose-p:mb-4 prose-ol:mt-0 prose-ol:mb-5 prose-ul:mt-0 prose-ul:mb-5 prose-a:decoration-(--color-theme) prose-a:decoration-from-font prose-blockquote:border-(--color-theme)/30 dark:prose-blockquote:border-(--color-theme)/30;
   --tw-prose-body: var(--color-neutral-700);
   --tw-prose-headings: var(--color-neutral-900);
   --tw-prose-lead: var(--color-neutral-600);
@@ -169,6 +184,16 @@
   --tw-prose-invert-td-borders: var(--color-neutral-700);
 }
 
+.rd-document-heading,
+.prose-rules > :is(h1, h2, h3, h4, h5, h6) {
+  font-family: var(--font-heading);
+}
+
+.prose-rules h2 + h3 {
+  margin-block-start: 1rem;
+  margin-top: 1rem;
+}
+
 .dark .prose-rules {
   --tw-prose-body: var(--tw-prose-invert-body);
   --tw-prose-headings: var(--tw-prose-invert-headings);

package/template/src/styles/geist-mono.css

@@ -1,33 +0,0 @@
-/* geist-mono-cyrillic */
-@font-face {
-  font-family: "Geist Mono";
-  font-style: normal;
-  font-weight: 100 900;
-  font-display: swap;
-  src: url("../assets/fonts/geist-mono/cyrillic.woff2") format("woff2");
-  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
-}
-
-/* geist-mono-latin-ext */
-@font-face {
-  font-family: "Geist Mono";
-  font-style: normal;
-  font-weight: 100 900;
-  font-display: swap;
-  src: url("../assets/fonts/geist-mono/latin-ext.woff2") format("woff2");
-  unicode-range:
-    U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF,
-    U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
-}
-
-/* geist-mono-latin */
-@font-face {
-  font-family: "Geist Mono";
-  font-style: normal;
-  font-weight: 100 900;
-  font-display: swap;
-  src: url("../assets/fonts/geist-mono/latin.woff2") format("woff2");
-  unicode-range:
-    U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
-    U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
-}