Skip to content
Getting Started

Installation

Create a documentation project and preview your first page.

Requirements

Use Node.js 22.18+ (22.x) or 24.11+ (24.x), with the latest patch of either line. Choose pnpm, npm, or Yarn and use the same package manager throughout your project.

The creator sets up Next.js for you. If you manage Next.js yourself, use 16.4.6 or a later 16.x version.

Create a project

Run the creator and follow the prompt:

pnpm create @lexibase/rdx@latest

The Yarn creator examples use yarn dlx (Yarn 2+).

The prompt asks What is your project named? Enter a name such as my-docs. RDX creates that directory and installs its dependencies.

The terminal reports three stages: creating project files, installing dependencies, and preparing the runtime. Each completed stage shows its elapsed time. With pnpm, an activity indicator stays moving while a progress bar tracks package linking. The terminal shows cache and download counts; the bar starts filling once pnpm reports the package total. Warnings and errors remain visible. Non-interactive logs use periodic status lines, and npm/Yarn retain their package-manager output. The first installation may need to download dependencies; subsequent installations can reuse the package manager's cache.

In a monorepo, the package manager can also process workspace dependencies during installation. The printed stage timings help distinguish that work from RDX's runtime preparation.

Run locally

pnpm dev

Open http://localhost:3000/docs, edit docs/01-getting-started/intro.mdx and save. Keep the development server running to preview content changes. Restart it after editing framework configuration.

Check your documentation

New projects include a check script that reports broken links, missing local assets, and invalid Markdown or MDX without building the site.

pnpm check

See Checking documentation for examples of the report and options for CI.

Optional CLI arguments

Provide the directory name directly to skip the name prompt:

pnpm create @lexibase/rdx@latest my-docs

Inspect the creator without generating a project:

pnpm dlx @lexibase/create-rdx@latest --help

pnpm dlx @lexibase/create-rdx@latest --version

Use --skip-install to generate files without installing dependencies, then install them yourself inside the new directory. An existing directory is not overwritten.

pnpm workspaces

Create the project inside a directory included by your workspace's packages patterns, such as apps/docs. Turborepo is optional. The generated application uses the workspace dependency installation and shared lockfile.

The creator consolidates existing exact-version RDX approvals in minimumReleaseAgeExclude before installation and runtime preparation, preserving the workspace's release-age threshold and strict mode.

To allow new Lexibase releases immediately, add this pattern to minimumReleaseAgeExclude in the workspace-root pnpm-workspace.yaml:

yaml
minimumReleaseAgeExclude:
  - '@lexibase/*'

The * matches every package in the @lexibase scope, across all versions, including RDX's internal dependencies and creator. This lets subsequent RDX updates install without adding an exception for each new version. Other packages keep the workspace's configured release-age policy, such as the default 24-hour delay in pnpm 11.

Use this pattern when you trust releases from the Lexibase organization. Keep unrelated exclusions already in the list; existing exact-version Lexibase entries can be replaced by this pattern. Wildcard exclusions require pnpm 10.17 or later.

If installation fails, keep the generated project and follow the reported error; you do not need to recreate your documents. The generator version can be checked with pnpm create @lexibase/rdx@latest --version. To refresh a cached creator:

pnpm --config.dlxCacheMaxAge=0 create @lexibase/rdx@latest my-docs

Cache refresh and release approval are separate settings. pnpm's release-age policy can select an older creator for @latest or block newly published dependencies. See Release-age policies to check the selected version and configure exclusions when needed.

Next steps

Explore the project structure, write your first page, and set your application name and metadata.