@modern-js/main-doc 0.0.0-nightly-20250515160310 → 0.0.0-nightly-20250518160324

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/docs/en/apis/app/hooks/src/routes.mdx +3 -3
  2. package/docs/en/components/rsbuild-config-tooltip.mdx +2 -2
  3. package/docs/en/configure/app/dev/asset-prefix.mdx +2 -3
  4. package/docs/en/configure/app/dev/client.mdx +2 -3
  5. package/docs/en/configure/app/dev/hmr.mdx +2 -3
  6. package/docs/en/configure/app/dev/live-reload.mdx +2 -3
  7. package/docs/en/configure/app/dev/progress-bar.mdx +2 -3
  8. package/docs/en/configure/app/dev/setup-middlewares.mdx +2 -3
  9. package/docs/en/configure/app/dev/watch-files.mdx +2 -3
  10. package/docs/en/configure/app/dev/write-to-disk.mdx +2 -3
  11. package/docs/en/configure/app/html/app-icon.mdx +2 -3
  12. package/docs/en/configure/app/html/crossorigin.mdx +2 -3
  13. package/docs/en/configure/app/html/favicon.mdx +2 -3
  14. package/docs/en/configure/app/html/inject.mdx +2 -3
  15. package/docs/en/configure/app/html/meta.mdx +2 -3
  16. package/docs/en/configure/app/html/mount-id.mdx +2 -3
  17. package/docs/en/configure/app/html/output-structure.mdx +2 -3
  18. package/docs/en/configure/app/html/script-loading.mdx +2 -3
  19. package/docs/en/configure/app/html/tags.mdx +2 -3
  20. package/docs/en/configure/app/html/template-parameters.mdx +2 -3
  21. package/docs/en/configure/app/html/template.mdx +2 -3
  22. package/docs/en/configure/app/html/title.mdx +2 -3
  23. package/docs/en/configure/app/output/asset-prefix.mdx +2 -3
  24. package/docs/en/configure/app/output/charset.mdx +2 -3
  25. package/docs/en/configure/app/output/copy.mdx +2 -3
  26. package/docs/en/configure/app/output/css-modules.mdx +2 -3
  27. package/docs/en/configure/app/output/data-uri-limit.mdx +2 -3
  28. package/docs/en/configure/app/output/dist-path.mdx +2 -3
  29. package/docs/en/configure/app/output/externals.mdx +2 -3
  30. package/docs/en/configure/app/output/filename-hash.mdx +2 -3
  31. package/docs/en/configure/app/output/filename.mdx +2 -3
  32. package/docs/en/configure/app/output/inject-styles.mdx +2 -3
  33. package/docs/en/configure/app/output/inline-scripts.mdx +2 -3
  34. package/docs/en/configure/app/output/inline-styles.mdx +2 -3
  35. package/docs/en/configure/app/output/legal-comments.mdx +2 -3
  36. package/docs/en/configure/app/output/minify.mdx +2 -3
  37. package/docs/en/configure/app/output/override-browserslist.mdx +2 -3
  38. package/docs/en/configure/app/output/polyfill.mdx +2 -3
  39. package/docs/en/configure/app/output/source-map.mdx +2 -3
  40. package/docs/en/configure/app/performance/build-cache.mdx +2 -3
  41. package/docs/en/configure/app/performance/bundle-analyze.mdx +2 -3
  42. package/docs/en/configure/app/performance/chunk-split.mdx +2 -3
  43. package/docs/en/configure/app/performance/dns-prefetch.mdx +2 -3
  44. package/docs/en/configure/app/performance/preconnect.mdx +2 -3
  45. package/docs/en/configure/app/performance/prefetch.mdx +2 -3
  46. package/docs/en/configure/app/performance/preload.mdx +2 -3
  47. package/docs/en/configure/app/performance/print-file-size.mdx +2 -3
  48. package/docs/en/configure/app/performance/profile.mdx +2 -3
  49. package/docs/en/configure/app/performance/remove-console.mdx +2 -3
  50. package/docs/en/configure/app/performance/remove-moment-locale.mdx +2 -3
  51. package/docs/en/configure/app/security/nonce.mdx +2 -3
  52. package/docs/en/configure/app/security/sri.mdx +0 -1
  53. package/docs/en/configure/app/server/port.mdx +2 -3
  54. package/docs/en/configure/app/source/alias-strategy.mdx +2 -3
  55. package/docs/en/configure/app/source/alias.mdx +2 -3
  56. package/docs/en/configure/app/source/decorators.mdx +2 -3
  57. package/docs/en/configure/app/source/define.mdx +2 -3
  58. package/docs/en/configure/app/source/exclude.mdx +2 -3
  59. package/docs/en/configure/app/source/include.mdx +2 -3
  60. package/docs/en/configure/app/source/pre-entry.mdx +2 -3
  61. package/docs/en/configure/app/source/transform-import.mdx +2 -3
  62. package/docs/en/configure/app/tools/css-extract.mdx +2 -3
  63. package/docs/en/configure/app/tools/css-loader.mdx +2 -2
  64. package/docs/en/configure/app/tools/html-plugin.mdx +2 -3
  65. package/docs/en/configure/app/tools/lightningcss-loader.mdx +2 -3
  66. package/docs/en/configure/app/tools/postcss.mdx +2 -3
  67. package/docs/en/configure/app/tools/rspack.mdx +2 -3
  68. package/docs/en/configure/app/tools/style-loader.mdx +2 -3
  69. package/docs/en/tutorials/first-app/c04-routes.mdx +4 -2
  70. package/docs/en/tutorials/first-app/c05-loader.mdx +4 -1
  71. package/docs/zh/apis/app/hooks/src/routes.mdx +3 -3
  72. package/docs/zh/components/rsbuild-config-tooltip.mdx +2 -2
  73. package/docs/zh/configure/app/dev/asset-prefix.mdx +2 -3
  74. package/docs/zh/configure/app/dev/client.mdx +2 -3
  75. package/docs/zh/configure/app/dev/hmr.mdx +2 -3
  76. package/docs/zh/configure/app/dev/live-reload.mdx +2 -3
  77. package/docs/zh/configure/app/dev/progress-bar.mdx +2 -3
  78. package/docs/zh/configure/app/dev/setup-middlewares.mdx +2 -3
  79. package/docs/zh/configure/app/dev/watch-files.mdx +2 -3
  80. package/docs/zh/configure/app/dev/write-to-disk.mdx +2 -3
  81. package/docs/zh/configure/app/html/app-icon.mdx +2 -3
  82. package/docs/zh/configure/app/html/crossorigin.mdx +2 -3
  83. package/docs/zh/configure/app/html/favicon.mdx +2 -3
  84. package/docs/zh/configure/app/html/inject.mdx +2 -3
  85. package/docs/zh/configure/app/html/meta.mdx +2 -3
  86. package/docs/zh/configure/app/html/mount-id.mdx +2 -3
  87. package/docs/zh/configure/app/html/output-structure.mdx +2 -3
  88. package/docs/zh/configure/app/html/script-loading.mdx +2 -3
  89. package/docs/zh/configure/app/html/tags.mdx +2 -3
  90. package/docs/zh/configure/app/html/template-parameters.mdx +2 -3
  91. package/docs/zh/configure/app/html/template.mdx +2 -3
  92. package/docs/zh/configure/app/html/title.mdx +2 -3
  93. package/docs/zh/configure/app/output/asset-prefix.mdx +2 -3
  94. package/docs/zh/configure/app/output/charset.mdx +2 -3
  95. package/docs/zh/configure/app/output/copy.mdx +2 -3
  96. package/docs/zh/configure/app/output/css-modules.mdx +2 -3
  97. package/docs/zh/configure/app/output/data-uri-limit.mdx +2 -3
  98. package/docs/zh/configure/app/output/dist-path.mdx +2 -3
  99. package/docs/zh/configure/app/output/externals.mdx +2 -3
  100. package/docs/zh/configure/app/output/filename-hash.mdx +2 -3
  101. package/docs/zh/configure/app/output/filename.mdx +2 -3
  102. package/docs/zh/configure/app/output/inject-styles.mdx +2 -3
  103. package/docs/zh/configure/app/output/inline-scripts.mdx +2 -3
  104. package/docs/zh/configure/app/output/inline-styles.mdx +2 -3
  105. package/docs/zh/configure/app/output/legal-comments.mdx +2 -3
  106. package/docs/zh/configure/app/output/minify.mdx +2 -3
  107. package/docs/zh/configure/app/output/override-browserslist.mdx +2 -3
  108. package/docs/zh/configure/app/output/polyfill.mdx +2 -3
  109. package/docs/zh/configure/app/output/source-map.mdx +2 -3
  110. package/docs/zh/configure/app/performance/build-cache.mdx +2 -3
  111. package/docs/zh/configure/app/performance/bundle-analyze.mdx +2 -3
  112. package/docs/zh/configure/app/performance/chunk-split.mdx +2 -3
  113. package/docs/zh/configure/app/performance/dns-prefetch.mdx +2 -3
  114. package/docs/zh/configure/app/performance/preconnect.mdx +2 -3
  115. package/docs/zh/configure/app/performance/prefetch.mdx +2 -3
  116. package/docs/zh/configure/app/performance/preload.mdx +2 -3
  117. package/docs/zh/configure/app/performance/print-file-size.mdx +2 -3
  118. package/docs/zh/configure/app/performance/profile.mdx +2 -3
  119. package/docs/zh/configure/app/performance/remove-console.mdx +2 -3
  120. package/docs/zh/configure/app/performance/remove-moment-locale.mdx +2 -3
  121. package/docs/zh/configure/app/security/nonce.mdx +2 -3
  122. package/docs/zh/configure/app/security/sri.mdx +0 -1
  123. package/docs/zh/configure/app/server/port.mdx +2 -3
  124. package/docs/zh/configure/app/source/alias-strategy.mdx +2 -3
  125. package/docs/zh/configure/app/source/alias.mdx +2 -3
  126. package/docs/zh/configure/app/source/decorators.mdx +2 -3
  127. package/docs/zh/configure/app/source/define.mdx +2 -3
  128. package/docs/zh/configure/app/source/exclude.mdx +2 -3
  129. package/docs/zh/configure/app/source/include.mdx +2 -3
  130. package/docs/zh/configure/app/source/pre-entry.mdx +2 -3
  131. package/docs/zh/configure/app/source/transform-import.mdx +2 -3
  132. package/docs/zh/configure/app/tools/css-extract.mdx +2 -3
  133. package/docs/zh/configure/app/tools/css-loader.mdx +2 -3
  134. package/docs/zh/configure/app/tools/html-plugin.mdx +2 -3
  135. package/docs/zh/configure/app/tools/lightningcss-loader.mdx +2 -3
  136. package/docs/zh/configure/app/tools/postcss.mdx +2 -3
  137. package/docs/zh/configure/app/tools/rspack.mdx +2 -3
  138. package/docs/zh/configure/app/tools/style-loader.mdx +2 -3
  139. package/docs/zh/tutorials/first-app/c04-routes.mdx +4 -2
  140. package/docs/zh/tutorials/first-app/c05-loader.mdx +4 -1
  141. package/package.json +6 -4
  142. package/rspress.config.ts +6 -1
  143. package/src/components/RsbuildLink/index.tsx +2 -2
  144. package/src/index.ts +1 -5
  145. package/src/pages/index.tsx +3 -3
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: profile
3
- configName: performance.profile
4
3
  ---
