Skip to content

Commit 33e1719

Browse files
docs: format rsbuild zh chapter (#2532)
Co-authored-by: Zack Jackson <[email protected]>
1 parent 6b41e77 commit 33e1719

File tree

1 file changed

+20
-20
lines changed
  • apps/website-new/docs/zh/practice/frameworks/react

1 file changed

+20
-20
lines changed

apps/website-new/docs/zh/practice/frameworks/react/index.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ title: "Basic CRA with Rsbuild"
55
# Basic CRA with Rsbuild
66

77
:::tip Demo Reference
8-
在此处查看示例项目列表: [Rsbuild CRA](https://github.com/module-federation/module-federation-examples/tree/master/cra)
8+
点击此处查看示例项目: [Rsbuild CRA](https://github.com/module-federation/module-federation-examples/tree/master/cra)
99
:::
1010

1111
## 设置环境
12-
在开始之前,你需要安装 [Node.js](https://nodejs.org/),并确保你的 Node.js 版本 >= 16。 **我们建议使用 Node.js 20 的 LTS 版本.**
12+
在开始之前,你需要安装 [Node.js](https://nodejs.org/),并确保你的 Node.js 版本 >= 16。 **我们建议使用 Node.js 20 的 LTS 版本**
1313

1414
你可以使用以下命令检查当前使用的 Node.js 版本:
1515

1616
```bash
1717
node -v
1818
```
1919

20-
如果你当前环境没有安装Node.js,或者安装的版本太低,可以使用 [nvm](https://github.com/nvm-sh/nvm)[fnm](https: //github.com/Schniz/fnm) 安装所需的版本。
20+
如果你当前环境没有安装 Node.js,或者安装的版本太低,可以使用 [nvm](https://github.com/nvm-sh/nvm)[fnm](https://github.com/Schniz/fnm) 安装所需的版本。
2121

2222
以下是如何通过 nvm 安装 Node.js 20 LTS 版本的示例:
2323

@@ -35,7 +35,7 @@ nvm use 20
3535

3636
### 创建 React 项目
3737

38-
你可以使用create-rsbuild”使用 Rsbuild + React 创建项目。只需执行以下命令:
38+
你可以使用 `create-rsbuild` 来创建一个 Rsbuild + React 的项目,只需执行以下命令:
3939

4040
import { PackageManagerTabs } from '@theme';
4141

@@ -97,9 +97,9 @@ pnpm i
9797

9898
### 在现有项目中使用 React
9999

100-
要编译React,你需要注册Rsbuild [React Plugin](https://rsbuild.dev/plugins/list/plugin-react)。该插件将自动添加 React 构建所需的配置。
100+
要编译 React,你需要注册 Rsbuild [React Plugin](https://rsbuild.dev/plugins/list/plugin-react)。该插件将自动添加 React 构建所需的配置。
101101

102-
例如,在`rsbuild.config.ts`中注册:
102+
例如,在 `rsbuild.config.ts` 中注册:
103103

104104

105105
```ts title="rsbuild.config.ts"
@@ -112,14 +112,14 @@ export default defineConfig({
112112
```
113113

114114
:::tip
115-
对于使用Create React App的项目,可以参考【CRA迁移指南】(https://rsbuild.dev/guide/migration/cra)
115+
对于使用 Create React App 的项目,可以参考 [CRA 迁移指南](https://rsbuild.dev/guide/migration/cra)
116116
:::
117117

118118
通过检查 Yarn 提供的安装报告,确保 Webpack 版本 5 或更高版本已安装。
119119

120-
## 步骤2:更新条目文件
120+
## 步骤 2:更新入口文件
121121

122-
在这两个应用程序中,将index.js文件重命名为bootstrap.js。此更改允许异步加载bootstrap.js,这对于模块联邦在两个应用程序之间正确运行至关重要。
122+
在这两个应用程序中,将 `index.js` 文件重命名为 `bootstrap.js`。此更改允许异步加载 `bootstrap.js`,这对于模块联邦在两个应用程序之间正确运行至关重要。
123123

124124
```bash
125125
mv src/index.tsx src/bootstrap.tsx
@@ -140,23 +140,23 @@ root.render(
140140
);
141141
```
142142

143-
现在,在两个应用程序中创建一个新的index.tsx文件,其中包含以下内容以导入bootstrap.tsx
143+
现在,在两个应用程序中创建一个新的 `index.tsx` 文件,其中包含以下内容以导入 `bootstrap.tsx`
144144

145145
```typescript
146146
import('./bootstrap');
147147
```
148148

149-
## 步骤 3:创建并公开
149+
## 步骤 3:创建并导出
150150

151-
现在,创建一个从MFE2”公开的组件
151+
现在,创建一个从 `MFE2` 导出的组件
152152

153153

154154
<Steps>
155155

156156

157157
### 3.1 创建按钮组件
158158

159-
MFE2中,在 src 目录中创建一个名为Button.tsx的新文件,其中包含以下内容:
159+
`MFE2`中,在 src 目录中创建一个名为 `Button.tsx` 的新文件,其中包含以下内容:
160160

161161
```typescript
162162
const Button = () => (
@@ -185,9 +185,9 @@ const App = () => {
185185

186186
export default App;
187187
```
188-
## 3.3:在MFE2中配置Rsbuild
188+
## 3.3:在 MFE2 中配置 Rsbuild
189189

190-
`MFE2`根目录下创建`rsbuild.config.ts`文件,配置如下:
190+
`MFE2` 根目录下创建 `rsbuild.config.ts` 文件,配置如下:
191191

192192
```ts title="rsbuild.config.ts"
193193
import { defineConfig } from '@rsbuild/core';
@@ -224,12 +224,12 @@ export default defineConfig({
224224
</Steps>
225225
## 步骤 4:使用远程模块
226226

227-
MFE1中使用MFE2公开的模块
227+
`MFE1` 中使用 `MFE2` 公开的模块
228228

229229
<Steps>
230230
### 4.1 更新 App.tsx
231231

232-
更新MFE1”中的“App.tsx以导入并渲染MFE2按钮组件:
232+
更新 `MFE1` 中的 `App.tsx` 以导入并渲染 `MFE2` 按钮组件:
233233

234234
```typescript
235235
import React from 'react';
@@ -249,7 +249,7 @@ export default App;
249249

250250
### 4.2:在 MFE1 中配置 Rsbuild
251251

252-
MFE1根目录中创建rsbuild.config.ts文件,配置如下:
252+
`MFE1` 根目录中创建 `rsbuild.config.ts` 文件,配置如下:
253253

254254
```ts title="rsbuild.config.ts"
255255
import { defineConfig } from '@rsbuild/core';
@@ -284,6 +284,6 @@ export default defineConfig({
284284
```
285285
</Steps>
286286

287-
此设置会在MFE1内启动模块联邦,并且在启动开发服务器后,可以通过http://localhost:3001进行访问。
287+
此设置会在 `MFE1` 内启动模块联邦,并且在启动开发服务器后,可以通过 `http://localhost:3001` 进行访问。
288288

289-
类似地,配置激活MFE2的模块联邦,从而在“http://localhost:3002/remoteEntry.js”处公开“Button组件。随着开发服务器的运行,可以通过http://localhost:3002进行访问。
289+
类似地,配置激活 `MFE2` 的模块联邦,从而可通过 `http://localhost:3002/remoteEntry.js` 加载 `Button` 组件。随着开发服务器的运行,可以通过 `http://localhost:3002` 进行访问。

0 commit comments

Comments
 (0)