@modern-js/main-doc 3.9.3 → 3.10.0

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 (197) hide show
  1. package/docs/en/apis/app/hooks/api/lambda.mdx +2 -1
  2. package/docs/en/apis/app/hooks/config/html.mdx +1 -0
  3. package/docs/en/apis/app/hooks/config/mock.mdx +1 -0
  4. package/docs/en/apis/app/hooks/config/public.mdx +1 -0
  5. package/docs/en/apis/app/hooks/config/upload.mdx +2 -3
  6. package/docs/en/apis/app/hooks/modern-config.mdx +1 -0
  7. package/docs/en/apis/app/hooks/shared.mdx +1 -0
  8. package/docs/en/apis/app/hooks/src/modern.runtime.mdx +1 -0
  9. package/docs/en/apis/app/hooks/src/routes.mdx +1 -0
  10. package/docs/en/apis/app/hooks/src/server.mdx +2 -1
  11. package/docs/en/apis/app/runtime/bff/use-hono-context.mdx +1 -0
  12. package/docs/en/apis/app/runtime/core/create-root.mdx +4 -1
  13. package/docs/en/apis/app/runtime/core/render.mdx +6 -2
  14. package/docs/en/apis/app/runtime/core/runtime-context.mdx +17 -17
  15. package/docs/en/apis/app/runtime/router/router.mdx +9 -6
  16. package/docs/en/apis/app/runtime/ssr/no-ssr.mdx +1 -0
  17. package/docs/en/apis/app/runtime/utility/head.mdx +1 -0
  18. package/docs/en/apis/app/runtime/utility/loadable.mdx +1 -0
  19. package/docs/en/community/blog/v3-release-note.mdx +36 -27
  20. package/docs/en/community/contributing-guide.mdx +15 -33
  21. package/docs/en/components/default-browserslist.mdx +0 -1
  22. package/docs/en/components/deploy-command.mdx +1 -1
  23. package/docs/en/components/deploy.mdx +1 -1
  24. package/docs/en/components/entry-scan-logic.mdx +1 -1
  25. package/docs/en/components/init-app.mdx +9 -3
  26. package/docs/en/components/international/custom-instance-code.mdx +0 -1
  27. package/docs/en/components/micro-runtime-config.mdx +12 -9
  28. package/docs/en/components/nodeVersion.mdx +2 -2
  29. package/docs/en/components/rsc-deploy-tip.mdx +0 -1
  30. package/docs/en/components/ssr-monitor.mdx +1 -1
  31. package/docs/en/configure/app/bff/cross-project.mdx +2 -2
  32. package/docs/en/configure/app/bff/prefix.mdx +1 -1
  33. package/docs/en/configure/app/dev/lazy-compilation.mdx +17 -1
  34. package/docs/en/configure/app/dev/start-url.mdx +0 -1
  35. package/docs/en/configure/app/output/css-modules.mdx +1 -5
  36. package/docs/en/configure/app/output/dist-path.mdx +0 -1
  37. package/docs/en/configure/app/output/inline-scripts.mdx +1 -2
  38. package/docs/en/configure/app/output/inline-styles.mdx +1 -2
  39. package/docs/en/configure/app/output/split-route-chunks.mdx +1 -1
  40. package/docs/en/configure/app/output/ssg.mdx +1 -1
  41. package/docs/en/configure/app/output/ssgByEntries.mdx +1 -0
  42. package/docs/en/configure/app/performance/chunk-split.mdx +1 -4
  43. package/docs/en/configure/app/runtime/plugins.mdx +6 -4
  44. package/docs/en/configure/app/server/rsc.mdx +1 -1
  45. package/docs/en/configure/app/server/ssr.mdx +7 -8
  46. package/docs/en/configure/app/server/tsconfig-path.mdx +2 -2
  47. package/docs/en/configure/app/tools/less.mdx +5 -6
  48. package/docs/en/configure/app/tools/sass.mdx +5 -6
  49. package/docs/en/configure/app/tools/svgr.mdx +7 -7
  50. package/docs/en/configure/app/usage.mdx +1 -5
  51. package/docs/en/guides/advanced-features/bff/cross-project.mdx +5 -4
  52. package/docs/en/guides/advanced-features/compatibility.mdx +0 -1
  53. package/docs/en/guides/advanced-features/international/advanced.mdx +1 -1
  54. package/docs/en/guides/advanced-features/international/api.mdx +34 -28
  55. package/docs/en/guides/advanced-features/international/best-practices.mdx +15 -15
  56. package/docs/en/guides/advanced-features/international/configuration.mdx +37 -37
  57. package/docs/en/guides/advanced-features/international/locale-detection.mdx +37 -28
  58. package/docs/en/guides/advanced-features/international/resource-loading.mdx +19 -17
  59. package/docs/en/guides/advanced-features/international/routing.mdx +8 -6
  60. package/docs/en/guides/advanced-features/international.mdx +8 -8
  61. package/docs/en/guides/advanced-features/server-monitor/logger.mdx +5 -5
  62. package/docs/en/guides/advanced-features/server-monitor/metrics.mdx +8 -8
  63. package/docs/en/guides/advanced-features/server-monitor/monitors.mdx +1 -3
  64. package/docs/en/guides/advanced-features/source-build.mdx +1 -1
  65. package/docs/en/guides/advanced-features/web-server.mdx +3 -3
  66. package/docs/en/guides/basic-features/data/data-fetch.mdx +1 -3
  67. package/docs/en/guides/basic-features/data/data-write.mdx +24 -28
  68. package/docs/en/guides/basic-features/debug/mock.mdx +2 -2
  69. package/docs/en/guides/basic-features/debug/using-storybook.mdx +5 -6
  70. package/docs/en/guides/basic-features/html.mdx +2 -3
  71. package/docs/en/guides/basic-features/output-files.mdx +1 -1
  72. package/docs/en/guides/basic-features/render/overview.mdx +12 -12
  73. package/docs/en/guides/basic-features/render/rsc.mdx +16 -9
  74. package/docs/en/guides/basic-features/render/ssr-cache.mdx +5 -5
  75. package/docs/en/guides/basic-features/render/ssr.mdx +8 -12
  76. package/docs/en/guides/basic-features/render/streaming-ssr.mdx +2 -1
  77. package/docs/en/guides/basic-features/routes/config-routes.mdx +60 -59
  78. package/docs/en/guides/basic-features/testing/playwright.mdx +14 -8
  79. package/docs/en/guides/basic-features/testing/rstest.mdx +6 -4
  80. package/docs/en/guides/get-started/ai-coding-agents.mdx +6 -6
  81. package/docs/en/guides/get-started/introduction.mdx +0 -1
  82. package/docs/en/guides/topic-detail/module-federation/deploy.mdx +2 -2
  83. package/docs/en/guides/topic-detail/module-federation/introduce.mdx +0 -1
  84. package/docs/en/guides/upgrade/config.mdx +12 -0
  85. package/docs/en/guides/upgrade/other.mdx +4 -4
  86. package/docs/en/guides/upgrade/tailwindcss.mdx +0 -1
  87. package/docs/en/guides/upgrade/web-server.md +34 -17
  88. package/docs/en/index.md +1 -0
  89. package/docs/en/plugin/cli-plugins/api.mdx +23 -23
  90. package/docs/en/plugin/cli-plugins/life-cycle.mdx +2 -0
  91. package/docs/en/plugin/introduction.mdx +6 -6
  92. package/docs/en/plugin/official/cli-plugins/plugin-bff.mdx +1 -1
  93. package/docs/en/plugin/official/cli-plugins/plugin-ssg.mdx +1 -1
  94. package/docs/en/plugin/plugin-system.mdx +19 -26
  95. package/docs/en/plugin/runtime-plugins/life-cycle.mdx +2 -0
  96. package/docs/en/plugin/server-plugins/api.mdx +11 -14
  97. package/docs/en/plugin/server-plugins/life-cycle.mdx +2 -0
  98. package/docs/zh/apis/app/hooks/api/lambda.mdx +1 -1
  99. package/docs/zh/apis/app/hooks/config/html.mdx +1 -0
  100. package/docs/zh/apis/app/hooks/config/mock.mdx +1 -0
  101. package/docs/zh/apis/app/hooks/config/public.mdx +1 -0
  102. package/docs/zh/apis/app/hooks/config/upload.mdx +2 -3
  103. package/docs/zh/apis/app/hooks/modern-config.mdx +1 -0
  104. package/docs/zh/apis/app/hooks/shared.mdx +1 -0
  105. package/docs/zh/apis/app/hooks/src/modern.runtime.mdx +1 -0
  106. package/docs/zh/apis/app/hooks/src/routes.mdx +1 -0
  107. package/docs/zh/apis/app/hooks/src/server.mdx +2 -1
  108. package/docs/zh/apis/app/runtime/bff/use-hono-context.mdx +1 -1
  109. package/docs/zh/apis/app/runtime/core/create-root.mdx +4 -1
  110. package/docs/zh/apis/app/runtime/core/render.mdx +6 -3
  111. package/docs/zh/apis/app/runtime/core/runtime-context.mdx +17 -17
  112. package/docs/zh/apis/app/runtime/router/router.mdx +10 -6
  113. package/docs/zh/apis/app/runtime/ssr/no-ssr.mdx +1 -0
  114. package/docs/zh/apis/app/runtime/utility/head.mdx +1 -0
  115. package/docs/zh/apis/app/runtime/utility/loadable.mdx +1 -0
  116. package/docs/zh/community/blog/v3-release-note.mdx +38 -29
  117. package/docs/zh/community/contributing-guide.mdx +16 -34
  118. package/docs/zh/components/default-browserslist.mdx +0 -1
  119. package/docs/zh/components/deploy-command.mdx +1 -1
  120. package/docs/zh/components/deploy.mdx +1 -1
  121. package/docs/zh/components/entry-scan-logic.mdx +1 -1
  122. package/docs/zh/components/init-app.mdx +9 -3
  123. package/docs/zh/components/international/custom-instance-code.mdx +0 -1
  124. package/docs/zh/components/international/install-command.mdx +0 -1
  125. package/docs/zh/components/micro-runtime-config.mdx +12 -9
  126. package/docs/zh/components/nodeVersion.mdx +2 -2
  127. package/docs/zh/components/rsc-deploy-tip.mdx +0 -1
  128. package/docs/zh/components/ssr-monitor.mdx +1 -1
  129. package/docs/zh/configure/app/bff/cross-project.mdx +2 -2
  130. package/docs/zh/configure/app/bff/prefix.mdx +1 -1
  131. package/docs/zh/configure/app/dev/lazy-compilation.mdx +17 -1
  132. package/docs/zh/configure/app/html/crossorigin.mdx +0 -1
  133. package/docs/zh/configure/app/html/favicon.mdx +0 -1
  134. package/docs/zh/configure/app/output/convert-to-rem.mdx +0 -1
  135. package/docs/zh/configure/app/output/css-modules.mdx +1 -5
  136. package/docs/zh/configure/app/output/inline-scripts.mdx +1 -2
  137. package/docs/zh/configure/app/output/inline-styles.mdx +1 -2
  138. package/docs/zh/configure/app/output/source-map.mdx +0 -2
  139. package/docs/zh/configure/app/output/split-route-chunks.mdx +1 -1
  140. package/docs/zh/configure/app/output/ssg.mdx +1 -0
  141. package/docs/zh/configure/app/output/ssgByEntries.mdx +1 -1
  142. package/docs/zh/configure/app/performance/chunk-split.mdx +1 -4
  143. package/docs/zh/configure/app/resolve/dedupe.mdx +0 -1
  144. package/docs/zh/configure/app/runtime/plugins.mdx +6 -4
  145. package/docs/zh/configure/app/server/rsc.mdx +1 -1
  146. package/docs/zh/configure/app/server/ssr.mdx +6 -7
  147. package/docs/zh/configure/app/server/tsconfig-path.mdx +2 -2
  148. package/docs/zh/configure/app/tools/less.mdx +6 -7
  149. package/docs/zh/configure/app/tools/sass.mdx +6 -7
  150. package/docs/zh/configure/app/tools/svgr.mdx +11 -11
  151. package/docs/zh/configure/app/usage.mdx +1 -5
  152. package/docs/zh/guides/advanced-features/bff.mdx +1 -0
  153. package/docs/zh/guides/advanced-features/international/advanced.mdx +1 -1
  154. package/docs/zh/guides/advanced-features/international/api.mdx +28 -27
  155. package/docs/zh/guides/advanced-features/international/best-practices.mdx +15 -15
  156. package/docs/zh/guides/advanced-features/international/configuration.mdx +38 -36
  157. package/docs/zh/guides/advanced-features/international/locale-detection.mdx +37 -28
  158. package/docs/zh/guides/advanced-features/international/resource-loading.mdx +20 -16
  159. package/docs/zh/guides/advanced-features/international/routing.mdx +6 -4
  160. package/docs/zh/guides/advanced-features/international.mdx +9 -9
  161. package/docs/zh/guides/advanced-features/server-monitor/logger.mdx +4 -6
  162. package/docs/zh/guides/advanced-features/server-monitor/metrics.mdx +9 -10
  163. package/docs/zh/guides/advanced-features/source-build.mdx +1 -1
  164. package/docs/zh/guides/advanced-features/web-server.mdx +3 -3
  165. package/docs/zh/guides/basic-features/data/data-fetch.mdx +1 -3
  166. package/docs/zh/guides/basic-features/data/data-write.mdx +25 -31
  167. package/docs/zh/guides/basic-features/debug/mock.mdx +2 -2
  168. package/docs/zh/guides/basic-features/debug/using-storybook.mdx +5 -5
  169. package/docs/zh/guides/basic-features/env-vars.mdx +0 -1
  170. package/docs/zh/guides/basic-features/html.mdx +2 -3
  171. package/docs/zh/guides/basic-features/render/overview.mdx +12 -13
  172. package/docs/zh/guides/basic-features/render/rsc.mdx +16 -9
  173. package/docs/zh/guides/basic-features/render/ssr.mdx +8 -17
  174. package/docs/zh/guides/basic-features/routes/config-routes.mdx +61 -59
  175. package/docs/zh/guides/basic-features/testing/playwright.mdx +15 -10
  176. package/docs/zh/guides/basic-features/testing/rstest.mdx +6 -4
  177. package/docs/zh/guides/get-started/ai-coding-agents.mdx +7 -7
  178. package/docs/zh/guides/topic-detail/module-federation/deploy.mdx +2 -2
  179. package/docs/zh/guides/upgrade/config.mdx +12 -0
  180. package/docs/zh/guides/upgrade/other.md +4 -11
  181. package/docs/zh/guides/upgrade/overview.mdx +1 -4
  182. package/docs/zh/guides/upgrade/tailwindcss.mdx +0 -1
  183. package/docs/zh/guides/upgrade/web-server.md +34 -19
  184. package/docs/zh/index.md +1 -0
  185. package/docs/zh/plugin/cli-plugins/api.mdx +24 -24
  186. package/docs/zh/plugin/cli-plugins/life-cycle.mdx +2 -0
  187. package/docs/zh/plugin/introduction.mdx +6 -6
  188. package/docs/zh/plugin/official/cli-plugins/plugin-bff.mdx +1 -1
  189. package/docs/zh/plugin/official/cli-plugins/plugin-ssg.mdx +1 -1
  190. package/docs/zh/plugin/plugin-system.mdx +19 -26
  191. package/docs/zh/plugin/runtime-plugins/life-cycle.mdx +2 -0
  192. package/docs/zh/plugin/server-plugins/api.mdx +11 -14
  193. package/docs/zh/plugin/server-plugins/life-cycle.mdx +2 -0
  194. package/package.json +11 -13
  195. package/{rspress.config.ts → rstack.config.mts} +7 -10
  196. package/src/components/Footer/styles.module.scss +1 -1
  197. package/src/components/SolutionCards/index.module.scss +3 -1
