Skip to content

Commit

Permalink
docs: add Rsbuild scaffold guide (#12475)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan authored Nov 27, 2023
1 parent 9d219a5 commit 17a65c1
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,20 @@ pnpm add vant
bun add vant
```

## Scaffold

It is recommended to use [Rsbuild](https://github.com/web-infra-dev/rsbuild) to create a scaffold project.

Rsbuild is a build tool based on Rspack, developed by the author of Vant, with first-class build speed and development experience, providing first-priority support for Vant.

You can create a Rsbuild project with the following command:

```bash
npm create rsbuild@latest
```

Please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.

## Quickstart

```js
Expand Down
14 changes: 14 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,20 @@ pnpm add vant
bun add vant
```

## 脚手架

推荐使用 [Rsbuild](https://github.com/web-infra-dev/rsbuild) 来创建一个脚手架项目。

Rsbuild 是基于 Rspack 的构建工具,由 Vant 作者开发,具备一流的构建速度和开发体验,对 Vant 提供第一优先级支持。

你可以通过以下命令创建一个 Rsbuild 项目:

```bash
npm create rsbuild@latest
```

请访问 [Rsbuild 仓库](https://github.com/web-infra-dev/rsbuild) 了解更多信息。

## 快速上手

```js
Expand Down
14 changes: 14 additions & 0 deletions packages/vant/docs/markdown/home.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,20 @@
- 🍭 Support SSR
- 🌍 Support i18n, built-in 30+ languages

## Scaffold

It is recommended to use [Rsbuild](https://github.com/web-infra-dev/rsbuild) to create a scaffold project.

Rsbuild is a build tool based on Rspack, developed by the author of Vant, with first-class build speed and development experience, providing first-priority support for Vant.

You can create a Rsbuild project with the following command:

```bash
npm create rsbuild@latest
```

Please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.

### Quickstart

See in [Quickstart](#/en-US/quickstart).
Expand Down
14 changes: 14 additions & 0 deletions packages/vant/docs/markdown/home.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@ Vant 是一个**轻量、可定制的移动端组件库**,于 2017 年开源

你当前浏览的是 **Vant 4.x 版本** 的文档,适用于 Vue 3 开发。如果你在使用 Vue 2,请浏览 [Vant 2 文档](https://vant-contrib.gitee.io/vant/v2)

### 脚手架

推荐使用 [Rsbuild](https://github.com/web-infra-dev/rsbuild) 来创建一个脚手架项目。

Rsbuild 是基于 Rspack 的构建工具,由 Vant 作者开发,具备一流的构建速度和开发体验,对 Vant 提供第一优先级支持。

你可以通过以下命令创建一个 Rsbuild 项目:

```bash
npm create rsbuild@latest
```

请访问 [Rsbuild 仓库](https://github.com/web-infra-dev/rsbuild) 了解更多信息。

### 快速上手

请阅读[快速上手](#/zh-CN/quickstart)章节,通过该章节你可以了解到 Vant 的安装方法和基本使用姿势。
Expand Down
14 changes: 14 additions & 0 deletions packages/vant/docs/markdown/quickstart.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,20 @@ bun add vant

If you need to create a new project, we recommend using [Rsbuild](https://github.com/web-infra-dev/rsbuild), [Vite](https://vitejs.dev/) or [Nuxt framework](https://nuxtjs.org/).

#### Rsbuild

Rsbuild is a build tool based on Rspack, developed by the author of Vant, with first-class build speed and development experience, providing first-priority support for Vant.

You can create a Rsbuild project with the following command:

```bash
npm create rsbuild@latest
```

Please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.

#### Example

Here are the example projects provided by Vant official. You can clone these projects and copy the code.

- [vant-demo - rsbuild](https://github.com/vant-ui/vant-demo/tree/master/vant/rsbuild): Build an application using Vue 3, Vant 4, and Rsbuild.
Expand Down
14 changes: 14 additions & 0 deletions packages/vant/docs/markdown/quickstart.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,20 @@ bun add vant

如果你需要新建一个项目,我们推荐使用 [Rsbuild](https://github.com/web-infra-dev/rsbuild)[Vite](https://cn.vitejs.dev/)[Nuxt 框架](https://nuxt.com)

#### Rsbuild

Rsbuild 是基于 Rspack 的构建工具,由 Vant 作者开发,具备一流的构建速度和开发体验,对 Vant 提供第一优先级支持。

你可以通过以下命令创建一个 Rsbuild 项目:

```bash
npm create rsbuild@latest
```

请访问 [Rsbuild 仓库](https://github.com/web-infra-dev/rsbuild) 了解更多信息。

#### 示例项目

以下是 Vant 官方提供的一些示例项目,你可以克隆该项目,并直接拷贝代码来使用。

- [vant-demo - rsbuild](https://github.com/vant-ui/vant-demo/tree/master/vant/rsbuild):使用 Vue 3、Vant 4、Rsbuild 搭建应用
Expand Down

0 comments on commit 17a65c1

Please sign in to comment.