Skip to content

Commit 753bb70

Browse files
chenjiahanchenjiahan
authored
docs: update README files for plugin packages (#4590)
1 parent 7a436dd commit 753bb70

File tree

15 files changed

+165
-151
lines changed

15 files changed

+165
-151
lines changed

‎packages/compat/plugin-webpack-swc/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-webpack-swc
42

5-
# Rsbuild
3+
An Rsbuild plugin to use SWC as the JavaScript compiler with `@rsbuild/webpack`.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-webpack-swc">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-webpack-swc?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-webpack-swc?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-webpack-swc.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/compat/webpack/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
4-
51
# @rsbuild/webpack
62

73
This package can be used to switch Rsbuild's bundler from Rspack to webpack.
84

9-
Note that this package is mainly used for compatibility with Modern.js and Rsbuild internal testing. We do not recommend you to use this package in a Rsbuild project. The API of the current package may change over iterations.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/webpack">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/webpack?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/webpack?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/webpack.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
12+
13+
> Note that this package is mainly used for compatibility with Modern.js and Rsbuild internal testing. We do not recommend you to use this package in a Rsbuild project. The API of the current package may change over iterations.
1014
1115
## Usage
1216

@@ -29,12 +33,8 @@ export default defineConfig({
2933
3034
## Documentation
3135

32-
https://rsbuild.dev/
33-
34-
## Contributing
35-
36-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
36+
See [Documentation](https://rsbuild.dev).
3737

3838
## License
3939

40-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
40+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/core/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,21 @@
22
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
33
</p>
44

5-
# Rsbuild
5+
# @rsbuild/core
66

77
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
88

9+
<p>
10+
<a href="https://npmjs.com/package/@rsbuild/core">
11+
<img src="https://img.shields.io/npm/v/@rsbuild/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
12+
</a>
13+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
14+
<a href="https://npmcharts.com/compare/@rsbuild/core?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/core.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
15+
</p>
16+
917
## Documentation
1018

11-
https://rsbuild.dev/
19+
See [Documentation](https://rsbuild.dev/).
1220

1321
## Contributing
1422

‎packages/create-rsbuild/README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@
66

77
Create a new Rsbuild project.
88

9+
<p>
10+
<a href="https://npmjs.com/package/create-rsbuild">
11+
<img src="https://img.shields.io/npm/v/create-rsbuild?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
12+
</a>
13+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
14+
<a href="https://npmcharts.com/compare/create-rsbuild?minimal=true"><img src="https://img.shields.io/npm/dm/create-rsbuild.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
15+
</p>
16+
17+
## Usage
18+
919
Using `npm create`:
1020

1121
```bash
@@ -23,12 +33,8 @@ npx create-rsbuild -d my-project -t react
2333

2434
## Documentation
2535

26-
https://rsbuild.dev/
27-
28-
## Contributing
29-
30-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
36+
See [Documentation](https://rsbuild.dev/guide/start/quick-start).
3137

3238
## License
3339

34-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
40+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-assets-retry/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-assets-retry
42

5-
# Rsbuild
3+
An Rsbuild plugin to automatically resend requests when static assets fail to load.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-assets-retry">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-assets-retry?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-assets-retry?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-assets-retry.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-assets-retry).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-babel/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-babel
42

5-
# Rsbuild
3+
An Rsbuild plugin to use Babel to transpile the code.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-babel">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-babel?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-babel?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-babel.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-babel).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-less/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-less
42

5-
# Rsbuild
3+
An Rsbuild plugin to use Less as the CSS preprocessor.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-less">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-less?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-less?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-less.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-less).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-preact/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-preact
42

5-
# Rsbuild
3+
An Rsbuild plugin to provide support for Preact.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-preact">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-preact?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-preact?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-preact.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-preact).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-react/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-react
42

5-
# Rsbuild
3+
An Rsbuild plugin to provide support for React, integrating features such as JSX compilation and React Refresh.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-react">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-react?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-react?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-react.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-react).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-sass/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-sass
42

5-
# Rsbuild
3+
An Rsbuild plugin to use Sass as the CSS preprocessor.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-sass">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-sass?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-sass?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-sass.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-sass).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-solid/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-solid
42

5-
# Rsbuild
3+
An Rsbuild plugin to provide support for Solid.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-solid">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-solid?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-solid?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-solid.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-solid).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

‎packages/plugin-stylus/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
<p align="center">
2-
<a href="https://rsbuild.dev" target="blank"><img src="https://assets.rspack.dev/rsbuild/rsbuild-banner.png" alt="Rsbuild Logo" /></a>
3-
</p>
1+
# @rsbuild/plugin-stylus
42

5-
# Rsbuild
3+
An Rsbuild plugin to use Stylus as the CSS preprocessor.
64

7-
The Rspack-based build tool. It's fast, out-of-the-box and extensible.
5+
<p>
6+
<a href="https://npmjs.com/package/@rsbuild/plugin-stylus">
7+
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-stylus?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
8+
</a>
9+
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
10+
<a href="https://npmcharts.com/compare/@rsbuild/plugin-stylus?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-stylus.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
11+
</p>
812

913
## Documentation
1014

11-
https://rsbuild.dev/
12-
13-
## Contributing
14-
15-
Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
15+
See [Documentation](https://rsbuild.dev/plugins/list/plugin-stylus).
1616

1717
## License
1818

19-
Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
19+
[MIT](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

0 commit comments

Comments
 (0)