v2.0.0-beta.34

Highlights ✨

💄 Upgrade to docsearch@4 within @rspress/plugin-algolia

related PR: #2620

This will improve Rspress's UI, and you can use new docsearch features such as askAi.

DocSearch v4 provides a significant upgrade over previous versions, offering enhanced accessibility, responsiveness, and an improved search experience for your documentation. Built on Algolia Autocomplete, DocSearch v4 ensures a seamless integration trusted by leading documentation sites worldwide.

ref: https://docsearch.algolia.com/docs/migrating-from-v3

What's Changed

New Features 🎉

• feat!: update @rspress/plugin-algolia to docsearch v4.1.0 by @Copilot in #2620
• feat: support basic usage of remark-lint for link plugin by @JounQin in #2618

Bug Fixes 🐞

• fix(plugin-llms): should be compilatable to user manual nav and sidebar configuration by @SoonIter in #2606
• fix: render HTML entities correctly in dynamic TOC by @JounQin in #2613
• fix(theme): llms component should not be included in rp-doc by @SoonIter in #2614
• fix(auto-nav-sidebar): watch h1 change for sidebar by @SoonIter in #2619

Document 📖

• docs: fix the ui dark mode color by @SoonIter in #2621
• docs: adjust the folder layout by @SoonIter in #2622

Other Changes

• chore(deps): update dependency rsbuild-plugin-virtual-module to v0.4.1 by @renovate[bot] in #2596
• chore(infra): Creation of AGENTS.md for Rspress Project by @SoonIter in #2612
• chore(deps): update all patch dependencies by @renovate[bot] in #2616
• chore(deps): update dependency memfs to ^4.43.0 by @renovate[bot] in #2617
• chore(deps): update dependency create-rstack to v1.6.1 by @renovate[bot] in #2576
• chore(deps): upgrade @rsbuild/[email protected] by @SoonIter in #2624
• refactor: replace enhanced-resolve with rspack resolver by @stormslowly in #2578
• Release v2.0.0-beta.34 by @SoonIter in #2626

New Contributors

• @stormslowly made their first contribution in #2578

Full Changelog: v2.0.0-beta.33...v2.0.0-beta.34

v2.0.0-beta.33

Breaking Changes🚨

Make raw HTML in md styled

related PR: #2600

Rspress is now driven by CSS for style, ref: https://github.com/web-infra-dev/rspress/blob/main/packages/theme-default/src/styles/doc.scss

So you can:

• Use original html tag like <ul><li>this is a line</li></ul>, they will now be styled the same as * this is a line
• do not need to use Rspress's built-in const { h1: H1 } = getCustomMdxComponents() to annotate styles
• For components that do not wish to be polluted by Rspress prose CSS, .rp-not-doc is all you needed

## List

- list item 1   <------ styled
- list item 2

<ul>
  <li>list item 1</li>       <------ styled
  <li>list item 2</li>
</ul>

<div className="rp-not-doc">        <----- not styled
  <ul>
    <li>list item 1</li>
    <li>list item 2</li>
  </ul>
</div>

<ul className="rp-not-doc>   <----- not styled
  <li>list item 1</li>
  <li>list item 2</li>
</ul>

• Even if Rspress supports it, it's still better not to use raw HTML: https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md033.md

What's Changed

New Features 🎉

