diff --git a/README.md b/README.md
index 10f4ce4e..14bdfa68 100644
--- a/README.md
+++ b/README.md
@@ -10,27 +10,62 @@
---
## 概述
-[Vant Weapp](https://youzan.github.io/vant-weapp)是有赞移动端组件库 [Vant](https://github.com/youzan/vant) 的小程序版本,两者基于相同的视觉规范,并提供一致的 API 接口,助力开发者快速搭建小程序应用。
+[Vant Weapp](https://youzan.github.io/vant-weapp) 是有赞移动端组件库 [Vant](https://github.com/youzan/vant) 的小程序版本,两者基于相同的视觉规范,提供一致的 API 接口,助力开发者快速搭建小程序应用。
扫描下方小程序二维码,体验组件库示例:
-
+
## 文档
[https://youzan.github.io/vant-weapp](https://youzan.github.io/vant-weapp)
-## 下载
+### 使用之前
-``` bash
+使用 Vant Weapp 前,请确保你已经学习过微信官方的 [小程序简易教程](https://mp.weixin.qq.com/debug/wxadoc/dev/) 和 [自定义组件介绍](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/)。
+
+### 安装
+
+#### 方式一. 通过 npm 安装 (推荐)
+
+小程序已经支持使用 npm 安装第三方包,详见 [npm 支持](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html?search-key=npm)
+
+```bash
+# npm
+npm i vant-weapp -S --production
+
+# yarn
+yarn add vant-weapp --production
+```
+
+#### 方式二. 下载代码
+
+直接通过 git 下载 Vant Weapp 源代码,并将`dist`目录拷贝到自己的项目中
+```bash
git clone https://github.com/youzan/vant-weapp.git
```
-## 预览
+### 使用组件
-1. 在 vant-weapp 根目录下运行
+以按钮组件为例,只需要在 json 文件中引入按钮对应的自定义组件即可
-``` bash
+```json
+{
+ "usingComponents": {
+ "van-button": "/path/to/vant-weapp/dist/button/index"
+ }
+}
+```
+
+接着就可以在 wxml 中直接使用组件
+
+```xml
+按钮
+```
+
+### 在开发者工具中预览
+
+```bash
# 安装项目依赖
npm install
@@ -38,78 +73,15 @@ npm install
npm run dev
```
-2. 打开[微信开发者工具],把 vant-weapp/example 目录添加进去就可以预览示例了。
+打开[微信开发者工具](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/download.html),把`vant-weapp/example`目录添加进去就可以预览示例了。
-## 使用
+### 链接
-1. 使用 [vant-weapp] 前请确保已经学习过微信官方的 [小程序简易教程] 和 [小程序框架介绍]。
-2. 然后用 [Bower] 将 [vant-weapp] 添加到你的项目中使用。
-3. 你也可以 fork 出一份你自己的 [vant-weapp],这样可以获得更稳定的代码和更方便的进行个性定制。
-
-我们推荐在你的`app.wxss`直接引入`vant-weapp/dist/index.wxss`。
-
-详细使用文档,请参考 [快速上手](https://youzan.github.io/vant-weapp)
-
-### 组件分类介绍
-根据功能的不同,可以将组件大致的分为2类:
-
-#### 1. 正常引用
-
-如按钮组件,只需要在页面中引入按钮自定义组件即可
-```json
-{
- "usingComponents": {
- "van-button": "/path/to/vant-weapp/dist/button/index"
- }
-}
-```
-```html
-
-
-按钮
-```
-
-
-
-
-#### 2. API类组件
-
-如 Toast 组件,需要先在页面上引入自定义组件。之后在逻辑运行时,直接调用方法即可展示
-```json
-{
- "usingComponents": {
- "van-toast": "/path/to/vant-weapp/dist/toast/index"
- }
-}
-```
-```html
-
-```
-
-将对应的 Toast 的函数引入页面,就可以直接调用来展示 Toast 了
-
-```js
-// example/toast/index.js
-
-const Toast = require('/path/to/vant-weapp/dist/toast/toast');
-
-Page({
- showToast() {
- Toast({
- selector: '#van-toast-test',
- message: 'toast内容'
- });
- }
-});
-
-```
-
-更多示例可以在项目的`example`目录中查看
-
-## 旧版组件库
-组件库现在已经全部升级至自定义组件,如果项目暂时无法切换到自定义组件的形式,可以将使用的版本号设置为低于 3.0.0。同时,旧的代码会在分支 old_code 上保留一段时间。
-
-建议新使用的用户,直接以自定义组件形式接入
+* [意见反馈](https://github.com/youzan/vant-weapp/issues)
+* [加入我们](https://job.youzan.com)
+* [更新日志](#/changelog)
+* [Vue 组件库](https://github.com/youzan/vant)
+* [React 组件库](https://www.youzanyun.com/zanui/zent)
## 微信讨论群
@@ -118,6 +90,7 @@ Page({
## 开源协议
+
本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89)协议,请自由地享受和参与开源。
## 贡献
diff --git a/docs/markdown/intro.md b/docs/markdown/intro.md
index c43a2e62..954b3f42 100644
--- a/docs/markdown/intro.md
+++ b/docs/markdown/intro.md
@@ -4,13 +4,15 @@
Vant Weapp
轻量、可靠的小程序 UI 组件库
-
-### 特性
-* 与 Vant 遵循同套视觉规范
-* 与 Vant 提供一致的 API 接口
-* 完善的文档和示例
-* 快速迭代升级
+### 概述
+[Vant Weapp](https://youzan.github.io/vant-weapp) 是有赞移动端组件库 [Vant](https://github.com/youzan/vant) 的小程序版本,两者基于相同的视觉规范,提供一致的 API 接口,助力开发者快速搭建小程序应用。
+
+### 预览
+
+扫描下方小程序二维码,体验组件库示例:
+
+
### 快速上手
diff --git a/docs/markdown/quickstart.md b/docs/markdown/quickstart.md
index 5b426577..2b23c7c2 100644
--- a/docs/markdown/quickstart.md
+++ b/docs/markdown/quickstart.md
@@ -1 +1,56 @@
## 快速上手
+
+### 使用之前
+
+使用 Vant Weapp 前,请确保你已经学习过微信官方的 [小程序简易教程](https://mp.weixin.qq.com/debug/wxadoc/dev/) 和 [自定义组件介绍](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/)。
+
+### 安装
+
+#### 方式一. 通过 npm 安装 (推荐)
+
+小程序已经支持使用 npm 安装第三方包,详见 [npm 支持](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html?search-key=npm)
+
+```bash
+# npm
+npm i vant-weapp -S --production
+
+# yarn
+yarn add vant-weapp --production
+```
+
+#### 方式二. 下载代码
+
+直接通过 git 下载 Vant Weapp 源代码,并将`dist`目录拷贝到自己的项目中
+```bash
+git clone https://github.com/youzan/vant-weapp.git
+```
+
+### 使用组件
+
+以按钮组件为例,只需要在 json 文件中引入按钮对应的自定义组件即可
+
+```json
+{
+ "usingComponents": {
+ "van-button": "/path/to/vant-weapp/dist/button/index"
+ }
+}
+```
+
+接着就可以在 wxml 中直接使用组件
+
+```xml
+按钮
+```
+
+### 在开发者工具中预览
+
+```bash
+# 安装项目依赖
+npm install
+
+# 执行组件编译
+npm run dev
+```
+
+打开[微信开发者工具](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/download.html),把`vant-weapp/example`目录添加进去就可以预览示例了。
diff --git a/docs/src/Preview.vue b/docs/src/Preview.vue
index c84eb26d..d267e5c8 100644
--- a/docs/src/Preview.vue
+++ b/docs/src/Preview.vue
@@ -105,14 +105,15 @@ body {
user-select: none;
img {
- width: 160px;
- height: 160px;
+ width: 180px;
+ height: 180px;
margin-bottom: 15px;
display: inline-block;
}
p {
margin: 0;
+ color: #34495e;
line-height: 1.5;
font-size: 16px;
}