Skip to content

Commit c4ea766

Browse files
authored
docs: bump Rspress v1.18.2 and remove dividers (#2135)
1 parent 38a5705 commit c4ea766

File tree

16 files changed

+55
-265
lines changed

16 files changed

+55
-265
lines changed

packages/document/docs/en/community/releases/v0-5.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ Main changes:
1717
- 🍭 Refactor the SVGR plugin to support more usages.
1818
- 📍 Support for custom minify options.
1919

20-
---
21-
2220
## ⚡️ Supports Lightning CSS
2321

2422
Lightning CSS is a high performance CSS parser, transformer and minifier written in Rust. It supports parsing and transforming many modern CSS features into syntax supported by target browsers, and also provides a better compression ratio.
@@ -40,8 +38,6 @@ In a real large-scale web application, we have integrated the Rsbuild Lightning
4038
- CSS compilation time was reduced from 8.4s to 0.12s, a 70x improvement.
4139
- The overall build time was reduced from 33.1s to 25.4s, a 30% increase.
4240

43-
---
44-
4541
## 🌟 Support for Custom Server
4642

4743
Rsbuild now supports replacing the dev server with a custom server that reuses Rsbuild's page preview, routing, and module hot update features. This makes it easier to integrate Rsbuild with other Node.js frameworks.
@@ -64,8 +60,6 @@ async function startCustomServer() {
6460

6561
For more details, please refer to [Rsbuild - createDevServer](/api/javascript-api/instance#rsbuildcreatedevserver).
6662

67-
---
68-
6963
## 🍭 Refactoring SVGR Plugin
7064

7165
In versions prior to 0.5.0, the default usage of the SVGR plugin was the same as create-react-app, allowing SVGs to be used via mixed import:
@@ -100,8 +94,6 @@ pluginSvgr({
10094
});
10195
```
10296

103-
---
104-
10597
## 📍 Custom Minify Options
10698

10799
The `output.disableMinimize` option has been renamed to [output.minify](/config/output/minify), and it allows customizing JS and HTML minification options.

packages/document/docs/en/community/releases/v0-6.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,12 @@ Notable changes:
1818
- New transform plugin API
1919
- Default port changed to 3000
2020

21-
---
22-
2321
## Upgrade to Rspack v0.6
2422

2523
Rsbuild has upgraded the dependent Rspack to version v0.6, and adapted the breaking changes of CSS modules contained in Rspack v0.6.
2624

2725
In the new version, Rspack has enabled the new tree shaking algorithm by default, resulting in a significant improvement in bundle size and artifact stability. Please refer to the [Rspack 0.6 release announcement](https://rspack.dev/blog/announcing-0.6) to learn more.
2826

29-
---
30-
3127
## Error overlay enabled by default
3228

3329
Starting from Rsbuild v0.6, the default value of [dev.client.overlay](/config/dev/client) has been adjusted to `true`. This means that when a compilation error occurs, Rsbuild will pop up the error overlay by default to display the error information:
@@ -46,16 +42,12 @@ export default defineConfig({
4642
});
4743
```
4844

49-
---
50-
5145
## Support for Vue JSX HMR
5246

5347
`@rsbuild/plugin-vue-jsx` now supports JSX HMR. When you modify JSX code in a Vue 3 application, it will automatically trigger hot module replacement and preserve the current page state.
5448

5549
This feature is implemented by community contributor [@liyincode](https://github.com/liyincode) ❤️, and released as a standalone package [babel-plugin-vue-jsx-hmr](https://github.com/liyincode/babel-plugin-vue-jsx-hmr), for use in projects outside of Rsbuild.
5650

57-
---
58-
5951
## New transform API
6052

6153
Rsbuild plugin now supports the [transform API](/plugins/dev/core#apitransform), which can be thought of as a lightweight implementation of Rspack loader. It provides a simple and easy to use API and automatically calls Rspack loader at the backend to transform the code.
@@ -80,8 +72,6 @@ const pluginPug = () => ({
8072

8173
For some complex code transformation scenarios, `api.transform` may not be sufficient. In such situations, you can implement it using the Rspack loader.
8274

83-
---
84-
8575
## Default port changed to 3000
8676

8777
Rsbuild has changed the default value of [server.port](/config/server/port) from `8080` to `3000`.

packages/document/docs/en/guide/basic/cli.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Rsbuild comes with a lightweight CLI that includes commands such as `dev` and `build`.
44

5-
---
6-
75
## rsbuild -h
86

97
To view all available CLI commands, run the following command in the project directory:
@@ -29,8 +27,6 @@ Commands:
2927
help [command] display help for command
3028
```
3129

32-
---
33-
3430
## rsbuild dev
3531

3632
The `rsbuild dev` command is used to start a local dev server and compile the source code for development.
@@ -67,8 +63,6 @@ The `--open` option can also be abbreviated to `-o`:
6763
rsbuild dev -o
6864
```
6965

70-
---
71-
7266
## rsbuild build
7367

7468
The `rsbuild build` command will build the outputs for production in the `dist/` directory by default.
@@ -83,8 +77,6 @@ Options:
8377
-h, --help display help for command
8478
```
8579

86-
---
87-
8880
## rsbuild preview
8981

9082
The `rsbuild preview` command is used to preview the production build outputs locally. Note that you need to execute the `rsbuild build` command beforehand to generate the corresponding outputs.
@@ -103,8 +95,6 @@ Options:
10395
-h, --help display help for command
10496
```
10597

106-
---
107-
10898
## rsbuild inspect
10999

110100
The `rsbuild inspect` command is used to view the Rsbuild config and Rspack config of the project.

packages/document/docs/en/guide/optimization/split-chunk.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ A great chunk splitting strategy is very important to improve the loading perfor
44

55
Several [chunk splitting strategies](/guide/optimization/split-chunk) are built into Rsbuild. These should meet the needs of most applications. You can also customize the chunk splitting config to suit your own usage scenario.
66

7-
---
8-
97
## Strategies
108

119
> The chunk splitting config of Rsbuild is in [performance.chunkSplit](/config/performance/chunk-split).
@@ -19,8 +17,6 @@ Rsbuild supports the following chunk splitting strategies:
1917
- `single-vendor`: bundle all NPM packages into a single chunk.
2018
- `custom`: custom chunk splitting strategy.
2119

22-
---
23-
2420
## split-by-experience
2521

2622
### Behavior
@@ -51,8 +47,6 @@ export default {
5147

5248
- If the npm packages mentioned above are not installed or used in the project, the corresponding chunk will not be generated.
5349

54-
---
55-
5650
## split-by-module
5751

5852
### Behavior
@@ -81,8 +75,6 @@ export default {
8175
- When using HTTP/2, resource loading time will be accelerated and cache hit rate will be improved due to multiplexing.
8276
- When not using HTTP/2, the performance of page loading may be reduced due to HTTP head-of-line blocking. Please use with caution.
8377

84-
---
85-
8678
## all-in-one
8779

8880
### Behavior
@@ -125,8 +117,6 @@ export default defineConfig({
125117
});
126118
```
127119

128-
---
129-
130120
## single-vendor
131121

132122
### Behavior
@@ -149,8 +139,6 @@ export default {
149139

150140
- The size of a single vendor file may be very large, leading to a decrease in page loading performance.
151141

152-
---
153-
154142
## split-by-size
155143

156144
### Behavior
@@ -171,8 +159,6 @@ export default {
171159
};
172160
```
173161

174-
---
175-
176162
## Custom Splitting Strategy
177163

178164
In addition to using the built-in strategies, you can also customize the splitting strategy to meet more customization needs. Custom strategy is divided into two parts:
@@ -227,8 +213,6 @@ export default {
227213

228214
The config in `override` will be merged with the bundler config. For specific config details, please refer to [webpack - splitChunks](https://webpack.js.org/plugins/split-chunks-plugin/#splitchunkschunks) or [Rspack - splitChunks](https://rspack.dev/config/optimization#optimization-splitchunks).
229215

230-
---
231-
232216
## Using Dynamic Import for Code Splitting
233217

234218
In addition to the `chunkSplit` configurations, using dynamic import for code splitting is also an important optimization technique that can effectively reduce the initial bundle size.

0 commit comments

Comments
 (0)