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. Search, TOC, and built-in MDX components do not need plugins.

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.

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

The public plugin contract has apiVersion: 1. Plugins may contribute named content sources and commands. This is an advanced API, not a requirement for authoring docs. Consult the configuration and plugin contract before implementing one; setup can run more than once and must not write content during runtime reads.