@rspress/core

What's Changed

Bug Fixes

• theme: preserve literal content in inline Markdown

• core: accept site data HMR updates

• theme/Search: ignore Enter when the search panel is closed

• core: keep replacement patterns in head config during SSG

• cli: skip Node compile cache in CI

• shared: respect path segment boundary in withBase and removeBase

• theme/SourceCode: exclude source links from outline

Document

• docs: add rspress-plugin-third-parties documentation 📜

Other Changes

• Release v2.0.23

What's Changed

New Features

• theme/Steps: support multiple heading levels

• theme/Search: animate search panel opening

• theme/Llms: Add Head component for metadata links in LlmsHint 🔗

• theme/Nav: support responsive navigation slots and NavList

Bug Fixes

• theme: keep search panel cancel text on one line on mobile

• search: strip directive markers from search index content

• theme: update light-mode Shiki string token color

• plugins: use import.meta.dirname for package paths

• plugin-twoslash: relax typescript peerDependency to ^5.5.0 || ^6.0.0

• core: use native paths for route files

• theme/SwitchAppearance: correct appearance transition animation

• core: track delegated config files and dependencies

• theme: align hook usage with React rules

• theme/Search: await FlexSearch addAsync before init resolves

• theme/Search: use native prefetch link tag for search index

• search: cap token length in the default search index to fix OOM

• theme/Search: show search index loading errors

Other Changes

• Release v2.0.22

What's Changed

Bug Fixes

• theme/Link: stabilize anchor scrolling after navigation

• theme: keep all surfaces in sync when switching appearance

• theme/Nav: fix left-positioned menu alignment and spacing

• theme: replace border-bottom link underlines with text-decoration

• theme/Banner: support SSR and prevent flash before hydration

• theme: limit link hover opacity to callouts

• theme/Nav: expand navbar item click areas

• theme/CodeBlock: preserve background when scrolling horizontally

Other Changes

• Release v2.0.21

Highlights

New Blog: How to build an Agent-friendly website

Can an AI agent find, read, and understand your documentation as easily as a human? This new guide shows how Rspress combines llms.txt, SSG-MD, Accept: text/markdown, and injectLlmsHint to build documentation for both humans and Agents—and how AFDocs makes the result measurable.

Read the blog: How to build an Agent-friendly website

Normalize clean URLs before rendering

Static hosts can serve the same page through URLs such as /guide, /guide.html, /guide/, and /guide/index.html. Rspress can now match the actual route first and normalize the browser address bar to the format selected by route.cleanUrls before the page renders:

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    cleanUrls: true,
    cleanUrlsRedirect: true,
  },
});

With this configuration, /guide.html becomes /guide, while /reference/index.html becomes /reference/. Normalization uses history.replaceState, does not reload the page, and preserves base, query parameters, hashes, and existing history state.

This is a browser-side fallback rather than an HTTP 301/308 redirect. Keep server or CDN redirects for canonical SEO behavior.

Documentation: route.cleanUrlsRedirect

Blog: The trailing slash problem in static sites

Related PR: #3571

What's Changed

New Features

• route: add cleanUrlsRedirect option

• create-rspress: support --no-git

Performance

• runtime: mark sideEffects: false for @rspress/shared

Bug Fixes

• theme/Llms: omit redundant Markdown page hint

• theme: Fixed ToC tooltips that could contain html strings

• configure Rslint type checking for workspace projects

• plugin-twoslash: stop tracking hover popup position outside of visible state

• ssg-md: include siteOrigin in Markdown links

• route/localeRedirect: avoid false redirect-only detection

• core: normalize persistent cache build dependency path

Other Changes

• Release v2.0.20

Highlights

Guide AI agents from generated Markdown

When SSG-MD is enabled, every generated Markdown page now starts with an agent-readable directive pointing to llms.txt, llms-full.txt, and the Markdown version of the current page:

> For AI agents: the complete documentation index is available at https://example.com/llms.txt, the full documentation bundle is available at https://example.com/llms-full.txt, and this page is available as Markdown at https://example.com/guide/index.md.

This extends the existing HTML hint to Markdown output. Its URLs automatically respect siteOrigin, base, locale, and version prefixes, helping agents discover the right machine-readable content from either format.

Documentation: SSG-MD · injectLlmsHint

Related PR: #3544

Add icons to generated sidebars and navigation

Use icon to display an image, inline SVG, emoji, external URL, or data URL before sidebar and navbar labels. Auto-generated sidebars support icons on groups, items, and section headers through _meta.json or page frontmatter, while navigation icons can be configured through _nav.json or themeConfig.nav.

For a local image, place it in public and reference it with an absolute path:

[
  {
    "type": "file",
    "name": "introduction",
    "label": "Introduction",
    "icon": "/icon.png",
    "tag": "new"
  }
]

Icons render before the label, while an existing tag remains on the right.

Documentation: Sidebar icons and tags · nav · sidebar

Related PR: #3554

Speed up lastUpdated on large sites

Rspress now resolves Git history for all documentation pages in one batched pass instead of spawning one git log process per page. Existing lastUpdated configuration remains unchanged:

import { defineConfig } from '@rspress/core';

export default defineConfig({
  themeConfig: {
    lastUpdated: true,
  },
});

In the PR benchmark, Rspress resolved metadata for its 208-page documentation site with two Git processes in about 300 ms. This avoids the process storms that could make large sites spend minutes resolving page metadata.

Documentation: lastUpdated

Related PR: #3545

What's Changed

New Features

• theme/Llms: support llms directive hints in Markdown

• auto-nav-sidebar: support icon field in sidebar and navbar

Performance

• core: resolve lastUpdated with a single git process

Bug Fixes

• plugin-playground: support HMR updates

• route/i18n: redirect locale before hydration and migrate to route.localeRedirect

• core: declare public type dependencies

• core: preserve async config inference

• theme/outline: hide dividers without content

• plugin-playground: scope Monaco preloads to playground pages

• ssg-md: preserve MDX exports

• theme/llmsUI: warn when copying Markdown in dev

Other Changes

• Release v2.0.19