Skip to content

Commit

Permalink
docs(QuickStart): adjust quick start (#2939)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rex-zsd
rex-zsd authored Apr 1, 2020
1 parent 141996b commit 92de5e9
Show file tree
Hide file tree
Showing 51 changed files with 82 additions and 73 deletions.
27 changes: 18 additions & 9 deletions docs/markdown/quickstart.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,16 @@ npm i vant-weapp -S --production

如果你使用 typescript 开发小程序，需要在 tsconfig.json 中增加如下配置，防止 npm 构建后 tsc 编译报错

请将`path/to/node_modules/@vant/weapp`修改为项目中 @vant/weapp 所在的目录

```json
{
"baseUrl": ".",
"paths": {
"@vant/weapp/*": ["./node_modules/@vant/weapp/dist/*"]
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@vant/weapp/*": ["path/to/node_modules/@vant/weapp/dist/*"]
}
}
...
}
```

Expand All @@ -59,21 +62,27 @@ npm i vant-weapp -S --production

以 Button 组件为例，只需要在`app.json`或`index.json`中配置 Button 对应的路径即可。如果你是通过下载源代码的方式使用 @vant/weapp，请将路径修改为项目中 @vant/weapp 所在的目录。



```json
// 通过 npm 安装
// app.json
"usingComponents": {
"van-button": "@vant/weapp/button"
"van-button": "@vant/weapp/button/index"
}
```

```json
// 通过下载源码使用 es6版本
// app.json
"usingComponents": {
"van-button": "path/to/@vant/weapp/dist/button/index"
}
```

```json
// 通过下载源码使用
// 通过下载源码使用 es5版本
// app.json
"usingComponents": {
"van-button": "path/to/@vant/weapp/dist/button"
"van-button": "path/to/@vant/weapp/lib/button/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/action-sheet/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-action-sheet": "path/to/@vant/weapp/dist/action-sheet/index"
"van-action-sheet": "@vant/weapp/action-sheet/index"
}
```

Expand Down Expand Up @@ -191,7 +191,7 @@ Page({
| disabled | 是否为禁用状态 | *boolean* | - |
| className | 为对应列添加额外的 class 类名 | *string* | - |
| openType | 微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文 | *string* | `en` |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文 | *string* | `en` |
| sessionFrom | 会话来源，openType="contact"时有效 | *string* | - |
| sendMessageTitle | 会话内消息卡片标题，openType="contact"时有效 | *string* | 当前标题 |
| sendMessagePath | 会话内消息卡片点击跳转小程序路径，openType="contact"时有效 | *string* | 当前分享路径 |
Expand Down
2 changes: 1 addition & 1 deletion packages/area/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-area": "path/to/@vant/weapp/dist/area/index"
"van-area": "@vant/weapp/area/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/button/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-button": "path/to/@vant/weapp/dist/button/index"
"van-button": "@vant/weapp/button/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/calendar/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-calendar": "path/to/@vant/weapp/dist/calendar/index"
"van-calendar": "@vant/weapp/calendar/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/card/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-card": "path/to/@vant/weapp/dist/card/index"
"van-card": "@vant/weapp/card/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/cell/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

```json
"usingComponents": {
"van-cell": "path/to/@vant/weapp/dist/cell/index",
"van-cell-group": "path/to/@vant/weapp/dist/cell-group/index"
"van-cell": "@vant/weapp/cell/index",
"van-cell-group": "@vant/weapp/cell-group/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/checkbox/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

```json
"usingComponents": {
"van-checkbox": "path/to/@vant/weapp/dist/checkbox/index",
"van-checkbox-group": "path/to/@vant/weapp/dist/checkbox-group/index"
"van-checkbox": "@vant/weapp/checkbox/index",
"van-checkbox-group": "@vant/weapp/checkbox-group/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/circle/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-circle": "path/to/@vant/weapp/dist/circle/index"
"van-circle": "@vant/weapp/circle/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/col/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Layout 提供了`van-row`和`van-col`两个组件来进行行列布局

```json
"usingComponents": {
"van-row": "path/to/@vant/weapp/dist/row/index",
"van-col": "path/to/@vant/weapp/dist/col/index"
"van-row": "@vant/weapp/row/index",
"van-col": "@vant/weapp/col/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/collapse/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

```json
"usingComponents": {
"van-collapse": "path/to/@vant/weapp/dist/collapse/index",
"van-collapse-item": "path/to/@vant/weapp/dist/collapse-item/index"
"van-collapse": "@vant/weapp/collapse/index",
"van-collapse-item": "@vant/weapp/collapse-item/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/common/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Vant 中默认包含了一些常用样式，可以直接通过 className 的方
在 app.wxss 中引入内置样式

```css
@import "path/to/@vant/weapp/dist/common/index.wxss";
@import "@vant/weapp/common/index.wxss";
```

## 代码演示
Expand Down
2 changes: 1 addition & 1 deletion packages/count-down/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-count-down": "path/to/@vant/weapp/dist/count-down/index"
"van-count-down": "@vant/weapp/count-down/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/datetime-picker/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-datetime-picker": "path/to/@vant/weapp/dist/datetime-picker/index"
"van-datetime-picker": "@vant/weapp/datetime-picker/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/dialog/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

```json
"usingComponents": {
"van-dialog": "path/to/@vant/weapp/dist/dialog/index"
"van-dialog": "@vant/weapp/dialog/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/divider/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-divider": "path/to/@vant/weapp/dist/divider/index"
"van-divider": "@vant/weapp/divider/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/dropdown-menu/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

```json
"usingComponents": {
"van-dropdown-menu": "path/to/@vant/weapp/dist/dropdown-menu/index",
"van-dropdown-item": "path/to/@vant/weapp/dist/dropdown-item/index"
"van-dropdown-menu": "@vant/weapp/dropdown-menu/index",
"van-dropdown-item": "@vant/weapp/dropdown-item/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/field/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-field": "path/to/@vant/weapp/dist/field/index"
"van-field": "@vant/weapp/field/index"
}
```

Expand Down
6 changes: 3 additions & 3 deletions packages/goods-action/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

```json
"usingComponents": {
"van-goods-action": "path/to/@vant/weapp/dist/goods-action/index",
"van-goods-action-icon": "path/to/@vant/weapp/dist/goods-action-icon/index",
"van-goods-action-button": "path/to/@vant/weapp/dist/goods-action-button/index"
"van-goods-action": "@vant/weapp/goods-action/index",
"van-goods-action-icon": "@vant/weapp/goods-action-icon/index",
"van-goods-action-button": "@vant/weapp/goods-action-button/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/grid/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

```json
"usingComponents": {
"van-grid": "path/to/@vant/weapp/dist/grid/index",
"van-grid-item": "path/to/@vant/weapp/dist/grid-item/index"
"van-grid": "@vant/weapp/grid/index",
"van-grid-item": "@vant/weapp/grid-item/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/icon/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-icon": "path/to/@vant/weapp/dist/icon/index"
"van-icon": "@vant/weapp/icon/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/image/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-image": "path/to/@vant/weapp/dist/image/index"
"van-image": "@vant/weapp/image/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/index-bar/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

```json
"usingComponents": {
"van-index-bar": "path/to/@vant/weapp/dist/index-bar/index",
"van-index-anchor": "path/to/@vant/weapp/dist/index-anchor/index"
"van-index-bar": "@vant/weapp/index-bar/index",
"van-index-anchor": "@vant/weapp/index-anchor/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/loading/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-loading": "path/to/@vant/weapp/dist/loading/index"
"van-loading": "@vant/weapp/loading/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/nav-bar/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-nav-bar": "path/to/@vant/weapp/dist/nav-bar/index"
"van-nav-bar": "@vant/weapp/nav-bar/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/notice-bar/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-notice-bar": "path/to/@vant/weapp/dist/notice-bar/index"
"van-notice-bar": "@vant/weapp/notice-bar/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/notify/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

```json
"usingComponents": {
"van-notify": "path/to/@vant/weapp/dist/notify/index"
"van-notify": "@vant/weapp/notify/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/overlay/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-overlay": "path/to/@vant/weapp/dist/overlay/index"
"van-overlay": "@vant/weapp/overlay/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/panel/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-panel": "path/to/@vant/weapp/dist/panel/index"
"van-panel": "@vant/weapp/panel/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/picker/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

```json
"usingComponents": {
"van-picker": "path/to/@vant/weapp/dist/picker/index"
"van-picker": "@vant/weapp/picker/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/popup/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

```json
"usingComponents": {
"van-popup": "path/to/@vant/weapp/dist/popup/index"
"van-popup": "@vant/weapp/popup/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/progress/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

```json
"usingComponents": {
"van-progress": "path/to/@vant/weapp/dist/progress/index"
"van-progress": "@vant/weapp/progress/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/radio/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

```json
"usingComponents": {
"van-radio": "path/to/@vant/weapp/dist/radio/index",
"van-radio-group": "path/to/@vant/weapp/dist/radio-group/index"
"van-radio": "@vant/weapp/radio/index",
"van-radio-group": "@vant/weapp/radio-group/index"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/rate/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-rate": "path/to/@vant/weapp/dist/rate/index"
"van-rate": "@vant/weapp/rate/index"
}
```
## 代码演示
Expand Down
2 changes: 1 addition & 1 deletion packages/search/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```json
"usingComponents": {
"van-search": "path/to/@vant/weapp/dist/search/index"
"van-search": "@vant/weapp/search/index"
}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/sidebar/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

```json
"usingComponents": {
"van-sidebar": "path/to/@vant/weapp/dist/sidebar/index",
"van-sidebar-item": "path/to/@vant/weapp/dist/sidebar-item/index"
"van-sidebar": "@vant/weapp/sidebar/index",
"van-sidebar-item": "@vant/weapp/sidebar-item/index"
}
```

Expand Down
Loading

0 comments on commit 92de5e9

Please sign in to comment.