fix: merge main format md

.github/ISSUE_TEMPLATE/---------.md

@@ -1,13 +1,10 @@
 ---
 name: 产品功能需求及建议
 about: 提供新功能的建议
-
 ---
 
 **您提出的功能是否和您遇到的问题有关，请描述该问题**
 
-
 **您是否有建议的实现方案**
 
-
 **其它帮助我们理解您需求的描述、截图**

.github/ISSUE_TEMPLATE/bug--.md

@@ -1,25 +1,18 @@
 ---
 name: Bug反馈
 about: 为了更快速的定位您的问题，请提供详细的BUG描述。
-
 ---
 
-**BUG描述**
-
+**BUG 描述**
 
 **复现步骤**
 
-
 **期望结果**
 
-
 **实际结果**
 
-
 **截图**
 
-
 **环境**
 
-
 **附加信息**

.prettierignore

@@ -23,6 +23,7 @@ packages/vantui/es
 packages/vantui-doc/lib
 packages/vantui-doc/es
 packages/vantui-doc/dist
+packages/vantui-doc/site
 packages/vantui/src/style/components/iconfont.less
 packages/vantui-demo/weapp
 packages/vantui-demo/alipay

README.md

@@ -7,6 +7,7 @@
 </div>
 
 ### 相关链接
