@modern-js/main-doc 2.25.2 → 2.27.0

package/docs/en/guides/topic-detail/generator/plugin/api/onForged.md

@@ -215,7 +215,7 @@ Parameter types:
 updateInfo: Record<string, any>
 ```
 
-- `updateInfo`: Update content information. `updateModernConfig` is a package based on `updateJSONFile`, which will automatically update under the `edenxConfig` field. Only the configuration fields under `modernConfig` need to be filled in `updateInfo`.
+- `updateInfo`: Update content information. `updateModernConfig` is a package based on `updateJSONFile`, which will automatically update under the `modernConfig` field. Only the configuration fields under `modernConfig` need to be filled in `updateInfo`.
 
 For example, enable SSR:
 

package/docs/en/tutorials/first-app/c03-css.mdx

@@ -1,9 +1,10 @@
 ---
 title: Add Style
 ---
+
 # Add Style
 
-import { Tabs, Tab as TabItem } from "@theme";
+import { Tabs, Tab as TabItem } from '@theme';
 
 In the previous chapter, we learned how to use components from the third-party library.
 
@@ -15,7 +16,7 @@ First of all, we want to control the display of contact avatars by ourselves, an
 
 ![design](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c03-css-expect.jpg)
 
-Hypothesis has no ready-made components to implement, so you need to write some CSS yourself. Here we use [styled-components] (https://styled-components.com/) to implement similar requirements. Modern.js out of the box supports styled-components, which requires neither dependency nor configuration.
+Hypothesis has no ready-made components to implement, so you need to write some CSS yourself. Here we use [styled-components](https://styled-components.com/) to implement similar requirements. Modern.js out of the box supports styled-components, which requires neither dependency nor configuration.
 
 Style-components avoids many problems of traditional CSS writing through modularization. For example, writing styles directly on the style attribute of elements, the visual details of UI will also be mixed with the details of UI structure and business logic. Or classname needs to avoid global space renaming, which requires the use of naming conventions.
 

package/docs/zh/components/prerequisites.mdx

@@ -9,7 +9,7 @@ import NodeVersion from '@modern-js/builder-doc/docs/zh/shared/nodeVersion.md';
 推荐使用 [pnpm](https://pnpm.io/installation) 来管理依赖：
 
 ```bash
-npm install -g pnpm@7
+npm install -g pnpm@8
 ```
 
 :::note

package/docs/zh/configure/app/deploy/microFrontend.mdx

@@ -52,4 +52,4 @@ export default defineConfig({
 
 - **默认值：** `false`
 
-是否 `external` 基础库，当设置为 `true` 时，当前子应用将会 `external`：`react`、`react-dom`，`EdenX` 主应用会自动 `setExternal` 这两个基础库，如果其他类型的框架请通过 `Garfish.setExternal` 增加 `react`、`react-dom` 依赖
+是否 `external` 基础库，当设置为 `true` 时，当前子应用将会 `external`：`react`、`react-dom`，`Modern.js` 主应用会自动 `setExternal` 这两个基础库，如果其他类型的框架请通过 `Garfish.setExternal` 增加 `react`、`react-dom` 依赖

package/docs/zh/configure/app/experiments/source-build.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: sourceBuild
+---
+
+# experiments.sourceBuild
+
+:::tip
+该配置由 Modern.js Builder 提供，更多信息可参考 [experiments.sourceBuild](https://modernjs.dev/builder/api/config-experiments.html#experimentssourcebuild)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/zh/config/experiments/sourceBuild.md';
+
+<Main />

package/docs/zh/configure/app/server/ssr.mdx

@@ -29,13 +29,14 @@ export default defineConfig({
 - `forceCSR`：`boolean = false`，默认关闭强制 CSR 渲染。配置为 `true` 后，在页面访问时添加 `?csr=true` 或添加请求头 `x-modern-ssr-fallback` 即可强制 CSR。
 - `inlineScript`：`boolean = true`，默认情况下，SSR 的数据会以内联脚本的方式注入到 HTML 中，并且直接赋值给全局变量。配置为 `false` 后，会下发 JSON，而不是赋值给全局变量。
 
-
 ```ts title="modern.config.ts"
 export default defineConfig({
   server: {
-    forceCSR: true,
-    mode: 'stream',
-    inlineScript: false,
+    ssr: {
+      forceCSR: true,
+      mode: 'stream',
+      inlineScript: false,
+    },
   },
 });
 ```
@@ -50,7 +51,7 @@ export default defineConfig({
 
 3. SSR 服务压力过大，需要部分流量直接降级为 CSR，避免服务宕机。
 
-在项目中配置 `ssr.forCSR` 为 `true` 后，我们可以通过请求的查询字符串，或是请求头来控制这一行为。
+在项目中配置 `server.ssr.forceCSR` 为 `true` 后，我们可以通过请求的查询字符串，或是请求头来控制这一行为。
 
 例如在自定义 Web Server 的中间件中，检测到流量大于某一阈值时，主动降级：
 

package/docs/zh/configure/app/source/alias-strategy.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: aliasStrategy
+---
+
+# source.aliasStrategy
+
+:::tip
+该配置由 Modern.js Builder 提供，更多信息可参考 [source.aliasStrategy](https://modernjs.dev/builder/api/config-source.html#sourcealiasstrategy)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/zh/config/source/aliasStrategy.md';
+
+<Main />

package/docs/zh/configure/app/tools/swc.mdx

@@ -15,11 +15,13 @@ import SWC from '@modern-js/builder-doc/docs/zh/shared/swc.md';
 
 :::tip
 在使用 Rspack 作为打包工具时，默认会使用 SWC 进行转译和压缩，因此你不需要再安装和配置 SWC 插件。
+
+如果你使用 Rspack 时配置了当前的 SWC 插件，它将不会产生任何效果。
 :::
 
 ## 安装
 
-import EnableSWC from '@modern-js/builder-doc/docs/zh/shared/enable-swc.md';
+import EnableSWC from '@modern-js/builder-doc/docs/zh/shared/enableSwc.md';
 
 <EnableSWC />
 

package/docs/zh/guides/advanced-features/rspack-start.mdx

@@ -5,7 +5,7 @@ sidebar_position: 1
 
 # 使用 Rspack
 
-import Rspack from '@modern-js/builder-doc/docs/zh/shared/rspack-tip.mdx';
+import Rspack from '@modern-js/builder-doc/docs/zh/shared/rspackTip.mdx';
 
 <Rspack />
 

package/docs/zh/guides/advanced-features/using-storybook.mdx

@@ -14,7 +14,7 @@ sidebar_position: 20
 
 ## 开启 Storybook 调试
 
-EdenX 默认集成了 Storybook 的调试能力。
+Modern.js 默认集成了 Storybook 的调试能力。
 
 当我们想要对组件进行调试的时候，可以通过 `pnpm run new` 启用 Storybook 调试功能。
 

package/docs/zh/guides/get-started/quick-start.mdx

@@ -2,19 +2,20 @@
 title: 快速上手
 sidebar_position: 2
 ---
+
 # 快速上手
 
 ## 环境准备
 
-import Prerequisites from "@site-docs/components/prerequisites"
+import Prerequisites from '@site-docs/components/prerequisites';
 
 <Prerequisites />
 
 ## 安装
 
-Modern.js 提供了 `@modern-js/create` 工具来创建项目，不要全局安装，使用 `npx` 按需运行。
+Modern.js 提供了 `@modern-js/create` 工具来创建项目，不需要全局安装，直接使用 `npx` 按需运行即可。
 
-可以在已有的空目录来创建项目：
+你可以在已有的空目录来创建项目：
 
 ```bash
 mkdir myapp && cd myapp
