From 33150f82eadf3b781f139c6a62bfa4adeee0bf21 Mon Sep 17 00:00:00 2001
From: neverland <chenjiahan@youzan.com>
Date: Sat, 23 Apr 2022 20:37:37 +0800
Subject: [PATCH] docs(@vant/cli): optimize links and fix typos (#10545)

---
 packages/vant-cli/README.md         | 9 +++++----
 packages/vant-cli/README.zh-CN.md   | 6 +++---
 packages/vant-cli/docs/commands.md  | 2 +-
 packages/vant-cli/docs/config.md    | 4 ++--
 packages/vant-cli/docs/directory.md | 2 +-
 5 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/packages/vant-cli/README.md b/packages/vant-cli/README.md
index 34e024af2..a589a74f2 100644
--- a/packages/vant-cli/README.md
+++ b/packages/vant-cli/README.md
@@ -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)
diff --git a/packages/vant-cli/README.zh-CN.md b/packages/vant-cli/README.zh-CN.md
index 89949aeff..1349bc3fc 100644
--- a/packages/vant-cli/README.zh-CN.md
+++ b/packages/vant-cli/README.zh-CN.md
@@ -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)
diff --git a/packages/vant-cli/docs/commands.md b/packages/vant-cli/docs/commands.md
index 790a192ee..1c6150442 100644
--- a/packages/vant-cli/docs/commands.md
+++ b/packages/vant-cli/docs/commands.md
@@ -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
 
diff --git a/packages/vant-cli/docs/config.md b/packages/vant-cli/docs/config.md
index 432914734..2ad11451d 100644
--- a/packages/vant-cli/docs/config.md
+++ b/packages/vant-cli/docs/config.md
@@ -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.
 
diff --git a/packages/vant-cli/docs/directory.md b/packages/vant-cli/docs/directory.md
index 67af58050..6a49c902f 100644
--- a/packages/vant-cli/docs/directory.md
+++ b/packages/vant-cli/docs/directory.md
@@ -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
 ```