@lexibase/rdx-next 0.0.0-stage → 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2025 Lexibase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,6 @@
-# Temporary Holding Version
+# `@rdx/next`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The official Next.js runtime for RDX documentation projects.
+
+It exposes the `rdx` command used by generated projects to create their
+internal `.rdx` application and run Next.js.

package/bin/rdx.mjs

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+import { spawn } from 'node:child_process'
+import { createRequire } from 'node:module'
+import { cp, mkdir } from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import process from 'node:process'
+
+const supportedCommands = new Set(['dev', 'build', 'start'])
+const command = process.argv[2]
+const commandArgs = process.argv.slice(3)
+const projectRoot = process.cwd()
+const packageRoot = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  '..'
+)
+const runtimeTemplate = path.join(packageRoot, 'templates', 'runtime')
+const runtimeDirectory = path.join(projectRoot, '.rdx')
+
+async function prepareRuntime() {
+  await mkdir(runtimeDirectory, { recursive: true })
+  await cp(runtimeTemplate, runtimeDirectory, { force: true, recursive: true })
+}
+
+if (command === 'prepare') {
+  await prepareRuntime()
+  console.log('RDX runtime prepared in .rdx/')
+  process.exit(0)
+}
+
+if (!command || !supportedCommands.has(command)) {
+  console.error('Usage: rdx <dev|build|start|prepare>')
+  process.exit(1)
+}
+
+await prepareRuntime()
+
+const projectRequire = createRequire(path.join(projectRoot, 'package.json'))
+const nextCli = projectRequire.resolve('next/dist/bin/next')
+const child = spawn(
+  process.execPath,
+  [nextCli, command, runtimeDirectory, ...commandArgs],
+  { cwd: projectRoot, stdio: 'inherit' }
+)
+
+child.on('exit', (code, signal) => {
+  if (signal) process.kill(process.pid, signal)
+  process.exit(code ?? 1)
+})

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { RdxRuntimeConfig } from '@lexibase/rdx-types';

package/dist/runtime/index.d.ts

@@ -0,0 +1,13 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { RdxRuntimeConfig } from '@lexibase/rdx-types';
+
+declare function RdxLayout({ children, config, }: {
+    children: ReactNode;
+    config: RdxRuntimeConfig;
+}): react_jsx_runtime.JSX.Element;
+declare function DocsPage({ slug }: {
+    slug?: string[];
+}): Promise<react_jsx_runtime.JSX.Element>;
+
+export { DocsPage, RdxLayout };

package/dist/runtime/index.js

