Skip to content

Changelog

v6.6.6

Small fixes that add up

This release brings together the fixes shipped since 6.6.0: fewer false alarms from the checker, more reliable section links, and small improvements to installation, translations, tabs, and release notes.

Trust the check before you deploy

rdx check now recognizes links to translated homepages, localized search indexes, llms.txt, and the Markdown exports generated for existing pages and release notes. Valid links to these endpoints no longer stop your build. Unknown languages and missing exports are still reported.

The checker also catches problems that can be easy to miss locally:

  • Public asset paths must match the capitalization on disk, including every folder and the navbar logo. A path that happens to work on Windows should not break when you deploy on Linux. When there is one clear match, the check suggests the correct URL.
  • Duplicate section IDs are reported at the later occurrence, including a manual ID that collides with a generated heading ID. Repeated Markdown headings remain valid: RDX gives them distinct IDs such as setup and setup-1.
  • Titles containing footnote references now use the same section IDs in the checker and the rendered page.

See Checking documentation for the validation rules.

Search results should take you to the right section

A footnote reference in a heading adds its displayed number to that heading's ID. Search now accounts for that number, repeated references, and duplicate headings. Clicking the result takes you to the section that actually exists, in both Markdown and MDX pages.

Keep tab behavior when you copy a page

The {disabled} tab marker now works in .md files as it already did in .mdx. The tab stays visible but cannot be selected, and the first enabled tab opens automatically. Content from disabled tabs stays out of the search index.

Copy this page and View Markdown also preserve the marker, so copying an example does not silently enable a disabled tab. Escaped markers and inline code remain literal text.

See Tabs for the syntax.

Keep translated homepages working across editors

Homepage catalogs saved as UTF-8 with BOM are now accepted. Previously, that encoding marker could make RDX ignore the translations and prevent rdx i18n sync from updating the catalog. Existing translations and metadata are preserved when missing phrases are added.

See Languages for the translation workflow.

Put stable releases ahead of their betas

The changelog still lists notes by date, newest first. When dates match, it now uses semantic version precedence: 1.2.0 comes before 1.2.0-rc.1, which comes before 1.2.0-beta.2. A +build suffix does not change that order. Malformed versions are rejected both by the changelog command and when reading handwritten notes.

The feed button also copies the RSS URL and confirms the copy, ready to paste into your feed reader.

A smoother first installation

The creator reads pnpm 12 progress from both output streams, keeping the installation display up to date. Starter documentation includes the links needed to pass rdx check without warnings, and its Next.js minimum matches the runtime's requirement of 16.4.6.

See Updating RDX for the update commands.

v6.6.0

Catch documentation problems before you build

You can now do more with rdx check while you write. It can suggest a fix for a broken link, point out pages that other documents never link to, and tell your CI when a pull request introduces a new warning.

Run the check as soon as you create a project

New projects include a check script. Run pnpm check after editing a page to find broken links, missing images or downloads, and invalid Markdown or MDX without building the site. In an existing project, run pnpm exec rdx check.

Say you moved installation.mdx into getting-started/ and a guide still points to its old file location. When RDX finds one close match, it suggests the new path right below the error.

text
docs/guides/setup.mdx:12:1 [page] "./installation.mdx": "guides/installation.mdx" does not exist in this documentation source.
  Did you mean "../getting-started/installation.mdx"?

RDX can also suggest a nearby heading ID for a broken section link. If an old URL still works through redirectFrom, the check reports it as a warning and suggests the current URL, preserving the query and section fragment.

Keep new warnings out of your pull requests

The check warns about pages with no incoming links from other documents or release notes. Suppose your site already has 14 warnings. A pull request fixes one unlinked page and introduces another. The total stays at 14, so a warning limit of 14 passes. A baseline catches the new unlinked page.

Save the current warnings and commit the file with your project:

sh
pnpm exec rdx check --write-baseline rdx-check-baseline.json

Then check against that file in CI:

sh
pnpm exec rdx check --baseline rdx-check-baseline.json

An existing warning still matches if its line number changes. New warnings and errors fail the check. Use --max-warnings N to also cap the total, or add --json to send the report to a script that adds annotations to your pull request.

See Checking documentation for the options and a GitHub Actions example.

v6.5.1
Security

Block executable frontmatter in documentation

RDX now accepts only YAML or JSON frontmatter when indexing or loading Markdown and MDX pages. Previously, a document with JavaScript frontmatter could execute code in the Node.js process during those operations.

Update to RDX 6.5.1 and rebuild your documentation to apply the fix. Existing YAML and JSON frontmatter works as before.

v6.5.0

Help readers find their next step

When someone lands on a guide, they can see what to read first, where to go next, and when the page last changed. When you move a guide, you can keep its old URL working for people who bookmarked or shared it.

Give readers a starting point and a next step

Add prerequisites to show a Before you begin row below the description. The Build and deployment guide uses it to point readers to installation and configuration before the first build command.

Use related to suggest what to read after the guide. See the links at the bottom of Writing pages. Both fields take relative Markdown paths, keep readers in their current edition and language, and are validated by rdx check.

See when a page changed

Last updated appears above the previous and next page buttons when RDX can determine the date from Git. Published editions keep the date recorded when their snapshot was created.

Add redirectFrom to the moved page's frontmatter and list its old /docs/ paths. RDX redirects those paths to the new page in the same edition and language. rdx check reports conflicts before deployment. See Keep links to a moved page working for an example.

v6.4.0

Give your releases a home in your docs

RDX now has an optional changelog plugin. Write one release note per version in Markdown or MDX, and RDX puts them on a Changelog page linked from the navbar. The notes in changelog/ have their own history, so you can publish release notes even when you keep a single edition of your docs.

Publish your first note

Run rdx add changelog to activate the plugin. Then run rdx changelog new 1.2.0 to create changelog/1.2.0.md with the version, date, and a draft title. Write what changed and what readers should do next. RDX orders the notes by date and renders the same Markdown components available in your docs.

Use badge: breaking, deprecated if the release needs both labels. The supported labels are Breaking changes, Security, and Deprecated. Put a migration guide or advisory in the optional links field to surface it below the release title. See Publish release notes for examples of both fields.

Find, share, and follow releases

  • Versions jumps to a release and highlights the note you are reading as you scroll.
  • Filter appears when a note has a badge. Select one or more badges to narrow both the notes and the version list.
  • The link icon beside the date copies a direct link to that release. Copy this page copies just that note's Markdown and frontmatter, and View Markdown opens the export in a new tab.
  • The RSS icon opens /changelog/rss.xml. Add that address to a feed reader to follow new releases.

rdx check and rdx build check links from release notes to documentation pages, headings, and other releases, plus local images and downloads. A broken link in the note body reports its line. A broken frontmatter link identifies the field, such as links[0].href.

Also in 6.4.0

  • The navbar underlines the section you are reading, including versioned and translated documentation.
  • The Configuration reference lists the accepted values and defaults for every rdx.config.ts option and links to detailed guides.
v6.3.1

Search works in the language you’re reading

If you switched your docs to Portuguese or another language and opened search, RDX could load the index but still tell you search was unavailable. Search now shows results from the language you’re reading, so you can find a page and stay in that language when you open it.

This also works when your docs live under a subpath. For example, a result on /my-tool/pt-br/docs opens under /my-tool/pt-br/docs/....

If your site uses the i18n plugin, update to RDX 6.3.1 to get the fix.