@@ -29,13 +30,13 @@ npx @modern-js/create@latest myapp
 
 ## 初始化项目
 
-import InitApp from "@site-docs/components/init-app"
+import InitApp from '@site-docs/components/init-app';
 
 <InitApp />
 
 ## 启动项目
 
-import DebugApp from "@site-docs/components/debug-app"
+import DebugApp from '@site-docs/components/debug-app';
 
 <DebugApp />
 
@@ -43,7 +44,7 @@ import DebugApp from "@site-docs/components/debug-app"
 
 通过 `@modern-js/create` 创建的 Modern.js 项目中，会默认生成 `modern.config.ts` 文件。
 
-可以通过该配置文件修改配置，覆盖 Modern.js 的默认行为。例如添加如下配置，开启 SSR：
+你可以通过该配置文件修改配置，覆盖 Modern.js 的默认行为。例如添加如下配置，开启 SSR：
 
 ```ts title="modern.config.ts"
 import { appTools, defineConfig } from '@modern-js/app-tools';
@@ -61,6 +62,26 @@ export default defineConfig({
 
 重新执行 `pnpm run dev`，在浏览器 Network 菜单中，可以发现项目已经在服务端完成了页面渲染。
 
+## 核心 npm 包
+
+在新创建的工程中，默认会安装 `@modern-js/app-tools` npm 包，它是 Modern.js 框架的核心包，主要提供以下能力：
+
+- 提供 `modern dev`, `modern build` 等常用的 CLI 命令。
+- 集成 Modern.js Core，提供配置解析、插件加载等能力。
+- 集成 Modern.js Builder，提供构建能力。
+- 集成 Modern.js Server，提供开发和生产服务器相关能力。
+- 集成一些最为常用的插件，比如 `plugin-lint`、`plugin-data-loader` 等。
+
+`@modern-js/app-tools` 是基于 Modern.js 的插件体系实现的，本质上是一个插件，因此你需要在配置文件的 `plugins` 字段中注册 `appTools`：
+
+```ts title="modern.config.ts"
+import { appTools, defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  plugins: [appTools()],
+});
+```
+
 ## 构建项目
 
 在项目中执行 `pnpm run build` 即可构建项目生产环境产物：
@@ -125,6 +146,6 @@ info    App running at:
 
 ## 部署
 
-import Deploy from "@site-docs/components/deploy"
+import Deploy from '@site-docs/components/deploy';
 
 <Deploy />