@@ -0,0 +1,100 @@
+// src/runtime/index.tsx
+import { getDocument, getDocsIndex, getDocsPaths } from "@lexibase/rdx-core";
+import { compileMDX } from "next-mdx-remote/rsc";
+import Link from "next/link";
+import { notFound } from "next/navigation";
+import { jsx, jsxs } from "react/jsx-runtime";
+var mdxComponents = {
+  h1: (props) => /* @__PURE__ */ jsx("h1", { ...props }),
+  h2: (props) => /* @__PURE__ */ jsx("h2", { ...props }),
+  h3: (props) => /* @__PURE__ */ jsx("h3", { ...props }),
+  p: (props) => /* @__PURE__ */ jsx("p", { ...props }),
+  ul: (props) => /* @__PURE__ */ jsx("ul", { ...props }),
+  ol: (props) => /* @__PURE__ */ jsx("ol", { ...props }),
+  li: (props) => /* @__PURE__ */ jsx("li", { ...props }),
+  blockquote: (props) => /* @__PURE__ */ jsx("blockquote", { ...props }),
+  pre: (props) => /* @__PURE__ */ jsx("pre", { ...props }),
+  code: (props) => /* @__PURE__ */ jsx("code", { ...props }),
+  a: ({ href, ...props }) => {
+    const isExternal = href?.startsWith("http");
+    return /* @__PURE__ */ jsx(
+      "a",
+      {
+        href,
+        rel: isExternal ? "noreferrer" : void 0,
+        target: isExternal ? "_blank" : void 0,
+        ...props
+      }
+    );
+  }
+};
+function RdxLayout({
+  children,
+  config
+}) {
+  const brand = config.navbar?.title || config.title;
+  return /* @__PURE__ */ jsx("html", { lang: "en", children: /* @__PURE__ */ jsxs("body", { children: [
+    /* @__PURE__ */ jsxs("header", { className: "rdx-header", children: [
+      /* @__PURE__ */ jsx(Link, { className: "rdx-brand", href: "/docs", children: brand }),
+      config.navbar?.actions?.github?.visible && config.navbar.actions.github.url && /* @__PURE__ */ jsx(
+        "a",
+        {
+          className: "rdx-github-link",
+          href: config.navbar.actions.github.url,
+          rel: "noreferrer",
+          target: "_blank",
+          children: "GitHub"
+        }
+      )
+    ] }),
+    children
+  ] }) });
+}
+async function DocsPage({ slug }) {
+  const categories = getDocsIndex();
+  const currentSlug = slug?.join("/") || getDocsPaths()[0];
+  if (!currentSlug) {
+    return /* @__PURE__ */ jsxs("main", { className: "rdx-empty-state", children: [
+      /* @__PURE__ */ jsx("h1", { children: "Your documentation is ready." }),
+      /* @__PURE__ */ jsx("p", { children: "Add an `.mdx` file inside `docs/` to create your first page." })
+    ] });
+  }
+  const document = getDocument(currentSlug);
+  if (!document) notFound();
+  const { content } = await compileMDX({
+    source: document.content,
+    components: mdxComponents
+  });
+  const title = typeof document.frontmatter.title === "string" ? document.frontmatter.title : currentSlug;
+  const description = typeof document.frontmatter.description === "string" ? document.frontmatter.description : null;
+  return /* @__PURE__ */ jsxs("div", { className: "rdx-docs-layout", children: [
+    /* @__PURE__ */ jsx("aside", { className: "rdx-sidebar", "aria-label": "Documentation navigation", children: categories.map((category) => /* @__PURE__ */ jsxs("section", { className: "rdx-sidebar-category", children: [
+      /* @__PURE__ */ jsx("h2", { children: category.title }),
+      /* @__PURE__ */ jsx("ul", { children: category.pages.map((page) => {
+        const href = `/docs/${page.slug}`;
+        const isCurrentPage = page.slug === currentSlug;
+        return /* @__PURE__ */ jsx("li", { children: /* @__PURE__ */ jsx(
+          Link,
+          {
+            "aria-current": isCurrentPage ? "page" : void 0,
+            className: isCurrentPage ? "is-active" : void 0,
+            href,
+            children: page.title
+          }
+        ) }, page.slug);
+      }) })
+    ] }, category.id)) }),
+    /* @__PURE__ */ jsxs("main", { className: "rdx-document", children: [
+      /* @__PURE__ */ jsxs("header", { className: "rdx-document-header", children: [
+        /* @__PURE__ */ jsx("p", { className: "rdx-breadcrumb", children: currentSlug }),
+        /* @__PURE__ */ jsx("h1", { children: title }),
+        description && /* @__PURE__ */ jsx("p", { className: "rdx-description", children: description })
+      ] }),
+      /* @__PURE__ */ jsx("article", { className: "rdx-mdx-content", children: content })
+    ] })
+  ] });
+}
+export {
+  DocsPage,
+  RdxLayout
+};

package/package.json

