Batch fix doc issues in tiup docs (pingcap#6042)

tiup/tiup-cluster.md

@@ -663,7 +663,7 @@ tiup cluster check <cluster-name> --cluster
 
 也可以使用环境变量 `TIUP_NATIVE_SSH` 来指定是否使用本地 SSH 客户端，避免每个命令都需要添加 `--native-ssh` 参数：
 
-```sh
+```shell
 export TIUP_NATIVE_SSH=true
 # 或者
 export TIUP_NATIVE_SSh=1

tiup/tiup-command-clean.md

@@ -8,17 +8,19 @@ title: tiup clean
 
 ## 语法
 
-```sh
+```shell
 tiup clean [name] [flags]
 ```
 
 `[name]` 取值为 [status 命令](/tiup/tiup-command-status.md)输出的 `Name` 字段。若省略 `[name]`，则必须配合 `--all` 使用。
 
 ## 选项
 
-### --all (boolean, 默认 false)
+### --all
 
-清除所有运行记录。
+- 清除所有运行记录。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
 ## 输出
 

tiup/tiup-command-completion.md

@@ -13,7 +13,7 @@ title: tiup completion
 
 ## 语法
 
-```sh
+```shell
 tiup completion <shell>
 ```
 
@@ -25,7 +25,7 @@ tiup completion <shell>
 
 将自动补全代码写入一个文件，并且在 `.bash_profile` 中对其执行 `source` 命令：
 
-```sh
+```shell
 tiup completion bash > ~/.tiup.completion.bash
 
 printf "
@@ -38,6 +38,6 @@ source $HOME/.bash_profile
 
 ### zsh
 
-```sh
+```shell
 tiup completion zsh > "${fpath[1]}/_tiup"
 ```

tiup/tiup-command-env.md

@@ -8,7 +8,7 @@ TiUP 为用户提供了灵活的定制化接口，其中一部分是使用环境
 
 ## 语法
 
-```sh
+```shell
 tiup env [name1...N]
 ```
 

tiup/tiup-command-help.md

@@ -8,7 +8,7 @@ TiUP 命令行界面为用户提供了丰富的帮助信息，用户可以通过
 
 ## 语法
 
-```sh
+```shell
 tiup help [command]
 ```
 

tiup/tiup-command-install.md

@@ -8,7 +8,7 @@ title: tiup install
 
 ## 语法
 
-```sh
+```shell
 tiup install <component1>[:version] [component2...N] [flags]
 ```
 

tiup/tiup-command-list.md

@@ -8,31 +8,37 @@ title: tiup list
 
 ## 语法
 
-```sh
+```shell
 tiup list [component] [flags]
 ```
 
 `[component]` 是可选的组件名称。若指定，则列出该组件的所有版本；若不指定，则列出所有组件列表。
 
 ## 选项
 
-### --all（boolean，默认 false）
+### --all
 
-显示所有组件。默认只显示非隐藏组件。
+- 显示所有组件。默认只显示非隐藏组件。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
-### --installed（boolean，默认 false）
+### --installed
 
-只显示已经安装的组件或版本。
+- 只显示已经安装的组件或版本。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
-### --verbose（boolean，默认 false）
+### --verbose
 
-在组件列表中显示已安装的版本列表。默认组件列表不显示当前已安装的版本。
+- 在组件列表中显示已安装的版本列表。默认组件列表不显示当前已安装的版本。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
 ## 输出
 
 - 若未指定 `[component]`
-    - 若指定 --verbose：输出 `组件名 (Name)`、`已安装版本 (Installed)`、`组件管理员 (Owner)`、`组件描述 (Owner)` 构成的组件信息列表
-    - 若不指定 --verbose：输出 `组件名 (Name)`、`组件管理员 (Owner)`、`组件描述 (Owner)` 构成的组件信息列表
+    - 若指定 --verbose：输出 `组件名 (Name)`、`已安装版本 (Installed)`、`组件管理员 (Owner)`、`组件描述 (Description)` 构成的组件信息列表
+    - 若不指定 --verbose：输出 `组件名 (Name)`、`组件管理员 (Owner)`、`组件描述 (Description)` 构成的组件信息列表
 - 若指定 `[component]`
     - 若 `[component]` 存在：输出 `版本 (Version)`、`是否已安装 (Installed)`、`发布时间 (Release)`、`支持的平台 (Platforms)` 构成的版本信息列表
     - 若 `[component]` 不存在：报错 `failed to fetch component: unknown component`

tiup/tiup-command-mirror-clone.md

@@ -8,7 +8,7 @@ title: tiup mirror clone
 
 ## 语法
 
-```sh
+```shell
 tiup mirror clone <target-dir> [global version] [flags]
 ```
 
@@ -17,21 +17,29 @@ tiup mirror clone <target-dir> [global version] [flags]
 
 ## 选项
 
-### -f, --full（boolean，默认 false）
+### -f, --full
 
-是否克隆整个镜像。指定该选项后会完整从目标镜像克隆所有组件的所有版本，此时其他指定的选项将失效。
+- 是否克隆整个镜像。指定该选项后会从目标镜像完整克隆所有组件的所有版本，此时其他指定的选项将失效。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
-### -a, --arch（strings，默认 amd64,arm64）
+### -a, --arch
 
-仅克隆能在指定平台上运行的组件。
+- 仅克隆能在指定平台上运行的组件。
+- 数据类型：`STRINGS`
+- 该参数接受以逗号分隔的多个平台名称，例如 `amd64,arm64`。如果未指定该选项，默认克隆 AMD64 和 ARM64 平台的组件，即 `amd64,arm64`。
 
-### -o, --os（strings，默认 linux,darwin）
+### -o, --os
 
-仅克隆能在指定操作系统上运行的组件。
+- 仅克隆能在指定操作系统上运行的组件。
+- 数据类型：`STRINGS`
+- 该参数接受以逗号分隔的多个操作系统名称，例如 `linux,darwin`。如果未指定该选项，默认克隆 Linux 和 Darwin 系统的组件，即 `linux,darwin`。
 
-### --prefix（boolean，默认 false）
+### --prefix
 
-匹配版本时是否前缀匹配。默认情况下必须严格匹配指定的版本才会下载，指定该选项之后，仅前缀匹配指定的版本也会被下载。
+- 匹配版本时是否前缀匹配。默认情况下必须严格匹配指定的版本才会下载，指定该选项之后，仅前缀匹配指定的版本也会被下载。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
 ### --{component}（strings，默认为空）
 

tiup/tiup-command-mirror-genkey.md

@@ -18,25 +18,30 @@ title: tiup mirror genkey
 
 ## 语法
 
-```sh
+```shell
 tiup mirror genkey [flags]
 ```
 
 ## 选项
 
-### -n, --name（string，默认 private）
+### -n, --name
 
-密钥的名字，该名字决定最终生成的文件名。生成的私钥文件路径为：`${TIUP_HOME}/keys/{name}.json`，其中 `TIUP_HOME` 为 TiUP 的家目录，默认路径为 `$HOME/.tiup`，`name` 为 `-n/--name` 指定的密钥名字。
+- 密钥的名字，该名字决定最终生成的文件名。生成的私钥文件路径为：`${TIUP_HOME}/keys/{name}.json`，其中 `TIUP_HOME` 为 TiUP 的家目录，默认路径为 `$HOME/.tiup`，`name` 为 `-n/--name` 指定的密钥名字。
+- 数据类型：`STRING`
+- 如果不指定该选项，密钥名默认为 `private`。
 
-### -p, --public（boolean，默认 false）
+### -p, --public
 
-显示当前私钥对应的公钥，当前私钥名字由 `-n/--name` 选项指定。
+- 显示当前私钥对应的公钥，当前私钥名字由 `-n/--name` 选项指定。
+- 当指定了 `-p/--public` 时，不会创建新的私钥。若 `-n/--name` 指定的私钥不存在，则报错。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
-当指定了 `-p/--public` 时，不会创建新的私钥。若 `-n/--name` 指定的私钥不存在，则报错。
+### --save
 
-### --save（boolean，默认 false）
-
-将公钥信息储存为文件放置于当前目录，文件名称为 `{hash-prefix}-public.json`，其中 `hash-prefix` 为该密钥 ID 的前 16 位。
+- 将公钥信息储存为文件放置于当前目录，文件名称为 `{hash-prefix}-public.json`，其中 `hash-prefix` 为该密钥 ID 的前 16 位。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
 ## 输出
 

tiup/tiup-command-mirror-grant.md

@@ -6,15 +6,15 @@ title: tiup mirror grant
 
 命令 `tiup mirror grant` 用来向当前镜像中引入一个组件管理员。
 
-组件管理员可以使用其密钥发布新的组件，也可以对其之前发布的组件作出修改。添加组件管理员时，该组件管理员需要先将其公钥发送给镜像管理员。
+组件管理员可以使用其密钥发布新的组件，也可以对其之前发布的组件作出修改。添加组件管理员时，待添加的组件管理员需要先将其公钥发送给镜像管理员。
 
 > **注意：**
 >
 > 该命令仅支持在当前镜像为本地镜像时使用。
 
 ## 语法
 
-```sh
+```shell
 tiup mirror grant <id> [flags]
 ```
 

tiup/tiup-command-mirror-init.md

@@ -23,7 +23,7 @@ title: tiup mirror init
 
 ## 语法
 
-```sh
+```shell
 tiup mirror init <path> [flags]
 ```
 

tiup/tiup-command-mirror-merge.md

@@ -13,7 +13,7 @@ title: tiup mirror merge
 
 ## 语法
 
-```sh
+```shell
 tiup mirror merge <mirror-dir-1> [mirror-dir-N] [flags]
 ```
 

tiup/tiup-command-mirror-modify.md

@@ -8,7 +8,7 @@ title: tiup mirror modify
 
 ## 语法
 
-```sh
+```shell
 tiup mirror modify <component>[:version] [flags]
 ```
 
@@ -23,28 +23,35 @@ tiup mirror modify <component>[:version] [flags]
 
 组件管理员的私钥，客户端需要使用该私钥对组件信息 (`{component}.json`) 进行签名。
 
-### --yank（boolean，默认 false）
+### --yank
 
-将指定组件或指定版本标记为不可用：
+- 将指定组件或指定版本标记为不可用：
 
-- 标记组件不可用之后 `tiup list` 将看不到该组件，也无法安装该组件的新版本。
-- 标记版本不可用之后 `tiup list <component>` 将看不到该版本，也无法安装该版本。
+    - 标记组件不可用之后 `tiup list` 将看不到该组件，也无法安装该组件的新版本。
+    - 标记版本不可用之后 `tiup list <component>` 将看不到该版本，也无法安装该版本。
 
-### --hide（boolean，默认 false）
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
-将该组件设置为隐藏，隐藏之后该组件将不在 `tiup list` 的列表中显示，但是可通过执行 `tiup list --all` 查看。
+### --hide
+
+- 将该组件设置为隐藏，隐藏之后该组件将不在 `tiup list` 的列表中显示，但是可通过执行 `tiup list --all` 查看。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
 > **注意：**
 >
 > 该选项只能应用于组件上，无法应用于组件的版本上。
 
-### --standalone（boolean，默认 false）
+<!-- ### --standalone
 
-该组件是否可独立运行。本参数目前尚未启用。
+- 该组件是否可独立运行。本参数目前尚未启用。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
 > **注意：**
 >
-> 该选项只能应用于组件上，无法应用于组件的版本上。
+> 该选项只能应用于组件上，无法应用于组件的版本上。-->
 
 ## 输出
 

tiup/tiup-command-mirror-publish.md

@@ -8,7 +8,7 @@ title: tiup mirror publish
 
 ## 语法
 
-```sh
+```shell
 tiup mirror publish <comp-name> <version> <tarball> <entry> [flags]
 ```
 
@@ -53,13 +53,17 @@ tiup mirror publish <comp-name> <version> <tarball> <entry> [flags]
 
 该组件的描述信息。
 
-### --hide（boolean，默认 false）
+### --hide
 
-是否为隐藏组件。若为隐藏组件，则不在 `tiup list` 的列表中显示，但是 `tiup list --all` 可看到。
+- 是否为隐藏组件。若为隐藏组件，则不在 `tiup list` 的列表中显示，但在 `tiup list --all` 的列表中会显示。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
-### --standalone（boolean，默认 false）
+<!-- ### --standalone
 
-该组件是否可独立运行。该参数目前尚未启用。
+- 该组件是否可独立运行。该参数目前尚未启用。
+- 数据类型：`BOOLEAN`
+- 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。-->
 
 ## 输出
 

tiup/tiup-command-mirror-rotate.md

@@ -39,7 +39,7 @@ TiUP 使用命令 `tiup mirror rotate` 来自动化以上流程。
 
 ## 语法
 
-```sh
+```shell
 tiup mirror rotate [flags]
 ```
 

tiup/tiup-command-mirror-set.md

@@ -10,7 +10,7 @@ title: tiup mirror set
 
 ## 语法
 
-```sh
+```shell
 tiup mirror set <mirror-addr> [flags]
 ```
 

tiup/tiup-command-mirror-sign.md

@@ -8,7 +8,7 @@ title: tiup mirror sign
 
 ## 语法
 
-```sh
+```shell
 tiup mirror sign <manifest-file> [flags]
 ```
 

tiup/tiup-command-mirror.md

@@ -13,7 +13,7 @@ title: tiup mirror
 
 ## 语法
 
-```sh
+```shell
 tiup mirror <command> [flags]
 ```
 
@@ -33,5 +33,5 @@ tiup mirror <command> [flags]
 - [publish](/tiup/tiup-command-mirror-publish.md): 向当前镜像推送新的组件
 - [modify](/tiup/tiup-command-mirror-modify.md): 修改当前镜像中的组件属性
 - [rotate](/tiup/tiup-command-mirror-rotate.md): 更新当前镜像中的根证书
-- [clone](/tiup/tiup-command-mirror-rotate.md): 从已有镜像克隆一个新的镜像
+- [clone](/tiup/tiup-command-mirror-clone.md): 从已有镜像克隆一个新的镜像
 - [merge](/tiup/tiup-command-mirror-merge.md): 合并镜像

tiup/tiup-command-status.md

@@ -15,7 +15,7 @@ title: tiup status
 
 ## 语法
 
-```sh
+```shell
 tiup status [flags]
 ```