@@ -131,5 +131,7 @@ flowchart TD
131
131
  style spacer7 fill:none,stroke:none,height:0px;
132
132
  style spacer8 fill:none,stroke:none,height:0px;
133
133
  style spacer9 fill:none,stroke:none,height:0px;
134
+
134
135
  `}
136
+
135
137
  </Mermaid>
@@ -126,12 +126,12 @@ Rsbuild 是 Modern.js 底层的构建工具,通过添加 Rsbuild 插件可修
126
126
 
127
127
  以下为已在 Modern.js 中内置的 Rsbuild 官方插件,无需安装,即可启用:
128
128
 
129
- | 插件 | 介绍 | Modern.js 链接 |
130
- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
131
- | [React 插件](https://v2.rsbuild.rs/zh/plugins/list/plugin-react) | 提供对 React 的支持 | - |
132
- | [SVGR 插件](https://v2.rsbuild.rs/zh/plugins/list/plugin-svgr) | 支持将 SVG 图片转换为一个 React 组件 | [tools.svgr](/configure/app/tools/svgr) |
133
- | [Assets Retry 插件](https://github.com/rstackjs/rsbuild-plugin-assets-retry) | 用于在静态资源加载失败时自动发起重试请求 | [output.assetsRetry](/configure/app/output/assets-retry.html) |
134
- | [Type Check 插件](https://github.com/rstackjs/rsbuild-plugin-type-check) | 用于在单独的进程中运行 TypeScript 类型检查 | [output.disableTsChecker](/configure/app/output/disable-ts-checker.html)<br />[tools.tsChecker](/configure/app/tools/ts-checker.html) |
129
+ | 插件 | 介绍 | Modern.js 链接 |
130
+ | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
131
+ | [React 插件](https://v2.rsbuild.rs/zh/plugins/list/plugin-react) | 提供对 React 的支持 | - |
132
+ | [SVGR 插件](https://v2.rsbuild.rs/zh/plugins/list/plugin-svgr) | 支持将 SVG 图片转换为一个 React 组件 | [tools.svgr](/configure/app/tools/svgr) |
133
+ | [Assets Retry 插件](https://github.com/rstackjs/rsbuild-plugin-assets-retry) | 用于在静态资源加载失败时自动发起重试请求 | [output.assetsRetry](/configure/app/output/assets-retry.html) |
134
+ | [Type Check 插件](https://github.com/rstackjs/rsbuild-plugin-type-check) | 用于在单独的进程中运行 TypeScript 类型检查 | [output.disableTsChecker](/configure/app/output/disable-ts-checker.html)<br />[tools.tsChecker](/configure/app/tools/ts-checker.html) |
135
135
  | [Source Build 插件](https://github.com/rstackjs/rsbuild-plugin-source-build) | 用于 monorepo 场景,支持引用其他子目录的源代码,并完成构建和热更新 | [experiments.sourceBuild](/configure/app/experiments/source-build.html) |
136
136
  | [Check Syntax 插件](https://github.com/rstackjs/rsbuild-plugin-check-syntax) | 用于分析产物的语法兼容性,判断是否存在导致兼容性问题的高级语法 | [security.checkSyntax](/configure/app/security/check-syntax.html) |
137
137
  | [CSS Minimizer 插件](https://github.com/rstackjs/rsbuild-plugin-css-minimizer) | 用于自定义 CSS 压缩工具,切换到 [cssnano](https://cssnano.co/) 或其他工具进行 CSS 压缩 | [tools.minifyCss](/configure/app/tools/minify-css.html) |
@@ -2,4 +2,4 @@
2
2
 
3
3
  在 Modern.js 应用中,通过 BFF 插件,开发者可以在 `api/lambda` 目录下定义接口文件,并导出接口函数。在前端代码中,可以用文件引用的方式,直接调用这些接口函数,发起接口请求。
4
4
 
5
- 详细内容可以参考 [BFF - 基础用法](/guides/advanced-features/bff/function)。
5
+ 详细内容可以参考 [BFF - 基础用法](/guides/advanced-features/bff/function)。
@@ -2,4 +2,4 @@
2
2
 
3
3
  SSG(Static Site Generation)是一种基于数据与模板,在构建时渲染完整静态网页的技术解决方案。这意味着在生产环境中,页面默认就是有内容的,并且可以被 CDN 缓存。对于无需数据的页面,SSG 可以提供更好的性能和更高的安全性。
4
4
 
5
- 详细内容可以参考 [静态站点生成(SSG)](/guides/basic-features/render/ssg)。
5
+ 详细内容可以参考 [静态站点生成(SSG)](/guides/basic-features/render/ssg)。
@@ -14,31 +14,26 @@ Modern.js 秉承“一切皆插件”的设计哲学,将框架的各项功能
14
14
  ## 插件类型与适用场景
15
15
 
16
16
  **CLI 插件**:
17
- - **作用阶段**:构建时(执行 `modern` 命令时)。
18
- - **典型场景**:
19
- - 扩展命令行工具。
20
- - 修改构建配置。
21
- - 监听文件变化。
22
- - 控制构建流程。
23
- - **配置方式**:`modern.config.ts` 中的 `plugins` 字段。
17
+
18
+ - **作用阶段**:构建时(执行 `modern` 命令时)。
19
+ - **典型场景**:
20
+ - 扩展命令行工具。
21
+ - 修改构建配置。
22
+ - 监听文件变化。
23
+ - 控制构建流程。
24
+ - **配置方式**:`modern.config.ts` 中的 `plugins` 字段。
24
25
 
25
26
  **Runtime 插件**:
26
- - **作用阶段**:应用运行时(浏览器/Node.js 环境)。
27
- - **典型场景**:
28
- - 初始化全局状态或服务。
29
- - 封装 React 高阶组件(HOC)。
30
- - 拦截或修改路由行为。
31
- - 控制渲染流程。
32
- - **配置方式**:`src/modern.runtime.ts` 中的 `plugins` 字段。
33
-
34
- {/* **Server 插件**:
35
- - **作用阶段**:服务端请求处理阶段。
36
- - **典型场景**:
37
- - 添加自定义中间件。
38
- - 扩展服务端 API。
39
- - 定制化 SSR 逻辑。
40
- - 与后端框架集成。
41
- - **配置方式**:`server/modern.server.ts` 中的 `plugins` 字段。 */}
27
+
28
+ - **作用阶段**:应用运行时(浏览器/Node.js 环境)。
29
+ - **典型场景**:
30
+ - 初始化全局状态或服务。
31
+ - 封装 React 高阶组件(HOC)。
32
+ - 拦截或修改路由行为。
33
+ - 控制渲染流程。
34
+ - **配置方式**:`src/modern.runtime.ts` 中的 `plugins` 字段。
35
+
36
+ {/* **Server 插件**: - **作用阶段**:服务端请求处理阶段。 - **典型场景**: - 添加自定义中间件。 - 扩展服务端 API。 - 定制化 SSR 逻辑。 - 与后端框架集成。 - **配置方式**:`server/modern.server.ts` 中的 `plugins` 字段。 */}
42
37
 
43
38
  ## 插件结构
44
39
 
@@ -194,9 +189,7 @@ const myPlugin2 = () => ({
194
189
  // 定义 Hooks
195
190
  import { createSyncHook } from '@modern-js/plugin';
196
191
 
197
- type RouteObject = {
198
- /** TODO **/
199
- };
192
+ type RouteObject = {/** TODO **/};
200
193
  const modifyRoutes = createSyncHook<(routes: RouteObject[]) => RouteObject[]>();
201
194
 
202
195
  // 插件中注册 Hooks
@@ -25,5 +25,7 @@ flowchart TD
25
25
  style registry_hooks stroke-dasharray:5 5,fill:#9CA3AF,font-size:10px;
26
26
  style wrapRoot font-size:10px;
27
27
  style onBeforeRender font-size:10px;
28
+
28
29
  `}
