Skip to content
Features

Plugins

Install optional features without making them part of every project.

Explicit activation

RDX only executes plugins listed in rdx.config.ts. Merely installing a package does not turn it on or create version files.

The official plugins include @lexibase/rdx-versioning for snapshots and @lexibase/rdx-i18n for multiple content languages, and @lexibase/rdx-changelog for release notes. Search, TOC, and built-in MDX components are part of RDX itself.

Assisted installation

From your documentation project root:

pnpm rdx add versioning

The command installs the official package, adds the import and plugin entry to your configuration, validates it, and prepares the runtime. An already configured plugin is not added twice, and an installed version is preserved. Restart the development server after activation.

Use rdx add i18n to activate multilingual documentation. It uses the existing lang setting, asks for additional language tags and prepares their translation folders. See Languages for configuration and authoring.

Publish release notes

Install the changelog plugin from your documentation project root.

pnpm rdx add changelog

Create a release note from the project root.

pnpm rdx changelog new 1.2.0

The command creates changelog/1.2.0.md beside docs/ and fills in the version, today's date, and a default title. Edit the title and add your release notes before building the site. If that version already has an entry, edit the existing file. You can also add .md or .mdx entries by hand.

Use a semantic version such as 1.2.0 or 1.2.0-beta.1. Numeric version components and numeric prerelease identifiers cannot have leading zeros. RDX lists release notes by date, newest first. On the same date, higher semantic versions come first: 1.2.0 precedes 1.2.0-rc.1, which precedes 1.2.0-beta.2. Build metadata such as +build.42 does not change this order.

changelog/1.2.0.md
---
version: '1.2.0'
date: '2026-11-12'
title: Search improvements
---

Search now opens results in the selected language.

Add the optional badge field to show one or more labels beside the release date. Separate multiple values with commas, as in badge: breaking, deprecated.

  • breaking marks an incompatible change that may require migration.
  • security marks a security update.
  • deprecated marks a feature that still works and has a recommended replacement.

Add optional links to display actions below the release title. Use a path from the site root or a full HTTP(S) URL. RDX applies your basePath to site paths.

yaml
links:
  - label: Migration guide
    href: /docs/migrating-to-v7
  - label: Release notes on GitHub
    href: https://github.com/example/project/releases/tag/v7.0.0

The Changelog link follows Docs in the navigation. The Versions list highlights the release you are reading. Use the copy icon beside a release date to share a direct link such as /changelog#v1.2.0. Use Copy this page on the right of the release header to copy that note's Markdown and frontmatter. Choose View Markdown to open the same export in a new tab.

Use the RSS button beside Changelog to copy the feed URL. Paste it into your feed reader to follow new release notes. RDX serves the feed at /changelog/rss.xml, with the project's basePath when configured.

When releases have badges, use Filter to show releases that match any of the selected badges. The Versions list follows your selection. Choose Clear filters to show all releases again.

Write the body in Markdown and use the same components as in your docs. For a larger release, group changes under headings such as ## New features and ## Fixes. Use site paths such as /docs/getting-started for docs links. Projects with basePath serve the page under that prefix. Projects with i18n share one changelog written in the primary language.

If you use the versioning plugin, your release script can run rdx version and rdx changelog new with the same version. Run rdx build after the note is ready.

Manual installation

pnpm add @lexibase/rdx-versioning@latest

Use the channel compatible with your runtime. Then configure it explicitly:

ts
import { defineConfig } from '@lexibase/rdx'
import { versioning } from '@lexibase/rdx-versioning'

export default defineConfig({
  metadata: { applicationName: 'My documentation' },
  plugins: [versioning()],
})

Prepare the runtime, then continue with Versioning:

pnpm rdx prepare

Removal and failed installation

To deactivate a plugin, remove its entry and unused import from the configuration. You can then uninstall its package. Existing snapshots and manifests are not deleted automatically.

If dependency installation fails, inspect package and lockfile changes before retrying. For package-manager release-age policies, approve only releases you trust under your project's policy; do not disable supply-chain protections globally. See Troubleshooting.

Custom plugin authors

Plugins are trusted server-side code and run in configuration order. An RdxPlugin declares a unique name, apiVersion: 1, and optional hooks or commands. For example, this plugin publishes a separate documentation tree:

ts
import type { RdxPlugin } from '@lexibase/rdx'

export function labs(): RdxPlugin {
  return {
    name: 'labs',
    apiVersion: 1,
    setup() {
      return {
        sources: [
          {
            id: 'labs',
            label: 'Labs',
            docsDir: 'labs/docs',
            routePrefix: 'labs',
          },
        ],
      }
    },
  }
}

Add the returned plugin to plugins in rdx.config.ts. The source's project-relative docsDir supplies content under /docs/labs. Each source needs a unique ID and a unique, single-segment route prefix.

setup receives the absolute rootDir, resolved config, and current command. It may be async and can run more than once, including on runtime reads. Keep it idempotent and scope writes to explicit preparation or plugin commands. Each entry in commands has a name, description, and run(context), which also receives args: string[]. Command names must be unique and avoid built-in CLI commands.