@lexibase/rdx-next 3.2.0 → 4.0.0

package/README.md

@@ -16,6 +16,10 @@ must still be trusted project-owned content, not untrusted uploads.
 It exposes the `rdx` command used by generated projects to create their
 internal `.rdx` application and run Next.js.
 
+Run `pnpm rdx check` to validate static documentation links, heading fragments
+and local files in public/ before deployment. It reports source locations and
+exits nonzero for problems, without preparing the runtime or rendering documents.
+
 Run `pnpm rdx add versioning` (or `npm exec -- rdx add versioning`) from a
 documentation project to install and activate the official optional plugin.
 The command detects the package manager, preserves config and plugin options,
@@ -89,7 +93,6 @@ export default defineConfig({
     authors: [{ name: 'My team', url: 'https://example.com' }],
     keywords: ['documentation', 'my-project'],
     icons: { icon: '/favicon.ico' },
-    robots: { index: true, follow: true },
     openGraph: {
       type: 'website',
       images: [{ url: '/og.png', width: 1200, height: 630, alt: 'My project' }],
@@ -111,7 +114,7 @@ production domain or force localhost. Image, favicon and manifest paths refer
 to files you create in `public/`. Nothing creates those assets automatically.
 
 Supported fields are `metadataBase` (an absolute http(s) string),
-`applicationName`, `authors`, `keywords`, `icons`, `manifest`, `robots`,
+`applicationName`, `authors`, `keywords`, `icons`, `manifest`,
 `openGraph` and `twitter`. TypeScript describes the supported nested options,
 and invalid fields fail during configuration validation. This is a portable
 subset, not an unrestricted pass-through of all Next.js metadata options.

package/bin/cli.mjs

@@ -50,7 +50,12 @@ export async function runRdxCli({ templateDir } = {}) {
 
   async function main() {
     if (!command || command === 'help' || command === '--help') {
-      console.log('Usage: rdx <dev|build|start|prepare|add|plugin-command>')
+      console.log(
+        'Usage: rdx <dev|build|start|prepare|check|add|plugin-command>'
+      )
+      console.log(
+        '  rdx check: validate documentation links, sections and local assets'
+      )
       console.log('  rdx add versioning [--package-manager npm|pnpm|yarn]')
       console.log(
         'Plugin commands are registered through plugins in rdx.config.ts.'
@@ -58,6 +63,19 @@ export async function runRdxCli({ templateDir } = {}) {
       return
     }
 
+    if (command === 'check') {
+      if (
+        commandArgs.length === 1 &&
+        ['--help', '-h'].includes(commandArgs[0])
+      ) {
+        console.log(
+          'Usage: rdx check\nValidate static MDX links, section anchors and local public/ files without building the site.'
+        )
+        return
+      }
+      if (commandArgs.length) throw new Error('Usage: rdx check')
+    }
+
     if (command === 'add') {
       const { addVersioning, parseAddArguments } =
         await import('./add-plugin.mjs')
@@ -96,6 +114,17 @@ export async function runRdxCli({ templateDir } = {}) {
       rootDir: projectRoot,
       command,
     })
+    if (command === 'check') {
+      const { checkDocumentation, formatDocumentationCheck } =
+        await import('@lexibase/rdx-core/check')
+      const report = checkDocumentation(project)
+      const output = formatDocumentationCheck(report)
+      if (report.diagnostics.length) {
+        console.error(output)
+        process.exitCode = 1
+      } else console.log(output)
+      return
+    }
     if (command === 'prepare') {
       await prepareRuntime()
       console.log('RDX runtime prepared in .rdx/')
@@ -107,7 +136,7 @@ export async function runRdxCli({ templateDir } = {}) {
       )
       if (!pluginCommand)
         throw new Error(
-          `Unknown command "${command}". Available: dev, build, start, prepare, add${project.commands.map((entry) => `, ${entry.name}`).join('')}. Install and configure the plugin that provides this command.`
+          `Unknown command "${command}". Available: dev, build, start, prepare, check, add${project.commands.map((entry) => `, ${entry.name}`).join('')}. Install and configure the plugin that provides this command.`
         )
       await pluginCommand.run({
         rootDir: projectRoot,

package/dist/runtime/index.d.ts

@@ -1,14 +1,26 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { RdxProject, RDXConfig, RdxDocPage } from '@lexibase/rdx-types';
+import { RdxProject, RDXConfig, RdxContentSource, RdxDocPage } from '@lexibase/rdx-types';
 export { createRdxProject, getProjectDocsPaths } from '@lexibase/rdx-core';
-import { Metadata } from 'next';
+import { MetadataRoute, Metadata } from 'next';
 
 declare function getSearchSources(project: RdxProject): {
     source: string;
 }[];
 declare function getSearchResponse(project: RdxProject, key: string): Response;
 
+/** Published editions replace live development content in search results. */
+declare function getSourceRobots(project: RdxProject, source: RdxContentSource): {
+    index: boolean;
+    follow: boolean;
+};
+/** Use the configured public URL only; development hosts are never inferred. */
+declare function getRdxRobots(config: RDXConfig): MetadataRoute.Robots;
+/** Share the indexing policy while allowing host applications to map their URLs. */
+declare function getRdxSitemap(project: RdxProject, { documentPath, }?: {
+    documentPath?: (source: RdxContentSource, page: RdxDocPage) => string;
+}): MetadataRoute.Sitemap;
+
 /** Read metadata from the same content source and index used by the page. */
 declare function getDocumentMetadata({ project, slug, }: {
     project: RdxProject;
@@ -35,4 +47,4 @@ declare function DocsPage({ slug, project, }: {
     project: RdxProject;
 }): Promise<react.JSX.Element>;
 
-export { DocsPage, HomePage, NotFoundPage, RdxLayout, getDocumentMetadata, getPageMetadata, getRdxMetadata, getSearchResponse, getSearchSources };
+export { DocsPage, HomePage, NotFoundPage, RdxLayout, getDocumentMetadata, getPageMetadata, getRdxMetadata, getRdxRobots, getRdxSitemap, getSearchResponse, getSearchSources, getSourceRobots };

package/dist/runtime/index.js

@@ -2,7 +2,7 @@
 import {
   getDocument as getDocument2,
   getDocsPaths,
-  getSourceOptions as getSourceOptions2,
+  getSourceOptions as getSourceOptions3,
   resolveDocsRoute as resolveDocsRoute2
 } from "@lexibase/rdx-core";
 import { Button } from "@lexibase/rdx-ui/components/button";
@@ -63,11 +63,13 @@ function getSearchSources(project) {
   return project.config.search ? project.sources.filter((source) => source.redirectTo === void 0).map((source) => ({ source: source.routePrefix || "_" })) : [];
 }
 function getSearchResponse(project, key) {
-  if (!project.config.search) return new Response(null, { status: 404 });
+  const headers = { "X-Robots-Tag": "noindex, follow" };
+  if (!project.config.search)
+    return new Response(null, { status: 404, headers });
   const source = project.sources.find(
     (entry) => entry.redirectTo === void 0 && (entry.routePrefix || "_") === key
   );
-  if (!source) return new Response(null, { status: 404 });
+  if (!source) return new Response(null, { status: 404, headers });
   const options = getSourceOptions(project, source);
   const documents = getDocsIndex(options).flatMap(
     (category) => category.pages.map((page) => ({
@@ -82,7 +84,47 @@ function getSearchResponse(project, key) {
       content: getDocument(page.slug, options)?.content ?? ""
     }))
   );
-  return Response.json(buildSearchIndex(documents));
+  return Response.json(buildSearchIndex(documents), { headers });
+}
+
+// src/runtime/indexing.ts
+import { getDocsIndex as getDocsIndex2, getSourceOptions as getSourceOptions2 } from "@lexibase/rdx-core";
+function getSourceRobots(project, source) {
+  const published = project.sources.some(
+    (entry) => entry.id !== "current" && entry.redirectTo === void 0 && entry.badge !== "Archived"
+  );
+  return {
+    index: source.redirectTo === void 0 && source.badge !== "Archived" && (source.id !== "current" || !published),
+    follow: true
+  };
+}
+function getRdxRobots(config) {
+  return {
+    // Do not disallow noindex pages: crawlers must read their HTML directive.
+    rules: { userAgent: "*", allow: "/" },
+    ...config.metadata.metadataBase ? { sitemap: new URL("/sitemap.xml", config.metadata.metadataBase).href } : {}
+  };
+}
+function getRdxSitemap(project, {
+  documentPath = (source, page) => [
+    "/docs",
+    source.routePrefix,
+    page.slug.split("/").map(encodeURIComponent).join("/")
+  ].filter(Boolean).join("/")
+} = {}) {
+  const base = project.config.metadata.metadataBase;
+  if (!base) return [];
+  const urls = /* @__PURE__ */ new Set();
+  if (project.config.homepage?.enabled) urls.add(new URL("/", base).href);
+  for (const source of project.sources) {
+    if (!getSourceRobots(project, source).index) continue;
+    for (const category of getDocsIndex2(getSourceOptions2(project, source))) {
+      for (const page of category.pages) {
+        urls.add(new URL(documentPath(source, page), base).href);
+      }
+    }
+  }
+  return [...urls].map((url) => ({ url }));
 }
 
 // src/runtime/metadata.ts
@@ -93,11 +135,15 @@ function getDocumentMetadata({
   slug
 }) {
   const route = resolveDocsRoute(project, slug);
-  if (route.source.redirectTo !== void 0) return {};
-  if (!route.slug) return {};
+  if (route.source.redirectTo !== void 0)
+    return { robots: getSourceRobots(project, route.source) };
+  if (!route.slug) return { robots: { index: false, follow: true } };
   if (!route.document) notFound();
   const page = route.categories.flatMap((category) => category.pages).find((page2) => page2.slug === route.slug);
-  return getPageMetadata(project.config, page);
+  return {
+    ...getPageMetadata(project.config, page),
+    robots: getSourceRobots(project, route.source)
+  };
 }
 function getPageMetadata(config, page) {
   const title = page.title;
@@ -117,6 +163,7 @@ function getRdxMetadata(config) {
     title: { default: name, template: `%s | ${name}` },
     description: config.description,
     ...metadata,
+    robots: { index: true, follow: true },
     ...metadataBase ? { metadataBase: new URL(metadataBase) } : {},
     ...metadata.openGraph ? {
       openGraph: {
@@ -164,7 +211,7 @@ function RdxHeader({
   const messages = getMessages(config.lang);
   const { source, slug: currentSlug } = resolveDocsRoute2(project, slug);
   const options = project.sources.filter((edition) => edition.redirectTo === void 0).map((edition) => {
-    const docs = getSourceOptions2(project, edition);
+    const docs = getSourceOptions3(project, edition);
     const destination = currentSlug && getDocument2(currentSlug, docs) ? currentSlug : getDocsPaths(docs)[0];
     return {
       id: edition.id,
@@ -261,7 +308,7 @@ async function DocsPage({
     document.content,
     getMdxComponents(project.config.lang),
     {
-      sourceRoot: getSourceOptions2(project, source).docsDir,
+      sourceRoot: getSourceOptions3(project, source).docsDir,
       sourcePath: document.sourcePath,
       routePrefix: source.routePrefix,
       documents: categories.flatMap((category2) => category2.pages)
@@ -381,6 +428,9 @@ export {
   getPageMetadata,
   getProjectDocsPaths,
   getRdxMetadata,
+  getRdxRobots,
+  getRdxSitemap,
   getSearchResponse,
-  getSearchSources
+  getSearchSources,
+  getSourceRobots
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-next",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "The Next.js runtime for RDX documentation projects.",
   "license": "MIT",
   "type": "module",
@@ -51,8 +51,8 @@
     "next-mdx-remote": "^6.0.0",
     "remark-gfm": "^4",
     "typescript": "6.0.3",
-    "@lexibase/rdx-core": "1.4.0",
-    "@lexibase/rdx-types": "1.2.0"
+    "@lexibase/rdx-types": "2.0.0",
+    "@lexibase/rdx-core": "2.0.0"
   },
   "peerDependencies": {
     "@lexibase/rdx-ui": "^3.2.0",
@@ -80,9 +80,9 @@
     "next": "^16.4.2",
     "react": "19.3.1",
     "react-dom": "19.3.1",
-    "@lexibase/rdx-ui": "3.2.0",
-    "@rdx/typescript-config": "1.0.0",
-    "@rdx/eslint-config": "1.0.0"
+    "@rdx/eslint-config": "1.0.0",
+    "@lexibase/rdx-ui": "3.2.1",
+    "@rdx/typescript-config": "1.0.0"
   },
   "scripts": {
     "dev": "tsup src/index.ts src/runtime/index.tsx --format esm --dts --watch --external @lexibase/rdx-core --external @lexibase/rdx-types --external @lexibase/rdx-ui --external next --external react --external react-dom --external next-mdx-remote",

package/templates/runtime/app/robots.ts

@@ -0,0 +1,6 @@
+import { getRdxRobots } from '@lexibase/rdx-next/runtime'
+import { getProject } from '../rdx-project'
+
+export default async function robots() {
+  return getRdxRobots((await getProject()).config)
+}

package/templates/runtime/app/sitemap.ts

@@ -0,0 +1,6 @@
+import { getRdxSitemap } from '@lexibase/rdx-next/runtime'
+import { getProject } from '../rdx-project'
+
+export default async function sitemap() {
+  return getRdxSitemap(await getProject())
+}