blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 05:42:44 +08:00
Code Issues Projects Releases Wiki Activity

docs: update version description

Browse Source
This commit is contained in:
chenjiahan 2021-01-09 10:41:16 +08:00
parent fde4f40148
commit 663458e9ce
11 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -41,10 +41,10 @@
## Install
```bash
# Install vant 2.x for Vue 2 project
# Install Vant 2 for Vue 2 project
npm i vant -S
# Install vant 3.x for Vue 3 project
# Install Vant 3 for Vue 3 project
npm i vant@next -S
```

4
README.zh-CN.md
View File

@ -45,10 +45,10 @@ Vant 是**有赞前端团队**开源的移动端组件库，于 2017 年开源
## 安装
```bash
# Vue 2 项目，安装 Vant 2.x 版本：
# Vue 2 项目，安装 Vant 2：
npm i vant -S
# Vue 3 项目，安装 Vant 3.x 版本：
# Vue 3 项目，安装 Vant 3：
npm i vant@next -S
```

2
docs/markdown/changelog-v3.en-US.md
View File

@ -2,7 +2,7 @@
### Tips
The current document is the changelog of Vant 3.x. If you want to view the changelog of Vant 2.x, please visit [Vant 2.x Changelog](https://youzan.github.io/vant/#/en-US/changelog).
The current document is the changelog of Vant 3. If you want to view the changelog of Vant 2, please visit [Vant 2 Changelog](https://youzan.github.io/vant/#/en-US/changelog).
### Intro

2
docs/markdown/changelog-v3.zh-CN.md
View File

@ -2,7 +2,7 @@
### 提示
当前文档为 Vant 3.x 版本的更新日志，如需查询 Vant 2.x 的更新内容，请访问 [Vant 2.x 更新日志](https://youzan.github.io/vant/#/zh-CN/changelog)。
当前文档为 Vant 3 的更新日志，如需查询 Vant 2 的更新内容，请访问 [Vant 2 更新日志](https://youzan.github.io/vant/#/zh-CN/changelog)。
### 介绍

4
docs/markdown/contribution.zh-CN.md
View File

@ -19,8 +19,8 @@
```bash
# 克隆仓库
# 默认为 dev 分支，包含 Vant 3.x 的代码
# 如果需要在 Vant 2.x 上进行更改，请基于 2.x 分支进行开发
# 默认为 dev 分支，包含 Vant 3 的代码
# 如果需要在 Vant 2 上进行更改，请基于 2.x 分支进行开发
git clone git@github.com:youzan/vant.git
# 安装依赖

4
docs/markdown/migrate-from-v2.zh-CN.md
View File

@ -129,7 +129,7 @@ GoodsAction 商品导航组件重命名为 **ActionBar 行动栏**。
### 重命名 get-container 属性
Vue 3.0 中增加了 `Teleport` 组件，提供将组件渲染到任意 DOM 位置的能力，Vant 2.x 也通过 `get-container` 属性提供了类似的能力。为了与官方的 API 保持一致，Vant 中的 `get-container` 属性将重命名为 `teleport`。
Vue 3.0 中增加了 `Teleport` 组件，提供将组件渲染到任意 DOM 位置的能力，Vant 2 也通过 `get-container` 属性提供了类似的能力。为了与官方的 API 保持一致，Vant 中的 `get-container` 属性将重命名为 `teleport`。
```html
<!-- Vant 2 -->
@ -222,7 +222,7 @@ Vue 3.0 中增加了 `Teleport` 组件，提供将组件渲染到任意 DOM 位
### 注册全局方法
Vant 2.x 中默认提供了 `$toast`、`$dialog` 等全局方法，但 Vue 3.0 不再支持直接在 Vue 的原型链上挂载方法，因此从 Vant 3.0 开始，使用全局方法前必须先通过 `app.use` 将组件注册到对应的 app 上。
Vant 2 中默认提供了 `$toast`、`$dialog` 等全局方法，但 Vue 3.0 不再支持直接在 Vue 的原型链上挂载方法，因此从 Vant 3.0 开始，使用全局方法前必须先通过 `app.use` 将组件注册到对应的 app 上。
```js
import { Toast, Dialog, Notify } from 'vant';

4
docs/markdown/quickstart.en-US.md
View File

@ -5,10 +5,10 @@
### npm
```bash
# Install vant 2.x for Vue 2 project
# Install Vant 2 for Vue 2 project
npm i vant -S
# Install vant 3.x for Vue 3 project
# Install Vant 3 for Vue 3 project
npm i vant@next -S
```

4
docs/markdown/quickstart.zh-CN.md
View File

@ -11,10 +11,10 @@
在现有项目中使用 Vant 时，可以通过 `npm` 或 `yarn` 进行安装：
```bash
# Vue 2 项目，安装 Vant 2.x 版本：
# Vue 2 项目，安装 Vant 2：
npm i vant -S
# Vue 3 项目，安装 Vant 3.x 版本：
# Vue 3 项目，安装 Vant 3：
npm i vant@next -S
```

2
docs/site/release.sh
View File

@ -5,4 +5,4 @@ superman-cdn /vant ./site/*.js
rm -rf site/*.js
gh-pages -d site --add --dest next
gh-pages -d site --add --dest v3

4
packages/vant-cli/docs/config.md
View File

@ -185,8 +185,8 @@ module.exports = {
site: {
versions: [
{
label: '1.x',
link: 'https://youzan.github.io/vant/1.x/',
label: 'v1',
link: 'https://youzan.github.io/vant/v1/',
},
],
},

10
vant.config.js
View File

@ -15,8 +15,8 @@ module.exports = {
site: {
defaultLang: 'en-US',
versions: [
{ label: 'Vant 1.x', link: '/vant/1.x/' },
{ label: 'Vant 2.x', link: '/vant/' },
{ label: 'Vant v1', link: '/vant/v1/' },
{ label: 'Vant v2', link: '/vant/' },
{ label: 'Vant Weapp', link: '/vant-weapp/' },
],
baiduAnalytics: {
@ -24,7 +24,7 @@ module.exports = {
},
htmlPluginOptions: {
meta: {
'docsearch:version': '3.x',
'docsearch:version': 'v3',
},
},
locales: {
@ -44,7 +44,7 @@ module.exports = {
// apiKey: '90067aecdaa2c85220e2783cd305caac',
// indexName: 'vant',
// searchParameters: {
// facetFilters: ['lang:zh-CN', 'version:3.x'],
// facetFilters: ['lang:zh-CN', 'version:v3'],
// },
// transformItems(items) {
// if (location.hostname !== 'youzan.github.io') {
@ -425,7 +425,7 @@ module.exports = {
// apiKey: '90067aecdaa2c85220e2783cd305caac',
// indexName: 'vant',
// searchParameters: {
// facetFilters: ['lang:en-US', 'version:3.x'],
// facetFilters: ['lang:en-US', 'version:v3'],
// },
// },
nav: [