web-infra-dev/rspress v2.0.0-alpha.0

on GitHub

What's Changed

Breaking Changes 🚨

• Use named export instead of default export in customizing theme (#1873)

  If you want to customize theme, please use named export as below:

  before

  Layout HomeLayout setup DocLayout use default export,

  other components use named export

   import Theme from 'rspress/theme';
   
   const Layout = () => <Theme.Layout beforeNavTitle={<div>some content</div>} />;
   
   export default {
     ...Theme,
     Layout,
   };
   
   export * from 'rspress/theme';

  after

  all the components use named export

   import { Layout as BasicLayout } from 'rspress/theme';
   
   const Layout = () => <BasicLayout beforeNavTitle={<div>some content</div>} />;
   
   // use named export, no need to `export default`
   export { Layout };
   
   export * from 'rspress/theme';

New Features 🎉

• feat(nav): improve dropdown menu interaction by @chenjiahan in #1910
• feat(theme)!: use named export instead of default export, for circular imports by @SoonIter in #1873

Performance 🚀

• perf(search): add index async to avoid blocking the main thread by @chenjiahan in #1892
• perf(search): remove group calculation by @chenjiahan in #1893
• perf: use matchPath rather than matchRoutes, remove unused group.title by @SoonIter in #1895
• perf(search): improve initialization and prefetching logic by @chenjiahan in #1899

Bug Fixes 🐞

• fix(plugin-api-docgen): add Russian support by @liamli-0822 in #1890
• fix(search): should use index.searchAsync by @chenjiahan in #1898
• fix: display outline correctly on >=960px <=1280px screen width by @JounQin in #1914

Document 📖

• docs: improve Rsbuild plugin guides by @chenjiahan in #1900
• docs: enhance runtime API with types and dark mode usages by @chenjiahan in #1906
• docs: replace generic framework references with Rspress by @chenjiahan in #1907

Other Changes

• chore(deps): update dependency rimraf to v6 by @renovate in #1804
• chore(deps): update all patch dependencies by @renovate in #1902
• chore(deps): update dependency @changesets/cli to ^2.28.1 by @renovate in #1903
• chore(deps): update dependency @microsoft/api-extractor to ^7.51.1 by @renovate in #1904
• chore(deps): update all patch dependencies by @renovate in #1908
• Release v2.0.0-alpha.0 by @SoonIter in #1917

New Contributors

• @liamli-0822 made their first contribution in #1890

Full Changelog: v1.43.0...v2.0.0-alpha.0