@@ -1,6 +1,65 @@
 {
   "name": "@lexibase/rdx-next",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0-beta.1",
+  "description": "The Next.js runtime for RDX documentation projects.",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "rdx": "./bin/rdx.mjs"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./runtime": {
+      "types": "./dist/runtime/index.d.ts",
+      "import": "./dist/runtime/index.js"
+    }
+  },
+  "files": [
+    "bin",
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "dependencies": {
+    "next-mdx-remote": "^5.0.0",
+    "@lexibase/rdx-types": "1.0.0-beta.0",
+    "@lexibase/rdx-core": "1.0.0-beta.0"
+  },
+  "peerDependencies": {
+    "next": "^15.5.0",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lexibase/rdx.git",
+    "directory": "packages/rdx-next"
+  },
+  "bugs": {
+    "url": "https://github.com/lexibase/rdx/issues"
+  },
+  "homepage": "https://github.com/lexibase/rdx#readme",
+  "devDependencies": {
+    "@types/node": "^22.15.3",
+    "@types/react": "19.1.0",
+    "@types/react-dom": "19.1.1",
+    "eslint": "^9.34.0",
+    "next": "^15.5.0",
+    "react": "19.1.0",
+    "react-dom": "19.1.0",
+    "typescript": "5.9.2",
+    "@rdx/eslint-config": "1.0.0",
+    "@rdx/typescript-config": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/runtime/index.tsx --format esm --dts --clean --external @lexibase/rdx-core --external @lexibase/rdx-types --external next --external react --external react-dom --external next-mdx-remote",
+    "lint": "eslint . --max-warnings 0",
+    "check-types": "tsc --noEmit"
+  }
 }

package/templates/runtime/app/docs/[[...slug]]/page.tsx

@@ -0,0 +1,16 @@
+import { DocsPage } from '@lexibase/rdx-next/runtime'
+import { getDocsPaths } from '@lexibase/rdx-core'
+
+export function generateStaticParams() {
+  return getDocsPaths().map((slug) => ({ slug: slug.split('/') }))
+}
+
+export default async function DocumentationPage({
+  params,
+}: {
+  params: Promise<{ slug?: string[] }>
+}) {
+  const { slug } = await params
+
+  return <DocsPage slug={slug} />
+}

package/templates/runtime/app/globals.css

