rspress

What's Changed

Performance Improvements ⚡

• perf: remove the built-in @rsbuild/plugin-svgr, which significantly reduces the number of dependencies. This may break some custom React components, see https://github.com/web-infra-dev/rspress/pull/716 for more details.

New Features 🎉

• feat: support Badge component
• feat: add support for custom iframe buildConfig
• feat(deps): bump Rsbuild v0.4.11
• feat: support custom pageMeta in js mdx loader
• feat: support section header
• feat: support inline markdown in sidebar

Bug Fixes 🐞

• fix: useFullTextSearch hook not work
• fix: adjust rspress doc max width
• fix: remove virtual module plugin and use pageMeta in mdx loader
• fix: modernjs plugin alias problem in iframe
• fix: doc fragment hmr invalid
• fix: add theme to preview plugin dep and import theme css
• fix: keep code element src prop if it is not a relative path
• fix: implement svg icon wrapper
• fix: frontmatter.title priority is higher than h1 title

Other Changes

• chore: remove useless overflow-hidden style
• chore: optimize dark mode style
• correct style issue with lark svg icon

What's Changed

Bug Fixes 🐞

• fix(theme-default): make outline have a well width again
• fix(core): replace all import info in mdx

What's Changed

Performance Improvements ⚡

• perf: pre build svg in theme package

New Features 🎉

• feat: extract all CSS into a single file

Bug Fixes 🐞

• fix(style): overview links margin not work
• fix: add semicon judgement in flattenMdxContent
• fix(theme-default): adjust sidebar menu z-index
• fix(theme-default): doc container with full width.

Other Changes

• chore: replace omitted svg import statement

What's Changed

New Features 🎉

• feat(internal-components): New Steps Component!
• feat: add support for custom theme assets

Bug Fixes 🐞

• fix: support external link in nav
• fix(core): remove global to avoid ambiguity in non-greedy match in flat mdx
• fix: memoize the callback in useI18n hook
• fix: respect search flag on mobile devices
• fix: nested mdx imports build failed
• fix(core): use alias to support custom theme, instead of detect
• fix: avoid error in auto nav sidebar plugin
• fix: location is not defined in ssg
• fix: update theme when change storage
• fix: add explicit height to social link icons, which is needed on Safari

更新内容

新特性 🎉

• patch(docs): Add documentation for Steps Component!

What's Changed

Bug Fixes 🐞

• fix(theme-default): Fix collapsed space between last updated text and time

What's Changed

New Features 🎉

• feat(theme): add afterDocFooter slot for custom theme #646
• feat(theme): add scroll to top button through enableScrollToTop config #622
• feat(theme): pass through HTMLAnchorElement props to Link component. #641
• feat(theme): add DocLayout export #635
• feat(theme): set min time of initing search index as 1s #647
• feat(theme): new social platform for social links——X #618
• feat(core): trigger auto page reload after page meta changed #640

Bug Fixes 🐞

• fix(doc-components): change code children to string #642
• fix(theme-default): fix incorrect css variable name #606
• fix(plugin-preview): support rspress restart #615
• fix(theme-default): private import not work in production #637
• fix: use logical OR instead of nullish coalescing when label is empty #605
• fix: update sidebar after h1 change #640
• fix: doc fragments' headers disappeared in development #640
• fix(tab-list):overflown tabs not showing on mobile fixed #616

Other Changes

• chore(theme-default): adjust copyCodeBtn icon size & updated wordWrapBtn animations for equality between both buttons #613
• refactor(theme-default): ui switch query #634

What's Changed

Performance Improvements ⚡

• perf: use stream to serve search index file.

New Features 🎉

• feat: support defaultRenderMode to keep same as preview
• feat: expose radius css variable
• feat: support custom search placeholder text

Bug Fixes 🐞

• fix pure meta in code block which not effective
• fix: playground cannot work with name import alias
• fix: fix demo id and avoid 404 in production
• fix: global theme vars not work

Other Changes

• chore(deps): bump rsbuild 0.4.0
• Support external demo to specific isMobile prop

What's Changed

Bug Fixes 🐞

• fix: sidebar walk excludes node_modules

What's Changed

Performance Improvements ⚡

• perf(cli): config.root conditional judgment

New Features 🎉

