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

docs(@vant/cli): optimize links and fix typos (#10545)

Browse Source
This commit is contained in:
neverland 2022-04-23 20:37:37 +08:00 committed by GitHub
parent 6baf42fa4a
commit 33150f82ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
packages/vant-cli/README.md
View File

@ -2,14 +2,15 @@
Vant CLI is a tool for building vue component library. You can quickly build a full-featured Vue component library with vant-cli.
🇨🇳 <a href="./README.zh-CN.md">查看中文版介绍</a>
---
### Features
- Provides rich commands covering the complete process from development to deploy
- Based on conventional directory structure. Generate elegant document website and component examples automatically.
- ESlint Stylelint built-in.
- Support Tree Shaking/Theme Customization/Import on Demand
### Quickstart
@ -71,4 +72,4 @@ Please add the followed config to `package.json` file.
- [cli](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/commands.md)
- [config](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/config.md)
- [directory structure](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/directory.md)
- [CHANGLOG](https://github.com/youzan/vant/tree/dev/packages/vant-cli/changelog.md)
- [CHANGELOG](https://github.com/youzan/vant/tree/dev/packages/vant-cli/changelog.md)

6
packages/vant-cli/README.zh-CN.md
View File

@ -65,7 +65,7 @@ pnpm add @vant/cli -D
## 详细文档
- [命令](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/commands.md)
- [配置指南](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/config.md)
- [目录结构](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/directory.md)
- [命令](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/commands.zh-CN.md)
- [配置指南](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/config.zh-CN.md)
- [目录结构](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/directory.zh-CN.md)
- [更新日志](https://github.com/youzan/vant/tree/dev/packages/vant-cli/changelog.md)

2
packages/vant-cli/docs/commands.md
View File

@ -48,7 +48,7 @@ Build documentation website. Files will be output to `site` directory.
### release
Publish to npm. `build` and `changlog` will be automatically execute when run `release`.
Publish to npm. `build` and `changelog` will be automatically execute when run `release`.
## changelog

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

@ -122,7 +122,7 @@ module.exports = {
Equivalent to vite `build.outDir`.
Genrally, documentation site will be deployed to subpath of domain. For examle: `https://my.github.io/demo-ui/`, `publicPath` should be `/demo-ui/`.
Generally, documentation site will be deployed to subpath of domain. For example: `https://my.github.io/demo-ui/`, `publicPath` should be `/demo-ui/`.
```js
module.exports = {
@ -279,7 +279,7 @@ module.exports = {
### site.baiduAnalytics
- Type: `object`
- Default: `undefied`
- Default: `undefined`
Documentation site baidu analysis config. The script of Baidu Statistic will be automatically loaded when build documentation website.

2
packages/vant-cli/docs/directory.md
View File

@ -25,7 +25,7 @@ The directories for individual components are as follows:
button
├─ demo # component demo directory
│ └─ index.vue # component demo
├─ index.vue # componet source code
├─ index.vue # component source code
└─ README.md # component doc
```