• feat(theme-default): Make the tab component usable in layouts other than DocLayout by @Karibash in #2589
• feat(theme/style)!: keep the html style be consistent with markdown syntax and .rp-not-doc escape hatch (#2579) by @SoonIter in #2600

Bug Fixes 🐞

• fix(theme/style): some components should not be included in rp-doc by @SoonIter in #2602

Document 📖

• docs(ui): upgrade Rspress UI part by @SoonIter in #2591
• docs(ui): upgrade shiki vars by @SoonIter in #2598

Other Changes

• chore(deps): update all patch dependencies by @renovate[bot] in #2575
• chore(deps): upgrade nx to upgrade axios and form-data by @SoonIter in #2592
• chore(deps): update all patch dependencies by @renovate[bot] in #2593
• chore(deps): update dependency memfs to ^4.39.0 by @renovate[bot] in #2595
• chore(deps): update dependency @rslib/core to v0.13.2 by @renovate[bot] in #2594
• chore(deps): update dependency @mdx-js/react to v3 by @renovate[bot] in #2558
• test(e2e): inline-markdown add "link" example by @SoonIter in #2601
• refactor(theme-default)!: remove unused low-frequency components LinkCard and Card by @SoonIter in #2603
• chore(theme/style): nav group and add word-break: keep-all to navItem (#2568) by @SoonIter in #2604
• Release v2.0.0-beta.33 by @SoonIter in #2605

Full Changelog: v2.0.0-beta.32...v2.0.0-beta.33

1.45.6

What's Changed

Bug Fixes 🐞

• fix(ssg): Prevent the risk of naming conflicts with the user folders by @SoonIter in #2597

Other Changes

• Release v1.45.6 by @SoonIter in #2599

Full Changelog: v1.45.5...1.45.6

v2.0.0-beta.32

Highlights ✨

⚡️ Support _meta.json and _nav.json HMR

related PR: #2549

After a period of refactoring around virtual modules, Rspress now supports HMR for both *meta.json and *nav.json files.

This means you no longer need to restart the dev server when modifying _meta.json files, which will significantly improve your debugging speed for nav and sidebar configurations.

What's Changed

New Features 🎉

• feat(auto-nav-sidebar): support _meta.json and _nav.json hmr by @SoonIter in #2549
• feat(twoslash): improve underline styling and adjust popup docs font-size by @chenjiahan in #2554
• feat: export star from react-router-dom by @zoolsher in #2577
• feat(plugin-twoslash): Make the popup that is always displayed not flip its display position by @Karibash in #2580

Bug Fixes 🐞

• fix(plugin-api-docgen): too much apiDocMap clone in pageData cause performance issue in runtime by @SoonIter in #2524
• fix(plugin-playground): normalizeUrl skip protocol(#2563) (#2565) by @SoonIter in #2584
• fix: suggestions object key with constructor by @zoolsher in #2586

Document 📖

• docs(codeblocks): add diff block by @SoonIter in #2551
• docs: add Zephyr to docs by @Nsttt in #2555
• docs: add zh docs of deploy with Zephyr Cloud by @Timeless0911 in #2572

Other Changes

• chore(deps): update actions/setup-node action to v5 by @renovate[bot] in #2557
• chore(deps): update all patch dependencies by @renovate[bot] in #2556
• chore(deps): update dependency @types/jest to v30 by @renovate[bot] in #2559
• chore(deps): update dependency cspell to v9 by @renovate[bot] in #2561
• chore(deps): remove unused @types/jest by @SoonIter in #2562
• chore(infra): upgrade pnpm configuration to remove hoist by @SoonIter in #2564
• chore(deps): update dependency cross-env to v10 by @renovate[bot] in #2560
• test(e2e): fix ci case sensitivity by @SoonIter in #2566
• chore(persistent-cache): add rspress version to cacheDigest to make it more safe by @SoonIter in #2582
• chore(infra): use strictPeerDependencies: false by @SoonIter in #2587
• Release v2.0.0-beta.32 by @SoonIter in #2588

New Contributors

• @Nsttt made their first contribution in #2555

Full Changelog: v2.0.0-beta.31...v2.0.0-beta.32

v1.45.5

What's Changed

New Features 🎉

• feat(theme/style): keep the html style be consistent with markdown syntax and .rp-not-doc escape hatch by @SoonIter in #2579

  Other Changes

  • Release v1.45.5 by @SoonIter in #2581

  Full Changelog: 1.45.4...v1.45.5

1.45.4

What's Changed

Bug Fixes 🐞

• fix(plugin-playground): normalizeUrl skip protocol(#2563) by @liuwenzhuang in #2565
• fix(modern-plugin-rspress): tinyglob ends with unexpected '/' by @SoonIter in #2573

Other Changes

• chore(theme/style): nav group and add word-break: keep-all to navItem by @SoonIter in #2568
• chore(theme/style): keep the html syntax in markdown original style by @SoonIter in #2569
• chore(theme/style): use :where to ul and li original style by @SoonIter in #2570
• Release v1.45.4 by @SoonIter in #2574

Full Changelog: v1.45.3...1.45.4

v2.0.0-beta.31

What's Changed

New Features 🎉

• feat(plugin-twoslash): Improve error handling with enhanced logging by @Karibash in #2544

Bug Fixes 🐞

• fix(theme-default/style): add color: inherit back by @SoonIter in #2546
• fix: hmr not work by @SoonIter in #2545

Document 📖

• docs: polish twoslash usage doc by @SoonIter in #2542
• docs(plugin-twoslash): fix typo by @SoonIter in #2543

Other Changes

• Release v2.0.0-beta.31 by @SoonIter in #2548

Full Changelog: v2.0.0-beta.30...v2.0.0-beta.31

v2.0.0-beta.30

Highlights ✨

🆕️ @rspress/plugin-twoslash

related PR: #2527

Thanks to Shiki's excellent Twoslash integration, we're excited to introduce @rspress/plugin-twoslash in this milestone 2.0.0-beta.30 release! Now you can easily add rich type annotations to your code blocks using "```ts twoslash"

Special thanks to Rspress contributor @Karibash for making this possible. Check out the @rspress/plugin-twoslash documentation to get started!

ref: https://v2.rspress.rs/plugin/official-plugins/twoslash

⚡️Enable Rspack native watcher by default and bump [email protected]

related PR: #2472

Previously, Rspack relied on the watchpack file system watcher to track file changes. However, we identified performance bottlenecks with watchpack. For example, each file change triggers the creation of a new instance, consuming significant CPU and memory in large projects (see #7490).

Now Rspress has been upgraded to Rspack 1.5.2 and enable native watcher by default, it will have better HMR perf and lazy compilation perf.

ref: https://rspack.rs/blog/announcing-1-5#faster-file-system-watcher

What's Changed

New Features 🎉

• feat: Add a twoslash plugin by @Karibash in #2527
• feat: enable rspack native watcher by default by @GiveMe-A-Name in #2472

Bug Fixes 🐞

• fix(core): allow user can deploy to both http://a.com/base/ and http://a.com/base by @SoonIter in #2536
• fix(native-watcher): Infinite watch removed i18n.json by @SoonIter in #2540
• fix(plugin-twoslash): Prevent the contents of the popup from being copied when copying code by @Karibash in #2538

Other Changes

• chore(deps): update all patch dependencies by @renovate[bot] in #2530
• chore(deps): update rsbuild by @renovate[bot] in #2531
• chore(deps): update actions/checkout action to v5 by @renovate[bot] in #2535
• chore(deps): update shiki monorepo to ^3.12.0 by @renovate[bot] in #2534
• chore(plugin-llms): add animation to LlmsViewOptions by @SoonIter in #2532
• chore(deps): upgrade @rsbuild/core to 1.5.3 by @SoonIter in #2539
• chore(plugin-twoslash): add hover style back by @SoonIter in #2541
• Release v2.0.0-beta.30 by @SoonIter in #2537

New Contributors

• @GiveMe-A-Name made their first contribution in #2472

Full Changelog: v2.0.0-beta.29...v2.0.0-beta.30

v2.0.0-beta.29

What's Changed

New Features 🎉

• feat(link): support asset link by @SoonIter in #2498
• style(theme): update primary text color for better contrast by @chenjiahan in #2499
• feat(create-rspress): update tsconfig.json by @Timeless0911 in #2509
• feat(theme): Make it possible to mark elements to be excluded when copying by @Karibash in #2512
• feat(plugin-llms): support mdFiles.remarkPlugins by @SoonIter in #2516

Bug Fixes 🐞

• fix(virtual-module): should addDependencies in virtual-module for persistent cache by @SoonIter in #2519
• fix: command using object fully customize don't call normalize by @zoolsher in #2528

Document 📖

• docs: add asset links and format with biome by @SoonIter in #2507
• docs: add codeblock by @SoonIter in #2500
• docs(codeblocks): polish some write style by @SoonIter in #2508
• docs: polish codeblocks doc V2 by @SoonIter in #2517

Other Changes

• refactor: add usePage hook by @SoonIter in #2494
• chore(deps): update all patch dependencies by @renovate[bot] in #2501
• chore(deps): update dependency @rstack-dev/doc-ui to ^1.11.0 by @renovate[bot] in #2502
• chore(deps): update dependency memfs to ^4.38.1 by @renovate[bot] in #2503
• chore(deps): update playwright monorepo to v1.55.0 by @renovate[bot] in #2504
• chore(deps): update pnpm to v10.15.0 by @renovate[bot] in #2505
• chore(deps): update shiki monorepo to ^3.11.0 by @renovate[bot] in #2506
• chore(deps): bump Rsbuild 1.5.0 by @Timeless0911 in #2511
• chore(plugin-preview)!: remove @rsbuild/plugin-less and @rsbuild/plugin-sass by @SoonIter in #2513
• chore(deps): revert @rsbuild/[email protected] by @SoonIter in #2515
• Release v2.0.0-beta.29 by @chenjiahan in #2529

New Contributors

• @Karibash made their first contribution in #2512

Full Changelog: v2.0.0-beta.28...v2.0.0-beta.29

v1.45.3

What's Changed

Bug Fixes 🐞

• fix(plugin-api-docgen): too much apiDocMap clone in pageData cause performance issue in runtime by @SoonIter in #2523

Other Changes

• Release v1.45.3 by @SoonIter in #2525

Full Changelog: v1.45.2...v1.45.3