• feat: allow table scrolling to avoid breaking work
• feat: support toc component in mobile device

Bug Fixes 🐞

• fix: ensure afterBuild executed after dev compile done

Other Changes

• style: optimize code copy animation

What's Changed

Bug Fixes 🐞

• fix: publicDir repeat mkdir conflict

What's Changed

New Features 🎉

• feat(cli): add update command
• feat: reuse logger from Rsbuild
• feat html head meta generator
• feat: serve publicDir via Rsbuild

Bug Fixes 🐞

• fix: custom tsx file error
• fix: table word break style
• fix: -c unknown option in rspress cli
• fix avoid pushing to history when clicking on the current link
• fix(modern-plugin): support custom root
• fix clear query text when search box opens again

Other Changes

• refactor: use rsbuild.preview for preview
• chore(deps): bump rsbuild to 0.3.1
• types: export PluginShikiOptions type

What's Changed

New Features 🎉

• feat: add class name for nav menu item and search button

Bug Fixes 🐞

• fix(api-docgen): add opitional chaining operator when read apiDocMap
• fix(runtime): ignore case in isEqualPath
• fix(plugin-preview): remove virtual demo and get it from pageData in Device

What's Changed

New Features 🎉

• feat: support custom render type in onSearch hook

Bug Fixes 🐞

• fix: sidebar disappeared in cleanUrl mode
• fix: normalize text case for number

What's Changed

New Features 🎉

• feat: add after nav menu slot

Bug Fixes 🐞

• fix: search index file not found when i18n is not set
• fix: failed to submit search when rendering with react@16

What's Changed

Performance Improvements ⚡

• perf(deps): remove unused ora and autoprefixer

New Features 🎉

• feat: support custom search source
• feat: optimize default sidebar title strategy
• feat: add translate-plugins

Bug Fixes 🐞

• fix(modern-plugin): deprecate some config and optimize sidebar and locale
• fix: class selector in code block

What's Changed

New Features 🎉

• feat: close nav screen when route changed
• feat: add useSearchParams hook in rspress/runtime

Bug Fixes 🐞

• fix(core): parseToc support strong text
• fix(modern-plugin): add useModuleSidebar to plugin option
• fix(plugin-playground): add defaultRenderMode to remark plugin
• fix(plugin-playground): remove preview plugin when use playground

Other Changes

• chore(@rspress/shared): remove globby
• chore(core): move tailwindcss from dependencies to devDependencies
• chore(plugin-api-docgen): disable mdxRs by default

What's Changed

Performance Improvements ⚡

• perf: optimize dependencies size

New Features 🎉

• feat: support SourceCode component
• feat(deps): bump Rsbuild from v0.1.9 to v0.2.0
• feat(create_rspress): support cancel operation
• feat(core): support custom meta in tsx file
• feat: improve error logs if missing locales config
• feat(theme-default): should open new tab/window on clicking with modifier keys

Docs update 📄

• docs: update the documention of SourceCode component.
• docs: update the document for LastUpdated and PrevNextPage component

Other Changes

• style(Nav): fix styling issues for specific sizes

What's Changed

Bug Fixes 🐞

• fix(plugin-preview): add defaultRenderMode to remark plugin

What's Changed

Performance Improvements ⚡

• perf(deps): remove unused jsdom dependency

New Features 🎉

• feat: use config.title as html title.
• feat: support LastUpdated and PrevNextPage
• feat: support url query to disable global ui components

Bug Fixes 🐞

• fix: inline image data url start with slash prefix.
• fix: remove unuse css that is not recognized by browsers.
• fix(modern-plugin): support auto sidebar when is bilingual
• fix: disable minify in ssr build
• fix(modern-plugin): remove the limit to enable darkmode
• fix(plugin-preview): remove codesandbox because codesandbox-import-utils license is GPL
• fix(core): stringify global compoennts path

Other Changes

• chore(deps): bump Rsbuild from v0.1.0 to v0.1.9

What's Changed

New Features 🎉

• feat: add sidebar slots

Bug Fixes 🐞

• fix: license for share package
• fix(core): support custom id when disable mdxRs and escape heading id in processor
• fix: devServer use searchIndexMiddleware first.
• fix: disable dark mode script when darkMode is false in config

Other Changes

• chore: optimize sidebar group title color