You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: website/docs/en/guide/framework/react.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -17,11 +17,11 @@ import { PackageManagerTabs } from '@theme';
17
17
}}
18
18
/>
19
19
20
-
Then select `React` when prompted to "Select framework".
20
+
Then select `React 19` or `React 18` when prompted to "Select framework".
21
21
22
22
## Use React in an existing project
23
23
24
-
To compile React, you need to register the Rsbuild [React Plugin](/plugins/list/plugin-react). The plugin will automatically add the necessary configuration for React builds.
24
+
To compile React's JSX syntax, you need to register the Rsbuild [React Plugin](/plugins/list/plugin-react). The plugin will automatically add the necessary configuration for building a React application.
Copy file name to clipboardexpand all lines: website/docs/en/guide/start/quick-start.mdx
+27-8
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,13 @@ import { PackageManagerTabs } from '@theme';
46
46
}}
47
47
/>
48
48
49
-
Then follow the prompts to complete the operation.
49
+
Follow the prompts step by step. During the creation process, you can choose whether you need additional tools like TypeScript, ESLint, etc.
50
+
51
+
After the project is created, you can follow these steps:
52
+
53
+
- Run `git init` to initialize the Git repository.
54
+
- Run `npm install` (or the install command of your package manager) to install project dependencies.
55
+
- Run `npm run dev` to start the development server, which runs on `localhost:5173` by default.
50
56
51
57
### Templates
52
58
@@ -134,20 +140,22 @@ To migrate from an existing project to Rsbuild, refer to the following guides:
134
140
-[Migrate from Vue CLI](/guide/migration/vue-cli)
135
141
-[Migrate from Vite](/guide/migration/vite)
136
142
-[Migrate from Modern.js Builder](/guide/migration/modern-builder)
143
+
-[Migrate from Tsup to Rslib](https://lib.rsbuild.dev/guide/migration/tsup)
144
+
-[Migrate from Storybook to Storybook Rsbuild](https://rspack.dev/guide/migration/storybook)
137
145
138
146
### Other projects
139
147
140
-
For other types of projects, you can manually install the [@rsbuild/core](https://www.npmjs.com/package/@rsbuild/core) package:
148
+
If your project does not belong to the above migration guides, you can manually install the [@rsbuild/core](https://www.npmjs.com/package/@rsbuild/core) package:
Then refer to the guide and documentation to enable the features you need:
152
+
After installation, you can refer to the following documents to configure your project:
145
153
146
154
- See [CLI](/guide/basic/cli) to learn about available CLI commands.
147
155
- See [Plugin List](/plugins/list/index) to select Rsbuild plugins.
148
156
- See [Configure Rsbuild](/guide/basic/configure-rsbuild) to configure Rsbuild.
149
157
150
-
## Command line interface
158
+
## CLI
151
159
152
160
Rsbuild comes with a lightweight CLI that includes commands such as `dev` and `build`.
153
161
@@ -170,6 +178,17 @@ Refer to the [CLI](/guide/basic/cli) to learn about all available commands and o
170
178
171
179
By default, Rsbuild CLI uses `src/index.(js|ts|jsx|tsx)` as the entry module. You can modify the entry module using the [source.entry](/config/source/entry) option.
172
180
181
+
```ts title="rsbuild.config.ts"
182
+
exportdefault {
183
+
source: {
184
+
entry: {
185
+
foo: './src/pages/foo/index.ts',
186
+
bar: './src/pages/bar/index.ts',
187
+
},
188
+
},
189
+
};
190
+
```
191
+
173
192
## Core packages
174
193
175
194
### @rsbuild/core
@@ -214,7 +233,7 @@ import Step from '@components/Step';
214
233
<NextSteps>
215
234
<Step
216
235
href="/guide/start/features"
217
-
title="All Features"
236
+
title="All features"
218
237
description="Learn all features of Rsbuild"
219
238
/>
220
239
<Step
@@ -223,8 +242,8 @@ import Step from '@components/Step';
223
242
description="Learn how to configure Rsbuild"
224
243
/>
225
244
<Step
226
-
href="/guide/start/glossary"
227
-
title="Glossary"
228
-
description="Learn about Rsbuild related concepts"
0 commit comments