30
+
29
31
  </Mermaid>
@@ -46,17 +46,17 @@ export default myServerPlugin;
46
46
 
47
47
  - **返回值:** `ServerContext` 对象,包含以下字段:
48
48
 
49
- | 字段名 | 类型 | 描述 |
50
- | ----------------- | ------------------- | ------------------------------ |
51
- | `middlewares` | `MiddlewareObj[]` | 中间件列表 |
52
- | `renderMiddlewares` | `MiddlewareObj[]` | 渲染中间件列表 |
53
- | `routes` | `ServerRoute[]` | 服务器路由信息 |
54
- | `appDirectory` | `string` | 项目根目录的绝对路径 |
55
- | `apiDirectory` | `string` | API 模块目录的绝对路径 |
56
- | `lambdaDirectory` | `string` | Lambda 模块目录的绝对路径 |
57
- | `sharedDirectory` | `string` | 公共模块目录的绝对路径 |
58
- | `distDirectory` | `string` | 项目产物输出目录的绝对路径 |
59
- | `plugins` | `ServerPlugin[]` | 当前已注册的插件列表 |
49
+ | 字段名 | 类型 | 描述 |
50
+ | ------------------- | ----------------- | -------------------------- |
51
+ | `middlewares` | `MiddlewareObj[]` | 中间件列表 |
52
+ | `renderMiddlewares` | `MiddlewareObj[]` | 渲染中间件列表 |
53
+ | `routes` | `ServerRoute[]` | 服务器路由信息 |
54
+ | `appDirectory` | `string` | 项目根目录的绝对路径 |
55
+ | `apiDirectory` | `string` | API 模块目录的绝对路径 |
56
+ | `lambdaDirectory` | `string` | Lambda 模块目录的绝对路径 |
57
+ | `sharedDirectory` | `string` | 公共模块目录的绝对路径 |
58
+ | `distDirectory` | `string` | 项目产物输出目录的绝对路径 |
59
+ | `plugins` | `ServerPlugin[]` | 当前已注册的插件列表 |
60
60
 
