Skip to content

Commit

Permalink
docs: update description for Rslib (#4039)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan authored Nov 22, 2024
1 parent 712a8fc commit e8566de
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ To get started with Rsbuild, see the [Quick Start](https://rsbuild.dev/guide/sta
- [Rspack](https://github.com/web-infra-dev/rspack): A fast Rust-based web bundler.
- [Rspress](https://github.com/web-infra-dev/rspress): A fast static site generator based on Rsbuild.
- [Rsdoctor](https://github.com/web-infra-dev/rsdoctor): A one-stop build analyzer for Rspack and webpack.
- [Rslib](https://github.com/web-infra-dev/rslib): The library build tool powered by Rsbuild.
- [Rslib](https://github.com/web-infra-dev/rslib): The library development tool powered by Rsbuild.
- [Modern.js](https://github.com/web-infra-dev/modern.js): A progressive React framework based on Rsbuild.
- [awesome-rspack](https://github.com/web-infra-dev/awesome-rspack): A curated list of awesome things related to Rspack and Rsbuild.
- [rspack-examples](https://github.com/rspack-contrib/rspack-examples): Examples for Rspack, Rsbuild, Rspress and Rsdoctor.
Expand Down
2 changes: 1 addition & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Rsbuild 为上层的框架和工具提供了 JavaScript API 和 plugin API。例
- [Rspack](https://github.com/web-infra-dev/rspack):基于 Rust 的高性能打包工具。
- [Rspress](https://github.com/web-infra-dev/rspress):基于 Rsbuild 的静态站点生成器。
- [Rsdoctor](https://github.com/web-infra-dev/rsdoctor):针对 Rspack 和 webpack 的一站式构建分析工具。
- [Rslib](https://github.com/web-infra-dev/rslib): 基于 Rsbuild 的 library 构建工具
- [Rslib](https://github.com/web-infra-dev/rslib): 基于 Rsbuild 的 library 开发工具
- [Modern.js](https://github.com/web-infra-dev/modern.js):基于 Rsbuild 的渐进式 React 框架。
- [awesome-rspack](https://github.com/web-infra-dev/awesome-rspack):与 Rspack 和 Rsbuild 相关的精彩内容列表。
- [rspack-examples](https://github.com/rspack-contrib/rspack-examples):Rspack、Rsbuild、Rspress 和 Rsdoctor 的示例项目。
Expand Down
2 changes: 1 addition & 1 deletion website/docs/en/community/releases/v1-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ In the [Rspack 1.0 Announcement](https://rspack.dev/blog/announcing-1-0), we int

At ByteDance, we use Rsbuild as the cornerstone of our internal web frameworks to support thousands of web projects. These projects cover diverse use cases, including desktop web applications, mobile web applications, cross-platform web applications, documentation sites, and more.

For the community, we have open-sourced a high-performance toolchain based on Rsbuild, including the static site generator [Rspress](https://github.com/web-infra-dev/rspress), the library build tool [Rslib](https://github.com/web-infra-dev/rslib), the full-stack React framework [Modern.js](https://github.com/web-infra-dev/modern.js), and the [Storybook Rsbuild](https://github.com/rspack-contrib/storybook-rsbuild). The extensibility of Rsbuild allows these tools to flexibly integrate with Rsbuild and share its plugin ecosystem.
For the community, we have open-sourced a high-performance toolchain based on Rsbuild, including the static site generator [Rspress](https://github.com/web-infra-dev/rspress), the library development tool [Rslib](https://github.com/web-infra-dev/rslib), the full-stack React framework [Modern.js](https://github.com/web-infra-dev/modern.js), and the [Storybook Rsbuild](https://github.com/rspack-contrib/storybook-rsbuild). The extensibility of Rsbuild allows these tools to flexibly integrate with Rsbuild and share its plugin ecosystem.

After releasing Rsbuild 1.0, we also plan to collaborate with some excellent teams like [Remix](https://github.com/remix-run/remix), to bring Rsbuild to more web frameworks.

Expand Down
4 changes: 2 additions & 2 deletions website/docs/en/guide/faq/general.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ The main differences between Rspack and Rsbuild are:

### Can Rsbuild be used to build libraries or UI components?

Rsbuild is more suitable for building web applications.
Rsbuild is out-of-the-box for building web applications.

For libraries and UI components, you can use the Rsbuild-based library build tool - [Rslib](https://github.com/web-infra-dev/rslib).
For libraries and UI components, it is recommended to use [Rslib](https://github.com/web-infra-dev/rslib), which is a library development tool based on Rsbuild, and can reuse the configuration and plugins of Rsbuild.

---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/en/guide/start/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The following diagram illustrates the relationship between Rsbuild and other too
- [Rspack](https://github.com/web-infra-dev/rspack): A fast Rust-based web bundler.
- [Rspress](https://github.com/web-infra-dev/rspress): A fast static site generator based on Rsbuild.
- [Rsdoctor](https://github.com/web-infra-dev/rsdoctor): A one-stop build analyzer for Rspack and webpack.
- [Rslib](https://github.com/web-infra-dev/rslib): The library build tool powered by Rsbuild.
- [Rslib](https://github.com/web-infra-dev/rslib): The library development tool powered by Rsbuild.
- [Modern.js](https://github.com/web-infra-dev/modern.js): A progressive React framework based on Rsbuild.
- [awesome-rspack](https://github.com/web-infra-dev/awesome-rspack): A curated list of awesome things related to Rspack and Rsbuild.
- [rspack-examples](https://github.com/rspack-contrib/rspack-examples): Examples for Rspack, Rsbuild, Rspress and Rsdoctor.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/zh/community/releases/v1-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Rsbuild 是以 Rspack 为核心实现的,我们为 Rsbuild 设计了易于使

在字节跳动,我们将 Rsbuild 作为内部研发框架的基石,支持了数千个 web 项目,这些项目涵盖了不同的使用场景,包括 desktop web 应用、mobile web 应用、跨平台 web 应用、文档站等。

在社区中,我们开源了基于 Rsbuild 的高性能工具链,包括静态站点生成器 [Rspress](https://github.com/web-infra-dev/rspress),library 构建工具 [Rslib](https://github.com/web-infra-dev/rslib),React 全栈框架 [Modern.js](https://github.com/web-infra-dev/modern.js)[Storybook Rsbuild](https://github.com/rspack-contrib/storybook-rsbuild)。得益于 Rsbuild 的可扩展性,这些工具能够灵活地集成 Rsbuild,并与它共享插件生态。
在社区中,我们开源了基于 Rsbuild 的高性能工具链,包括静态站点生成器 [Rspress](https://github.com/web-infra-dev/rspress),library 开发工具 [Rslib](https://github.com/web-infra-dev/rslib),React 全栈框架 [Modern.js](https://github.com/web-infra-dev/modern.js)[Storybook Rsbuild](https://github.com/rspack-contrib/storybook-rsbuild)。得益于 Rsbuild 的可扩展性,这些工具能够灵活地集成 Rsbuild,并与它共享插件生态。

在 Rsbuild 1.0 发布后,我们也计划与 [Remix](https://github.com/remix-run/remix) 等优秀的团队一起探索,使 Rsbuild 能够与更多 web 框架集成。

Expand Down
4 changes: 2 additions & 2 deletions website/docs/zh/guide/faq/general.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Rspack 和 Rsbuild 的主要区别在于:

### Rsbuild 能否用于构建工具库或组件库?

Rsbuild 更适合构建 Web 应用。
Rsbuild 可以开箱即用地构建 Web 应用。

对于工具库和组件库,你可以使用基于 Rsbuild 的 library 构建工具 - [Rslib](https://github.com/web-infra-dev/rslib)
对于工具库和组件库,我们推荐使用 [Rslib](https://github.com/web-infra-dev/rslib),它是基于 Rsbuild 实现的 library 开发工具,能够复用 Rsbuild 的配置和插件

---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/zh/guide/start/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Rsbuild 为上层的框架和工具提供了 JavaScript API 和 plugin API。例
- [Rspack](https://github.com/web-infra-dev/rspack):基于 Rust 的高性能打包工具。
- [Rspress](https://github.com/web-infra-dev/rspress):基于 Rsbuild 的静态站点生成器。
- [Rsdoctor](https://github.com/web-infra-dev/rsdoctor):针对 Rspack 和 webpack 的一站式构建分析工具。
- [Rslib](https://github.com/web-infra-dev/rslib): 基于 Rsbuild 的 library 构建工具
- [Rslib](https://github.com/web-infra-dev/rslib): 基于 Rsbuild 的 library 开发工具
- [Modern.js](https://github.com/web-infra-dev/modern.js):基于 Rsbuild 的渐进式 React 框架。
- [awesome-rspack](https://github.com/web-infra-dev/awesome-rspack):与 Rspack 和 Rsbuild 相关的精彩内容列表。
- [rspack-examples](https://github.com/rspack-contrib/rspack-examples):Rspack、Rsbuild、Rspress 和 Rsdoctor 的示例项目。
Expand Down

0 comments on commit e8566de

Please sign in to comment.