+
 - [Vant Weapp](https://github.com/youzan/vant-weapp)：由有赞团队打造的轻量、可靠的微信小程序 UI 组件库
 - [Taro](https://github.com/NervJS/taro)：由京东团队打造的开放式跨端跨框架解决方案，支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用
 
@@ -24,7 +25,7 @@
 
 - 使用 TypeScript 编写，提供完整的类型定义
 
-- 支持 Taro(H5、微信小程序、支付宝小程序、抖音小程序...)(注：React Native不支持)
+- 支持 Taro(H5、微信小程序、支付宝小程序、抖音小程序...)(注：React Native 不支持)
 
 - 支持 React(webpack 兼容配置我们后续会统一起来，方便大家使用)
 
@@ -38,17 +39,16 @@
 
 ### 为什么你可以放心用
 
-- 整个组件库是依赖开源项目Vant Weapp的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持React，很大程度避免了重新造轮子带来的各种问题，同时保留了Vant Weapp多年积累的经验。
-
+- 整个组件库是依赖开源项目 Vant Weapp 的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持 React，很大程度避免了重新造轮子带来的各种问题，同时保留了 Vant Weapp 多年积累的经验。
 
-> 如果觉得不错，麻烦给个Star哦
+> 如果觉得不错，麻烦给个 Star 哦
 
-> 收到了一些反馈，这里说明一下吧。关于demo的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了50多个组件要维护，还有Taro Demo和React Demo和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！
+> 收到了一些反馈，这里说明一下吧。关于 demo 的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了 50 多个组件要维护，还有 Taro Demo 和 React Demo 和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！
 
 ### 学习链接
 
-* [github文档](https://antmjs.github.io/vantui/#/home)
-* [gitee文档](https://antm-js.gitee.io/vantui/#/home)
+- [github 文档](https://antmjs.github.io/vantui/#/home)
+- [gitee 文档](https://antm-js.gitee.io/vantui/#/home)
 
 ### 预览
 
@@ -57,28 +57,29 @@
 
 ### 贡献代码
 
-使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对vant-weapp的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了2022-03-27的版本，我们也会持续同步
+使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对 vant-weapp 的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了 2022-03-27 的版本，我们也会持续同步
 
 ### 开源协议
 
 本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源
 
 ### 参与共建
 
-首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。
+首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM 团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。
 
 ### 特别声明
-* 该组件库并不是一个新的轮子，我们只是得益于有赞团队在vant-weapp的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以Taro/React的方式进行开发接入。
 
-* 我们是vant-weapp的锦上添花版本，在此还是需要感谢Taro团队以及有赞团队为社区所作出的贡献。
+- 该组件库并不是一个新的轮子，我们只是得益于有赞团队在 vant-weapp 的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以 Taro/React 的方式进行开发接入。
+
+- 我们是 vant-weapp 的锦上添花版本，在此还是需要感谢 Taro 团队以及有赞团队为社区所作出的贡献。
 
-* Logo暂时还未获得使用许可，如有侵权，请及时联系我们。
+- Logo 暂时还未获得使用许可，如有侵权，请及时联系我们。
 
 ### 以下是 @antmjs/vantui 的核心贡献者们
 
-[![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/)
-:---:|:---:|:---:|:---:
-[hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/)
+| [![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) |
+| :-------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: |
+|                                [hisanshao](https://github.com/hisanshao/)                                 |                                [Chitanda60](https://github.com/Chitanda60/)                                 |                               [Banlangenn](https://github.com/Banlangenn/)                               |                                 [zuolung](https://github.com/zuolung/)                                  |
 
 ### 贡献者们
 

packages/vantui-demo/README.md

@@ -1,13 +1,13 @@
-## Taro快速开发模版
+## Taro 快速开发模版
 
 ### 选型
 
 Taro + React + Less
 
 ### 特性
 
-- 非UI全局缓存能力
-- UI全局缓存能力
+- 非 UI 全局缓存能力
+- UI 全局缓存能力
 
 ### 规范
 
@@ -20,7 +20,6 @@ Commitlint + Husky + lint-staged + Prettier + Eslint + Stylelint + TSC
 
 Prettier - Code formatter + Eslint + stylelint
 
-
 ### 工程使用
 
 git clone [email protected]:AntmJS/temptaro.git
@@ -47,23 +46,23 @@ project.weapp.json - projectname description
 
 project.tt.json - projectname description
 
-package.json - name description appId(环境对应API_ENV) Taro版本
+package.json - name description appId(环境对应 API_ENV) Taro 版本
 
 config/index.js - projectName date h5.webpackChain.publicPath
 
 src/app.config.ts - window.navigationBarTitleText
 
-src/utils/request/innerRequest/index.ts - statusCode为200的判断依据返回是否和约定一致，其他均为失败
+src/utils/request/innerRequest/index.ts - statusCode 为 200 的判断依据返回是否和约定一致，其他均为失败
 
-src/components/container.tsx - MiniBar的homeUrl
+src/components/container.tsx - MiniBar 的 homeUrl
 
 ### 注意事项
 
 - 路径引用可以使用 '@/xxx'
-- 主题可以放在src/style/index.less下面
+- 主题可以放在 src/style/index.less 下面
 - API_ENV: stable real pre dev
 
-### 执行顺序 useDidShow 优先于useEffect执行
+### 执行顺序 useDidShow 优先于 useEffect 执行
 
 - app show
 - app launch
@@ -97,7 +96,7 @@ src/components/container.tsx - MiniBar的homeUrl
 
 - hack Taro API
 - Boundary Error
-- request loading error 结合React
+- request loading error 结合 React
 - theme
 - action ts
-- 分页快速模版
+- 分页快速模版

packages/vantui-doc/docs/comments.md

@@ -1,16 +1,20 @@
-## ts同步到文档说明
+## ts 同步到文档说明
+
+### vantui-doc 下执行同步命令
+
+将 vantui/types 中 d.ts 的类型描述转换为文档中的 API props
 
-### vantui-doc下执行同步命令
-将vantui/types中d.ts的类型描述转换为文档中的API props
 ```bash
 yarn docs-ts
 ```
 
-### ts中注释
-- 只转换export的属性
-- 导出类型的注释描述只支持@title和@description
-- 属性类型的注释描述只支持@default和@description
-- 转换后文档的组件API说明 展示的顺序和ts的export的顺序一致，所以d.ts中组件参数的export尽量放在最开始
+### ts 中注释
+
+- 只转换 export 的属性
+- 导出类型的注释描述只支持@title 和@description
+- 属性类型的注释描述只支持@default 和@description
+- 转换后文档的组件 API 说明 展示的顺序和 ts 的 export 的顺序一致，所以 d.ts 中组件参数的 export 尽量放在最开始
+
 ```ts
 /**
  * @title 组件实例
@@ -23,4 +27,4 @@ export type xxProps = {
    */
   xxvalue?: string
 }
-```
+```

packages/vantui-doc/docs/custom-style.md

@@ -2,7 +2,7 @@
 
 ### 样式类覆盖
 
-得益于Taro3的实现，我们无需再关注小程序的样式隔离问题，所以我们可以常规使用样式覆盖
+得益于 Taro3 的实现，我们无需再关注小程序的样式隔离问题，所以我们可以常规使用样式覆盖
 
 ```jsx
 <Button type="primary">主要按钮</Button>

packages/vantui-doc/docs/home.md

@@ -7,6 +7,7 @@
 </div>
 
 ### 相关链接
+
 - [Vant Weapp](https://github.com/youzan/vant-weapp)：由有赞团队打造的轻量、可靠的微信小程序 UI 组件库
 - [Taro](https://github.com/NervJS/taro)：由京东团队打造的开放式跨端跨框架解决方案，支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用
 
@@ -38,17 +39,16 @@
 
 ### 为什么你可以放心用
 
-整个组件库是依赖开源项目Vant Weapp的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持React，很大程度避免了重新造轮子带来的各种问题，同时保留了Vant Weapp多年积累的经验。
-
+整个组件库是依赖开源项目 Vant Weapp 的代码经过全量编译而来，所有样式文件及代码结构都与其保持高度一致，只是生命周期经过改造使其支持 React，很大程度避免了重新造轮子带来的各种问题，同时保留了 Vant Weapp 多年积累的经验。
 
-> 如果觉得不错，麻烦给个Star哦
+> 如果觉得不错，麻烦给个 Star 哦
 
-> 收到了一些反馈，这里说明一下吧。关于demo的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了50多个组件要维护，还有Taro Demo和React Demo和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！
+> 收到了一些反馈，这里说明一下吧。关于 demo 的质量和文档现在确实是有一些不足的地方的，因为做这件事的人并不多暂时，我们把更多的精力放在了组件本身，确保大家在实际的应用中能够更少的被中断。目前除了 50 多个组件要维护，还有 Taro Demo 和 React Demo 和文档，同时公司也有业务要跟进，所以希望大家能够体谅，当然非常欢迎有兴趣的人一起来完善它！
 
 ### 学习链接
 
-* [github文档](https://antmjs.github.io/vantui/#/home)
-* [gitee文档](https://antm-js.gitee.io/vantui/#/home)
+- [github 文档](https://antmjs.github.io/vantui/#/home)
+- [gitee 文档](https://antm-js.gitee.io/vantui/#/home)
 
 ### 预览
 
@@ -57,28 +57,29 @@
 
 ### 贡献代码
 
-使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对vant-weapp的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了2022-03-27的版本，我们也会持续同步
+使用过程中发现任何问题都可以提 [Issue](https://github.com/antmjs/vantui/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/antmjs/vantui/pulls)，同时，到目前为止我们已经对 vant-weapp 的[commit](https://github.com/youzan/vant-weapp/commits/dev)记录同步到了 2022-03-27 的版本，我们也会持续同步
 
 ### 开源协议
 
 本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源
 
 ### 参与共建
 
-首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。
+首发阵容来自小电科技创新事业部前端团队，我们希望在开源领域能够让大家一起来参与，所以我们重新命名了团队名称“AntM 团队”，寓意是打造小而实用的工具提高工作效率，同时欢迎有兴趣一起共建的小伙伴能够加入这个团队，人多力量大。
 
 ### 特别声明
-* 该组件库并不是一个新的轮子，我们只是得益于有赞团队在vant-weapp的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以Taro/React的方式进行开发接入。
 
-* 我们是vant-weapp的锦上添花版本，在此还是需要感谢Taro团队以及有赞团队为社区所作出的贡献。
+- 该组件库并不是一个新的轮子，我们只是得益于有赞团队在 vant-weapp 的多年实践、积累、沉淀上做了一些简单的扩展，让它可以以 Taro/React 的方式进行开发接入。
+
+- 我们是 vant-weapp 的锦上添花版本，在此还是需要感谢 Taro 团队以及有赞团队为社区所作出的贡献。
 
-* Logo暂时还未获得使用许可，如有侵权，请及时联系我们。
+- Logo 暂时还未获得使用许可，如有侵权，请及时联系我们。
 
 ### 以下是 @antmjs/vantui 的核心贡献者们
 
-[![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/)
-:---:|:---:|:---:|:---:
-[hisanshao](https://github.com/hisanshao/) | [Chitanda60](https://github.com/Chitanda60/) | [Banlangenn](https://github.com/Banlangenn/) | [zuolung](https://github.com/zuolung/)
+| [![hisanshao](https://avatars.githubusercontent.com/u/26359618?s=100&v=4)](https://github.com/hisanshao/) | [![Chitanda60](https://avatars.githubusercontent.com/u/16026533?s=100&v=4)](https://github.com/Chitanda60/) | [![zuolung](https://avatars.githubusercontent.com/u/19684540?s=100&v=4)](https://github.com/Banlangenn/) | [![hisanshao](https://avatars.githubusercontent.com/u/28145148?s=100&v=4)](https://github.com/zuolung/) |
+| :-------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: |
+|                                [hisanshao](https://github.com/hisanshao/)                                 |                                [Chitanda60](https://github.com/Chitanda60/)                                 |                               [Banlangenn](https://github.com/Banlangenn/)                               |                                 [zuolung](https://github.com/zuolung/)                                  |
 
 ### 贡献者们