61
61
  - **示例:**
62
62
 
@@ -111,7 +111,6 @@ await hooks.onPrepare.call();
111
111
 
112
112
  ---
113
113
 
114
-
115
114
  ## 上下文修改
116
115
 
117
116
  #### `api.updateServerContext`
@@ -143,7 +142,6 @@ api.onPrepare(() => {
143
142
 
144
143
  ---
145
144
 
146
-
147
145
  ## 生命周期钩子
148
146
 
149
147
  #### `api.onPrepare`
@@ -205,7 +203,6 @@ api.onReset(async ({ event }) => {
205
203
 
206
204
  ---
207
205
 
208
-
209
206
  ## 其他说明
210
207
 
211
208
  - 可以参考 [Server 插件生命周期](./life-cycle.mdx) 了解插件钩子的执行顺序。
@@ -28,7 +28,9 @@ flowchart TD
28
28
  style modifyConfig font-size:10px;
29
29
  style onPrepare font-size:10px;
30
30
  style apply_middlewares font-size:10px;
31
+
31
32
  `}
33
+
32
34
  </Mermaid>
33
35
 
34
36
  :::info
package/package.json CHANGED
@@ -16,19 +16,18 @@
16
16
  "modern",
17
17
  "modern.js"
18
18
  ],
19
- "version": "3.9.3",
19
+ "version": "3.10.0",
20
20
  "publishConfig": {
21
21
  "registry": "https://registry.npmjs.org/",
22
22
  "access": "public"
23
23
  },
24
24
  "dependencies": {
25
- "mermaid": "^11.15.0",
26
- "@modern-js/sandpack-react": "3.9.3"
25
+ "mermaid": "^11.17.2",
26
+ "@modern-js/sandpack-react": "3.10.0"
27
27
  },
28
28
  "devDependencies": {
29
- "rsbuild-plugin-open-graph": "1.1.3",
30
29
  "@rsbuild/plugin-sass": "2.0.1",
31
- "@rspress/core": "2.0.13",
30
+ "@rspress/core": "2.0.23",
32
31
  "@rspress/plugin-llms": "2.0.2",
33
32
  "@rspress/shared": "2.0.2",
34
33
  "@shikijs/transformers": "^3.23.0",
@@ -37,8 +36,9 @@
37
36
  "classnames": "^2.5.1",
38
37
  "clsx": "^1.2.1",
39
38
  "fs-extra": "^10.1.0",
40
- "react": "^19.2.8",
41
- "react-dom": "^19.2.8",
39
+ "react": "^19.3.0",
40
+ "react-dom": "^19.3.0",
41
+ "rsbuild-plugin-open-graph": "1.1.3",
42
42
  "ts-node": "^10.9.2",
43
43
  "typescript": "^5"
44
44
  },
@@ -48,8 +48,7 @@
48
48
  "inputs": [
49
49
  "build",
50
50
  "^build",
51
- "{projectRoot}/docs/**/*",
52
- "{projectRoot}/rspress.config.ts"
51
+ "{projectRoot}/docs/**/*"
53
52
  ],
54
53
  "outputs": [
55
54
  "{projectRoot}/doc_build"
@@ -58,9 +57,8 @@
58
57
  }
59
58
  },
60
59
  "scripts": {
61
- "dev": "rspress dev",
62
- "dev:no_lazy": "LAZY=false rspress dev",
63
- "build": "rspress build",
64
- "preview": "rspress preview"
60
+ "dev": "rs doc",
61
+ "build": "rs doc build",
62
+ "preview": "rs doc preview"
65
63
  }
66
64
  }
@@ -1,10 +1,10 @@
1
1
  import path from 'path';
2
2
  import { pluginSass } from '@rsbuild/plugin-sass';
3
- import { defineConfig } from '@rspress/core';
4
3
  import { transformerNotationHighlight } from '@shikijs/transformers';
5
4
  import { pluginOpenGraph } from 'rsbuild-plugin-open-graph';
5
+ import { define } from 'rstack';
6
6
 
7
- const docPath = path.join(__dirname, 'docs');
7
+ const docPath = path.join(import.meta.dirname, 'docs');
8
8
  const siteTitle = 'Modern.js';
9
9
  const siteDescription =
10
10
  'The Modern.js framework is a progressive web framework based on React. At ByteDance, we use Modern.js to build upper-level frameworks that have supported the development of thousands of web applications.';
@@ -13,7 +13,7 @@ const socialDescription =
13
13
  const socialImage =
14
14
  'https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/banner.jpeg';
15
15
 
16
- export default defineConfig({
16
+ define.doc({
17
17
  root: docPath,
18
18
  llms: true,
19
19
  title: siteTitle,
@@ -22,7 +22,7 @@ export default defineConfig({
22
22
  logo: 'https://lf-cdn-tos.bytescm.com/obj/static/webinfra/modern-js-website/assets/images/images/modernjs-logo.svg',
23
23
  icon: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/favicon.ico',
24
24
  lang: 'en',
25
- themeDir: path.join(__dirname, 'src'),
25
+ themeDir: path.join(import.meta.dirname, 'src'),
26
26
  markdown: {
27
27
  checkDeadLinks: true,
28
28
  shiki: {
@@ -111,14 +111,11 @@ export default defineConfig({
111
111
  output: {
112
112
  dataUriLimit: 0,
113
113
  },
114
- dev: {
115
- lazyCompilation: process.env.LAZY !== 'false',
116
- },
117
114
  resolve: {
118
115
  alias: {
119
- '@site-docs': path.join(__dirname, './docs/zh'),
120
- '@site-docs-en': path.join(__dirname, './docs/en'),
121
- '@site': require('path').resolve(__dirname),
116
+ '@site-docs': path.join(import.meta.dirname, './docs/zh'),
117
+ '@site-docs-en': path.join(import.meta.dirname, './docs/en'),
118
+ '@site': import.meta.dirname,
122
119
  },
123
120
  },
124
121
  plugins: [
@@ -2,7 +2,7 @@
2
2
  display: flex;
3
3
  justify-content: center;
4
4
  padding: 10vh 0;
5
- border-top: 1px solid rgba(0,0,0,0.1);
5
+ border-top: 1px solid rgba(0, 0, 0, 0.1);
6
6
  }
7
7
 
8
8
  .logo {
@@ -9,7 +9,9 @@
9
9
  cursor: pointer;
10
10
  border: 1px solid var(--rp-c-bg-soft);
11
11
  background-color: var(--rp-c-bg-soft);
12
- transition: color 0.5s, background-color 0.5s;
12
+ transition:
13
+ color 0.5s,
14
+ background-color 0.5s;
13
15
  padding: 22px;
14
16
  border-radius: 16px;
15
17
  flex: 0 1 32%;