diff --git a/website/docs/en/guide/advanced/module-federation.mdx b/website/docs/en/guide/advanced/module-federation.mdx index c6b9e6ca3..f32a563bc 100644 --- a/website/docs/en/guide/advanced/module-federation.mdx +++ b/website/docs/en/guide/advanced/module-federation.mdx @@ -28,7 +28,7 @@ import { PackageManagerTabs } from '@theme'; -Then register the plugin to the `rslib.config.ts` file: +Then register the plugin in the `rslib.config.ts` file: ```ts title='rslib.config.ts' {8-43} import { pluginModuleFederation } from '@module-federation/rsbuild-plugin'; @@ -94,7 +94,7 @@ However, if you want this Rslib Module to consume other producers at the same ti Rslib support developing Module Federation Rslib project with a host application. -#### 1. Start MF `dev` of library +#### 1. Start MF `dev` command of library Adding the `dev` command to the `package.json` file: diff --git a/website/docs/en/guide/solution/nodejs.mdx b/website/docs/en/guide/solution/nodejs.mdx index a6a5a0b8d..2c0650bb1 100644 --- a/website/docs/en/guide/solution/nodejs.mdx +++ b/website/docs/en/guide/solution/nodejs.mdx @@ -54,7 +54,7 @@ export default defineConfig({ Rslib set [target](/config/rsbuild/output#outputtarget) to `"node"` by default, which is different from the default target of Rsbuild. -When target is valued as `"node"`, Rslib adjusts many configurations for Node.js. For example, [output.externals](/config/rsbuild/output#outputtarget) will exclude built-in Node.js modules, and [shims](/config/lib/shims) will add a shim for `import.meta.url` in CJS output by default. +When target is set to `"node"`, Rslib adjusts many configurations for Node.js. For example, [output.externals](/config/rsbuild/output#outputtarget) will exclude built-in Node.js modules, and [shims](/config/lib/shims) will add a shim for `import.meta.url` in CJS output by default. ### Externals diff --git a/website/docs/en/guide/solution/react.mdx b/website/docs/en/guide/solution/react.mdx index eace8293b..4c26072f3 100644 --- a/website/docs/en/guide/solution/react.mdx +++ b/website/docs/en/guide/solution/react.mdx @@ -79,7 +79,7 @@ export default defineConfig({ - **Type**: `string` - **Default**: `'react'` -When `runtime` is valued as `'automatic'`, you can specify the import path of the JSX transform through `importSource`. +When `runtime` is set to `'automatic'`, you can specify the import path of the JSX transform through `importSource`. For example, when using [Emotion](https://emotion.sh/), you can set `importSource` to `'@emotion/react'`: diff --git a/website/docs/zh/guide/advanced/dts.mdx b/website/docs/zh/guide/advanced/dts.mdx index ed8810bee..b2cbc43ac 100644 --- a/website/docs/zh/guide/advanced/dts.mdx +++ b/website/docs/zh/guide/advanced/dts.mdx @@ -9,14 +9,14 @@ TypeScript 声明文件 (DTS) 提供 JavaScript 代码的类型信息。 DTS 文 1. **类型检查**: 为 JavaScript 代码提供类型信息，帮助开发人员在编译时捕获潜在的类型错误。 2. **代码补全**: 增强代码编辑器功能，例如自动完成和代码导航。 3. **文档生成**: 生成 JavaScript 代码文档，提供更好的开发体验。 -4. **IDE 支持**: 改善 Visual Studio Code、WebStorm 等 IDE 中的开发人员体验. +4. **IDE 支持**: 改善 Visual Studio Code、WebStorm 等 IDE 中的开发者体验。 5. **库消费**: 让其他使用者更容易使用和理解该库。 ## 什么是 Bundle DTS 和 Bundleless DTS ### Bundle DTS -Bundle DTS 涉及将多个 TypeScript 声明文件 bundle 到一个声明文件中。 +Bundle DTS 将多个 TypeScript 声明文件 bundle 到一个声明文件中。 - **优势:** @@ -24,12 +24,12 @@ Bundle DTS 涉及将多个 TypeScript 声明文件 bundle 到一个声明文件 - **容易分发**: 减少用户使用库时需要处理的文件数量。 - **劣势:** - - **生成复杂**: 在大型项目中，生成和维护单个 bundle 文件可能会变得复杂. + - **生成复杂**: 在大型项目中，生成和维护单个 bundle 文件可能会变得复杂。 - **调试困难**: 调试类型问题可能不像各个文件单独输出那样直观。 ### Bundleless DTS -Bundleless DTS 涉及为库中的每个模块生成单独的声明文件，就像 `tsc` 一样。 +Bundleless DTS 为库中的每个模块生成单独的声明文件，就像 `tsc` 一样。 - **优势:** @@ -40,7 +40,7 @@ Bundleless DTS 涉及为库中的每个模块生成单独的声明文件，就 - **多文件**: 用户在使用该库时可能需要处理多个声明文件。 - **管理复杂**: 可能需要额外的配置才能正确引用所有文件。 -## 怎么在 Rslib 中生成 DTS +## 如何在 Rslib 中生成 DTS Rslib 默认使用 [TypeScript Compiler API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) 生成 Bundleless DTS， [API Extractor](https://api-extractor.com/) @@ -50,13 +50,13 @@ Rslib 默认使用 [TypeScript Compiler API](https://github.com/microsoft/TypeSc 如果你想生成 Bundle DTS，可以： -1. 安装 `@microsoft/api-extractor` 作为 `dev`, 这是用于 bundle DTS 文件的底层工具。 +1. 安装 `@microsoft/api-extractor` 作为 `devDependencies`, 这是用于 bundle DTS 文件的底层工具。 import { PackageManagerTabs } from '@theme'; -2. 设置 `dts: { bundle: true }` 在 Rslib 配置文件中。 +2. 在 Rslib 配置文件中设置 `dts: { bundle: true }`。 ::: tip diff --git a/website/docs/zh/guide/advanced/module-federation.mdx b/website/docs/zh/guide/advanced/module-federation.mdx index e4b63fd98..54fc5af99 100644 --- a/website/docs/zh/guide/advanced/module-federation.mdx +++ b/website/docs/zh/guide/advanced/module-federation.mdx @@ -13,7 +13,7 @@ import { Tab, Tabs } from 'rspress/theme'; - 不同的团队处理同一应用程序的不同部分，而无需重新编译整个应用程序。 - 运行时中在应用间动态加载和共享代码。 -模块联盟可以帮助你: +模块联邦可以帮助你: - 减少代码重复 - 提高代码可维护性 @@ -28,7 +28,7 @@ import { PackageManagerTabs } from '@theme'; -然后在 `rslib.config.ts` 注册插件: +然后在 `rslib.config.ts` 中注册插件: ```ts title='rslib.config.ts' {8-43} import { pluginModuleFederation } from '@module-federation/rsbuild-plugin'; @@ -94,7 +94,7 @@ export default defineConfig({ Rslib 支持宿主应用和 Rslib 模块联邦项目同时开发。 -#### 1. 启动库中的 MF `dev` +#### 1. 启动库中的 MF `dev` 命令 添加 `dev` 命令在 `package.json` 文件: @@ -106,14 +106,14 @@ Rslib 支持宿主应用和 Rslib 模块联邦项目同时开发。 } ``` -然后运行 `dev` 命令即可启动模块联邦开发模式，可被 Host App 消费， +然后运行 `dev` 命令即可启动模块联邦开发模式，可被宿主应用消费， 同时具有热模块更换（HMR）功能。 -#### 2. 启动 Host App +#### 2. 启动宿主应用 -设置 Host 消费 Rslib 的模块联邦库。查看[@module-federation/rsbuild-plugin +设置宿主应用消费 Rslib 的模块联邦库。查看[@module-federation/rsbuild-plugin ](https://www.npmjs.com/package/@module-federation/rsbuild-plugin) 获取更多信息。 ```ts title="rsbuild.config.ts" {8-24} @@ -145,7 +145,7 @@ export default defineConfig({ }); ``` -然后通过 `rsbuild dev` 启动 Host app。 +然后通过 `rsbuild dev` 启动宿主应用。 ### 使用 Storybook diff --git a/website/docs/zh/guide/start/glossary.mdx b/website/docs/zh/guide/start/glossary.mdx index d7a1fb26d..8cb9b039f 100644 --- a/website/docs/zh/guide/start/glossary.mdx +++ b/website/docs/zh/guide/start/glossary.mdx @@ -19,11 +19,11 @@ CJS 代表 [CommonJS](https://nodejs.org/api/modules.html#modules-commonjs-modul ## Bundleless -Bundleless 是指一种开发方法，它避免了将多个 JavaScript /TypeScript 文件捆绑到单个或更少的输出文件中，然后再将其提供给客户端的传统做法。相反，它的目标是直接为各个模块提供服务。 +Bundleless 是指一种开发模式，它避免了将多个 JavaScript/TypeScript 文件 bundle 到单个或很少的输出文件中，然后再将其提供给客户端的传统做法。相反，它的目标是直接为各个模块提供服务。 ## DTS -DTS代表[TypeScript声明文件](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html)，为JavaScript代码提供类型信息。 +DTS代表 [TypeScript 声明文件](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html)，为 JavaScript 代码提供类型信息。 ## 模块联邦 @@ -31,4 +31,4 @@ DTS代表[TypeScript声明文件](https://www.typescriptlang.org/docs/handbook/d ## 更多 -访问 [Rsbuild-术语表](https://rsbuild.dev/guide/start/glossary) 和 [Rspack-术语表](https://rspack.dev/misc/glossary) 中的更多名词解释。 +访问 [Rsbuild - 名词解释](https://rsbuild.dev/zh/guide/start/glossary) 和 [Rspack - 术语表](https://rspack.dev/zh/misc/glossary) 中的更多名词解释。 diff --git a/website/docs/zh/guide/start/npm-packages.mdx b/website/docs/zh/guide/start/npm-packages.mdx index 76c202cfa..672672b04 100644 --- a/website/docs/zh/guide/start/npm-packages.mdx +++ b/website/docs/zh/guide/start/npm-packages.mdx @@ -15,7 +15,7 @@ Rslib 核心包，提供 CLI 命令和基于 Rsbuild 的构建功能。 ![](https://img.shields.io/npm/v/rsbuild-plugin-dts?style=flat-square&colorA=564341&colorB=F8F5FF) -支持为 TypeScript 发出声明文件的 Rsbuild 插件。 +支持为 TypeScript 生成类型声明文件的 Rsbuild 插件。 - [npm](https://npmjs.com/package/rsbuild-plugin-dts) - [Source Code](https://github.com/web-infra-dev/rslib/tree/main/packages/plugin-dts) diff --git a/website/docs/zh/guide/start/quick-start.mdx b/website/docs/zh/guide/start/quick-start.mdx index 3caef1cd2..bcc4c4fc7 100644 --- a/website/docs/zh/guide/start/quick-start.mdx +++ b/website/docs/zh/guide/start/quick-start.mdx @@ -51,7 +51,7 @@ import { PackageManagerTabs } from '@theme'; 每个模板都支持 JavaScript 和 TypeScript，以及可选的开发工具、格式化程序和 linter。 :::info -我们正在努力为更多框架提供模板 (比如 Vue). +我们正在努力为更多框架提供模板 (比如 Vue)。 ::: ### 开发工具