@@ -0,0 +1,214 @@
+:root {
+  --rdx-background: #ffffff;
+  --rdx-foreground: #171717;
+  --rdx-muted: #666666;
+  --rdx-border: #e7e7e7;
+  --rdx-accent: #f5f5f5;
+  --rdx-link: #0f5ed8;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --rdx-background: #121212;
+    --rdx-foreground: #f4f4f5;
+    --rdx-muted: #a1a1aa;
+    --rdx-border: #303033;
+    --rdx-accent: #202022;
+    --rdx-link: #7bb0ff;
+  }
+}
+
+* {
+  box-sizing: border-box;
+}
+
+html,
+body {
+  margin: 0;
+  min-height: 100%;
+}
+
+body {
+  background: var(--rdx-background);
+  color: var(--rdx-foreground);
+  font-family: Arial, Helvetica, sans-serif;
+}
+
+a {
+  color: inherit;
+}
+
+.rdx-header {
+  align-items: center;
+  border-bottom: 1px solid var(--rdx-border);
+  display: flex;
+  height: 60px;
+  justify-content: space-between;
+  padding: 0 24px;
+}
+
+.rdx-brand {
+  font-size: 1.1rem;
+  font-weight: 700;
+  text-decoration: none;
+}
+
+.rdx-github-link {
+  color: var(--rdx-muted);
+  font-size: 0.9rem;
+  text-decoration: none;
+}
+
+.rdx-docs-layout {
+  display: grid;
+  grid-template-columns: minmax(190px, 250px) minmax(0, 1fr);
+  min-height: calc(100vh - 60px);
+}
+
+.rdx-sidebar {
+  border-right: 1px solid var(--rdx-border);
+  padding: 24px;
+}
+
+.rdx-sidebar-category + .rdx-sidebar-category {
+  border-top: 1px solid var(--rdx-border);
+  margin-top: 20px;
+  padding-top: 20px;
+}
+
+.rdx-sidebar h2 {
+  color: var(--rdx-muted);
+  font-size: 0.72rem;
+  letter-spacing: 0.08em;
+  margin: 0 0 8px;
+  text-transform: uppercase;
+}
+
+.rdx-sidebar ul {
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+
+.rdx-sidebar a {
+  border-radius: 6px;
+  display: block;
+  font-size: 0.92rem;
+  padding: 7px 8px;
+  text-decoration: none;
+}
+
+.rdx-sidebar a:hover,
+.rdx-sidebar a.is-active {
+  background: var(--rdx-accent);
+}
+
+.rdx-sidebar a.is-active {
+  font-weight: 600;
+}
+
+.rdx-document,
+.rdx-empty-state {
+  margin: 0 auto;
+  max-width: 860px;
+  padding: 56px 40px 80px;
+  width: 100%;
+}
+
+.rdx-document-header {
+  border-bottom: 1px solid var(--rdx-border);
+  margin-bottom: 36px;
+  padding-bottom: 28px;
+}
+
+.rdx-document-header h1,
+.rdx-mdx-content h1 {
+  font-size: clamp(2rem, 5vw, 3rem);
+  letter-spacing: -0.04em;
+  line-height: 1.1;
+  margin: 0;
+}
+
+.rdx-breadcrumb {
+  color: var(--rdx-muted);
+  font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
+  font-size: 0.8rem;
+  margin: 0 0 12px;
+}
+
+.rdx-description {
+  color: var(--rdx-muted);
+  font-size: 1.05rem;
+  line-height: 1.6;
+  margin: 14px 0 0;
+}
+
+.rdx-mdx-content {
+  font-size: 1rem;
+  line-height: 1.75;
+}
+
+.rdx-mdx-content h2,
+.rdx-mdx-content h3 {
+  letter-spacing: -0.02em;
+  line-height: 1.25;
+  margin: 2.2em 0 0.7em;
+}
+
+.rdx-mdx-content p,
+.rdx-mdx-content ul,
+.rdx-mdx-content ol {
+  margin: 1em 0;
+}
+
+.rdx-mdx-content li + li {
+  margin-top: 0.4em;
+}
+
+.rdx-mdx-content a {
+  color: var(--rdx-link);
+}
+
+.rdx-mdx-content blockquote {
+  border-left: 3px solid var(--rdx-border);
+  color: var(--rdx-muted);
+  margin: 1.5em 0;
+  padding-left: 16px;
+}
+
+.rdx-mdx-content code {
+  background: var(--rdx-accent);
+  border-radius: 4px;
+  font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
+  font-size: 0.9em;
+  padding: 0.16em 0.35em;
+}
+
+.rdx-mdx-content pre {
+  background: var(--rdx-accent);
+  border: 1px solid var(--rdx-border);
+  border-radius: 8px;
+  overflow-x: auto;
+  padding: 16px;
+}
+
+.rdx-mdx-content pre code {
+  background: transparent;
+  padding: 0;
+}
+
+@media (max-width: 720px) {
+  .rdx-docs-layout {
+    display: block;
+  }
+
+  .rdx-sidebar {
+    border-bottom: 1px solid var(--rdx-border);
+    border-right: 0;
+  }
+
+  .rdx-document,
+  .rdx-empty-state {
+    padding: 36px 24px 60px;
+  }
+}

package/templates/runtime/app/layout.tsx

@@ -0,0 +1,21 @@
+import type { Metadata } from 'next'
+
+import { RdxLayout } from '@lexibase/rdx-next/runtime'
+
+import config from '../../rdx.config'
+
+import './globals.css'
+
+export const metadata: Metadata = {
+  title: {
+    default: config.title,
+    template: `%s | ${config.title}`,
+  },
+  description: config.description,
+}
+
+export default function RootLayout({
+  children,
+}: Readonly<{ children: React.ReactNode }>) {
+  return <RdxLayout config={config}>{children}</RdxLayout>
+}

package/templates/runtime/app/page.tsx

@@ -0,0 +1,5 @@
+import { redirect } from 'next/navigation'
+
+export default function Home() {
+  redirect('/docs')
+}

package/templates/runtime/next.config.mjs

@@ -0,0 +1,9 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    externalDir: true,
+  },
+  transpilePackages: ['@lexibase/rdx-core', '@lexibase/rdx-next'],
+}
+
+export default nextConfig

package/templates/runtime/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "esModuleInterop": true,
+    "jsx": "preserve",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "noEmit": true,
+    "plugins": [{ "name": "next" }],
+    "resolveJsonModule": true,
+    "strict": true,
+    "target": "esnext"
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}