5
4
 
6
5
  # performance.profile
@@ -10,6 +9,6 @@ configName: performance.profile
10
9
 
11
10
  是否捕获每个模块的耗时信息,对应 Rspack 的 [profile](https://webpack.js.org/configuration/other-options/#profile) 配置。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="performance.profile" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: removeConsole
3
- configName: performance.removeConsole
4
3
  ---
5
4
 
6
5
  # performance.removeConsole
@@ -10,6 +9,6 @@ configName: performance.removeConsole
10
9
 
11
10
  在生产环境构建时,是否自动移除代码中的 `console.[methodName]`。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="performance.removeConsole" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: removeMomentLocale
3
- configName: performance.removeMomentLocale
4
3
  ---
5
4
 
6
5
  # performance.removeMomentLocale
@@ -10,6 +9,6 @@ configName: performance.removeMomentLocale
10
9
 
11
10
  是否移除 [moment.js](https://momentjs.com/) 的语言包文件。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="performance.removeMomentLocale" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: nonce
3
- configName: security.nonce
4
3
  ---
5
4
 
6
5
  # security.nonce
@@ -15,6 +14,6 @@ type Nonce = string;
15
14
 
16
15
  为 HTML 所引入的脚本资源添加随机属性值 nonce,使浏览器在解析到带有匹配 nonce 值的内联脚本时,能判断该脚本是否能执行。
17
16
 
18
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
17
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
19
18
 
20
- <RsbuildConig />
19
+ <RsbuildConfig configName="security.nonce" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: sri
3
- configName: security.sri
4
3
  ---
5
4
 
6
5
  # security.sri
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: port
3
- configName: server.port
4
3
  ---
5
4
 
6
5
  # server.port
@@ -38,6 +37,6 @@ export default defineConfig({
38
37
  });
39
38
  ```
40
39
 
41
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
40
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
42
41
 
43
- <RsbuildConig />
42
+ <RsbuildConfig configName="server.port" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: aliasStrategy
3
- configName: source.aliasStrategy
4
3
  ---
5
4
 
6
5
  # source.aliasStrategy
@@ -10,6 +9,6 @@ configName: source.aliasStrategy
10
9
 
11
10
  `source.aliasStrategy` 用于控制 `tsconfig.json` 中的 `paths` 选项与打包工具的 `alias` 选项的优先级。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="source.aliasStrategy" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: alias
3
- configName: source.alias
4
3
  ---
5
4
 
6
5
  # source.alias
@@ -19,6 +18,6 @@ type Alias = Record<string, string | false | (string | false)[]> | Function;
19
18
  对于 TypeScript 项目,你只需要在 `tsconfig.json` 中配置 [compilerOptions.paths](https://www.typescriptlang.org/tsconfig#paths) 即可,Rsbuild 会自动识别它,不需要额外配置 `source.alias` 字段,详见 [「路径别名」](https://modernjs.dev/guides/basic-features/alias.html)。
20
19
  :::
21
20
 
22
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
21
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
23
22
 
24
- <RsbuildConig />
23
+ <RsbuildConfig configName="source.alias" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: decorators
3
- configName: source.decorators
4
3
  ---
5
4
 
6
5
  # source.decorators
@@ -23,6 +22,6 @@ const defaultDecorators = {
23
22
 
24
23
  用于配置装饰器语法。
25
24
 
26
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
25
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
27
26
 
28
- <RsbuildConig />
27
+ <RsbuildConfig configName="source.decorators" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: define
3
- configName: source.define
4
3
  ---
5
4
 
6
5
  # source.define
@@ -16,6 +15,6 @@ const defaultDefine = {
16
15
 
17
16
  构建时将代码中的变量替换成其它值或者表达式,可以用于在代码逻辑中区分开发环境与生产环境等场景。
18
17
 
19
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
18
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
20
19
 
21
- <RsbuildConig />
20
+ <RsbuildConfig configName="source.define" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: exclude
3
- configName: source.exclude
4
3
  ---
5
4
 
6
5
  # source.exclude
@@ -10,6 +9,6 @@ configName: source.exclude
10
9
 
11
10
  指定不需要编译的 JavaScript/TypeScript 文件。用法与 Rspack 中的 [Rule.exclude](https://rspack.dev/zh/config/module#ruleexclude) 一致,支持传入字符串或正则表达式来匹配模块的路径。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="source.exclude" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: include
3
- configName: source.include
4
3
  ---
5
4
 
6
5
  # source.include
@@ -21,6 +20,6 @@ const defaultInclude = [
21
20
 
22
21
  `source.include` 用于指定额外需要编译的 JavaScript 文件。
23
22
 
24
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
23
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
25
24
 
26
- <RsbuildConig />
25
+ <RsbuildConfig configName="source.include" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: preEntry
3
- configName: source.preEntry
4
3
  ---
5
4
 
6
5
  # source.preEntry
@@ -10,6 +9,6 @@ configName: source.preEntry
10
9
 
11
10
  在每个页面的入口文件前添加一段代码,这段代码会早于页面的代码执行,因此可以用于执行一些全局的代码逻辑,比如注入 polyfill、设置全局样式等。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="source.preEntry" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: transformImport
3
- configName: source.transformImport
4
3
  ---
5
4
 
6
5
  # source.transformImport
@@ -59,9 +58,9 @@ const defaultArcoConfig = [
59
58
  当你添加了 `antd` 或 `@arco-design/web-react` 相关的配置时,优先级会高于上述默认配置。
60
59
  :::
61
60
 
62
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
61
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
63
62
 
64
- <RsbuildConig />
63
+ <RsbuildConfig configName="source.transformImport" />
65
64
 
66
65
  ### 禁用默认配置
67
66
 
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: cssExtract
3
- configName: tools.cssExtract
4
3
  ---
5
4
 
6
5
  # tools.cssExtract
@@ -30,6 +29,6 @@ const defaultOptions = {
30
29
 
31
30
  通过 `tools.cssExtract` 可以更改 [CssExtractRspackPlugin](https://www.rspack.dev/zh/plugins/rspack/css-extract-rspack-plugin) 或 [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) 的配置。
32
31
 
33
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
32
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
34
33
 
35
- <RsbuildConig />
34
+ <RsbuildConfig configName="tools.cssExtract" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: cssLoader
3
- configName: tools.cssLoader
4
3
  ---
5
4
 
6
5
  # tools.cssLoader
@@ -17,6 +16,6 @@ const defaultOptions = {
17
16
 
18
17
  修改 [css-loader](https://github.com/webpack-contrib/css-loader) 的配置项。
19
18
 
20
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
19
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
21
20
 
22
- <RsbuildConig />
21
+ <RsbuildConfig configName="tools.cssLoader" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: htmlPlugin
3
- configName: tools.htmlPlugin
4
3
  ---
5
4
 
6
5
  # tools.htmlPlugin
@@ -36,6 +35,6 @@ const defaultOptions = {
36
35
 
37
36
  通过 `tools.htmlPlugin` 可以修改 [html-rspack-plugin](https://github.com/rspack-contrib/html-rspack-plugin) 或 [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin) 的配置项。
38
37
 
39
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
38
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
40
39
 
41
- <RsbuildConig />
40
+ <RsbuildConfig configName="tools.htmlPlugin" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: lightningcssLoader
3
- configName: tools.lightningcssLoader
4
3
  ---
5
4
 
6
5
  # tools.lightningcssLoader
@@ -36,6 +35,6 @@ const defaultOptions = {
36
35
 
37
36
  需要注意的是,开启 `lightningcss-loader` 时,将会默认关闭 `postcss-loader`。
38
37
 
39
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
38
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
40
39
 
41
- <RsbuildConig />
40
+ <RsbuildConfig configName="tools.lightningcssLoader" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: postcss
3
- configName: tools.postcss
4
3
  ---
5
4
 
6
5
  # tools.postcss
@@ -35,6 +34,6 @@ Modern.js 默认集成 PostCSS,你可以通过 `tools.postcss` 对 [postcss-lo
35
34
 
36
35
  需要注意的是,当你开启 `tools.lightningcss` 配置时,PostCSS 将会被默认禁用,包括 `postcss-loader` 及其默认插件。
37
36
 
38
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
37
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
39
38
 
40
- <RsbuildConig />
39
+ <RsbuildConfig configName="tools.postcss" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: rspack
3
- configName: tools.rspack
4
3
  ---
5
4
 
6
5
  # tools.rspack
@@ -10,6 +9,6 @@ configName: tools.rspack
10
9
 
11
10
  `tools.rspack` 选项用于修改 [Rspack](https://rspack.dev/) 的配置项。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="tools.rspack" />
@@ -1,6 +1,5 @@
1
1
  ---
2
2
  title: styleLoader
3
- configName: tools.styleLoader
4
3
  ---
5
4
 
6
5
  # tools.styleLoader
@@ -10,6 +9,6 @@ configName: tools.styleLoader
10
9
 
11
10
  通过 `tools.styleLoader` 可以设置 [style-loader](https://github.com/webpack-contrib/style-loader) 的配置项。
12
11
 
13
- import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
12
+ import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
14
13
 
15
- <RsbuildConig />
14
+ <RsbuildConfig configName="tools.styleLoader" />
@@ -118,8 +118,9 @@ import { Radio } from 'antd';
118
118
 
119
119
  然后将 UI 最顶部进行修改,增加一组单选框
120
120
 
121
- ```tsx {4-9}
121
+ ```tsx
122
122
  export default function Layout() {
123
+ // [!code highlight:8]
123
124
  return (
124
125
  <div>
125
126
  <div className="h-16 p-2 flex items-center justify-center">
@@ -146,8 +147,9 @@ import { Outlet, useLocation, useNavigate } from '@modern-js/runtime/router';
146
147
 
147
148
  最后在 Layout 组件里增加局部状态和相关逻辑:
148
149
 
149
- ```tsx {2-9}
150
+ ```tsx
150
151
  export default function Layout() {
152
+ // [!code highlight:8]
151
153
  const navigate = useNavigate();
152
154
  const location = useLocation();
153
155
  const [currentList, setList] = useState(location.pathname || '/');
@@ -56,11 +56,13 @@ Data Loader 并非只为 SSR 工作。在 CSR 项目中,Data Loader 也可以
56
56
 
57
57
  Modern.js 也提供了一个叫 `useLoaderData` 的 hooks API,我们修改 `src/routes/page.tsx` 导出的组件:
58
58
 
59
- ```tsx {1,2,5,13}
59
+ ```tsx
60
+ // [!code highlight:2]
60
61
  import { useLoaderData } from '@modern-js/runtime/router';
61
62
  import type { LoaderData } from './page.data';
62
63
 
63
64
  function Index() {
65
+ // [!code highlight:1]
64
66
  const { data } = useLoaderData() as LoaderData;
65
67
 
66
68
  return (
@@ -68,6 +70,7 @@ function Index() {
68
70
  <Helmet>
69
71
  <title>All</title>
70
72
  </Helmet>
73
+ // [!code highlight:1]
71
74
  <List
72
75
  dataSource={data}
73
76
  renderItem={info => <Item key={info.name} info={info} />}
package/package.json CHANGED
@@ -15,17 +15,19 @@
15
15
  "modern",
16
16
  "modern.js"
17
17
  ],
18
- "version": "0.0.0-nightly-20250515160310",
18
+ "version": "0.0.0-nightly-20250518160324",
19
19
  "publishConfig": {
20
20
  "registry": "https://registry.npmjs.org/",
21
21
  "access": "public"
22
22
  },
23
23
  "dependencies": {
24
24
  "mermaid": "^11.4.1",
25
- "@modern-js/sandpack-react": "0.0.0-nightly-20250515160310"
25
+ "@modern-js/sandpack-react": "0.0.0-nightly-20250518160324"
26
26
  },
27
27
  "devDependencies": {
28
- "@rspress/shared": "1.43.11",
28
+ "@rsbuild/plugin-sass": "1.3.1",
29
+ "@shikijs/transformers": "^3.4.1",
30
+ "@rspress/shared": "2.0.0-beta.5",
29
31
  "@types/fs-extra": "9.0.13",
30
32
  "@types/node": "^16",
31
33
  "classnames": "^2.5.1",
@@ -33,7 +35,7 @@
33
35
  "fs-extra": "^10",
34
36
  "react": "^18.3.1",
35
37
  "react-dom": "^18.3.1",
36
- "rspress": "1.43.11",
38
+ "rspress": "2.0.0-beta.5",
37
39
  "ts-node": "^10.9.1",
38
40
  "typescript": "^5"
39
41
  },
package/rspress.config.ts CHANGED
@@ -1,4 +1,6 @@
1
1
  import path from 'path';
2
+ import { pluginSass } from '@rsbuild/plugin-sass';
3
+ import { transformerNotationHighlight } from '@shikijs/transformers';
2
4
  import { defineConfig } from 'rspress/config';
3
5
 
4
6
  const docPath = path.join(__dirname, 'docs');
@@ -12,7 +14,9 @@ export default defineConfig({
12
14
  themeDir: path.join(__dirname, 'src'),
13
15
  markdown: {
14
16
  checkDeadLinks: true,
15
- experimentalMdxRs: true,
17
+ shiki: {
18
+ transformers: [transformerNotationHighlight()],
19
+ },
16
20
  },
17
21
  search: {
18
22
  codeBlocks: true,
@@ -91,5 +95,6 @@ export default defineConfig({
91
95
  '@site': require('path').resolve(__dirname),
92
96
  },
93
97
  },
98
+ plugins: [pluginSass()],
94
99
  },
95
100
  });
@@ -1,7 +1,7 @@
1
1
  import React from 'react';
2
2
  import { useLang } from 'rspress/runtime';
3
3
 
4
- const RsbuildLInk = ({ configName }: { configName: string }) => {
4
+ const RsbuildLink = ({ configName }: { configName: string }) => {
5
5
  const lang = useLang();
6
6
  const href = `https://rsbuild.dev/${lang === 'zh' ? 'zh/' : ''}config/${configName
7
7
  .split('.')
@@ -16,4 +16,4 @@ const RsbuildLInk = ({ configName }: { configName: string }) => {
16
16
  );
17
17
  };
18
18
 
19
- export default RsbuildLInk;
19
+ export default RsbuildLink;
package/src/index.ts CHANGED
@@ -1,9 +1,5 @@
1
- import Theme from 'rspress/theme';
2
1
  import HomeLayout from './pages';
3
2
 
4
- export default {
5
- ...Theme,
6
- HomeLayout,
7
- };
3
+ export { HomeLayout };
8
4
 
9
5
  export * from 'rspress/theme';
@@ -1,6 +1,6 @@
1
1
  import clsx from 'clsx';
2
2
  import { useEffect } from 'react';
3
- import { Helmet, useLocation } from 'rspress/runtime';
3
+ import { Head, useLocation } from 'rspress/runtime';
4
4
  import ContentCard from '../components/ContentCard';
5
5
  import { FeatureLayout } from '../components/FeatureLayout';
6
6
  import Footer from '../components/Footer';
@@ -94,7 +94,7 @@ export default function Home() {
94
94
 
95
95
  return (
96
96
  <div>
97
- <Helmet>
97
+ <Head>
98
98
  <html className="dark" />
99
99
  <script>window.MODERN_THEME = 'dark';</script>
100
100
  <style type="text/css">{`
@@ -102,7 +102,7 @@ export default function Home() {
102
102
  display: none!important;
103
103
  }
104
104
  `}</style>
105
- </Helmet>
105
+ </Head>
106
106
  <HomepageHeader />
107
107
  <main className={styles['homepage-main']}>
108
108
  <FeatureLayout>