docs: update readme

varletjs · Apr 25, 2021 · bc19bbb · bc19bbb
1 parent 3cc20cd
commit bc19bbb
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 56 deletions.
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -1,34 +1,31 @@
 <div align="center">
   <a href="https://varlet.gitee.io/varlet-ui/">
-   <img src="https://varlet.gitee.io/varlet-ui/varlet_icon.png" width="201" style="display: block; margin-bottom: 10px;">
+    <img  src="https://varlet.gitee.io/varlet-ui/varlet_icon.png" width="201">
   </a>
-  <div style="font-size: 32px; margin-top: 10px; text-align: center">VARLET</div>
-  <div style="color: #888; font-size: 14px; margin-top: 10px; text-align: center">
-    面向Vue3的Material风格移动端组件库
-  </div>
+  <h2>VARLET</h2>
+  <div>面向Vue3的Material风格移动端组件库</div>
 </div>
-
 ---
 
 ### 介绍
 
 Varlet是一个基于`Vue3`开发的Material风格移动端组件库，全面拥抱`Vue3`生态，由社区几个不知天高地厚的小伙伴开发和维护。
 
 ### 特性
-- 1.提供40多个高质量通用组件
-- 2.组件十分轻量
-- 3.由国人开发，完善的中英文文档和后勤保障
-- 4.支持按需引入
-- 5.支持主题定制
-- 6.支持国际化
-- 7.支持webstorm，vscode组件属性高亮
-- 8.支持SSR
-- 9.支持Typescript
+1. 提供40多个高质量通用组件
+2. 组件十分轻量
+3. 由国人开发，完善的中英文文档和后勤保障
+4. 支持按需引入
+5. 支持主题定制
+6. 支持国际化
+7. 支持webstorm，vscode组件属性高亮
+8. 支持SSR
+9. 支持Typescript
 
 ### 安装
 
 ### CDN
-`varlet.js`包含组件库的所有样式和逻辑, 引入即可。
+`varlet.js`包含组件库的所有样式和逻辑，引入即可。
 
 ```html
 <div id="app"></div>

diff --git a/developerGuide.md b/developerGuide.md
@@ -14,7 +14,7 @@ yarn dev
 ```
 
 ### Todo list
-- 1.Provides `jsx`,`tsx` syntax highlighting support.
-- 2.Improve the document reading experience and fix problems.
-- 3.Unit test all components and issue test report.
-- 4.Full component style detail optimization, animation curve optimization.
+1. Provides `jsx`,`tsx` syntax highlighting support.
+2. Improve the document reading experience and fix problems.
+3. Unit test all components and issue test report.
+4. Full component style detail optimization, animation curve optimization.
diff --git a/developerGuide.zh-CN.md b/developerGuide.zh-CN.md
@@ -14,7 +14,7 @@ yarn dev
 ```
 
 ### Todo list
-- 1.提供`jsx`、`tsx`语法高亮支持。
-- 2.完善文档阅读体验，修复存在的问题。
-- 3.全组件单元测试，并出测试报告。
-- 4.全组件样式细节优化，动画曲线优化。
+1. 提供`jsx`、`tsx`语法高亮支持。
+2. 完善文档阅读体验，修复存在的问题。
+3. 全组件单元测试，并出测试报告。
+4. 全组件样式细节优化，动画曲线优化。
diff --git a/packages/varlet-eslint-config/README.md b/packages/varlet-eslint-config/README.md
@@ -2,8 +2,8 @@
 varlet eslint 配置文件
 ## 快速上手
 ```
-npm安装:npm i eslint @varlet/eslint-config -D
-yarn安装:yarn add eslint @varlet/eslint-config -D
+npm安装：npm i eslint @varlet/eslint-config -D
+yarn安装：yarn add eslint @varlet/eslint-config -D
 ```
 
 ```

diff --git a/packages/varlet-ui/README.md b/packages/varlet-ui/README.md
@@ -1,29 +1,27 @@
 <div align="center">
   <a href="https://varlet.gitee.io/varlet-ui/">
-    <img  src="https://varlet.gitee.io/varlet-ui/varlet_icon.png" width="201" style="display: block; margin-bottom: 10px;">
+    <img  src="https://varlet.gitee.io/varlet-ui/varlet_icon.png" width="201">
   </a>
-  <div style="font-size: 32px; margin-top: 10px; text-align: center">VARLET</div>
-  <div style="color: #888; font-size: 14px; margin-top: 10px; text-align: center">
-    Material design mobile component library for Vue3
-  </div>
+  <h2>VARLET</h2>
+  <div>Material design mobile component library for Vue3</div>
 </div>
 
 ---
 
 ### Intro
 
-Varlet is a Material design mobile component library developed based on `Vue3`，Developed and maintained by partners in the community。
+Varlet is a Material design mobile component library developed based on `Vue3`, developed and maintained by partners in the community.
 
 ### Features
-- 1.Provide more than 40 high quality general purpose components
-- 2.Components are very lightweight
-- 3.Developed by Chinese, complete Chinese and English documentation and logistics support
-- 4.Support on-demand introduction
-- 5.Support theme customization
-- 6.Support internationalization
-- 7.Support WebStorm, VS Code component syntax highlighting
-- 8.Support the SSR
-- 9.Support the Typescript
+1. Provide more than 40 high quality general purpose components
+2. Components are very lightweight
+3. Developed by Chinese, complete Chinese and English documentation and logistics support
+4. Support on-demand introduction
+5. Support theme customization
+6. Support internationalization
+7. Support WebStorm, VS Code component syntax highlighting
+8. Support the SSR
+9. Support the Typescript
 
 ### Install
 

diff --git a/packages/varlet-ui/README.zh-CN.md b/packages/varlet-ui/README.zh-CN.md
@@ -1,11 +1,9 @@
 <div align="center">
   <a href="https://varlet.gitee.io/varlet-ui/">
-   <img src="https://varlet.gitee.io/varlet-ui/varlet_icon.png" width="201" style="display: block; margin-bottom: 10px;">
+    <img  src="https://varlet.gitee.io/varlet-ui/varlet_icon.png" width="201">
   </a>
-  <div style="font-size: 32px; margin-top: 10px; text-align: center">VARLET</div>
-  <div style="color: #888; font-size: 14px; margin-top: 10px; text-align: center">
-    面向Vue3的Material风格移动端组件库
-  </div>
+  <h2>VARLET</h2>
+  <div>面向Vue3的Material风格移动端组件库</div>
 </div>
 
 ---
@@ -15,20 +13,20 @@
 Varlet是一个基于`Vue3`开发的Material风格移动端组件库，全面拥抱`Vue3`生态，由社区几个不知天高地厚的小伙伴开发和维护。
 
 ### 特性
-- 1.提供40多个高质量通用组件
-- 2.组件十分轻量
-- 3.由国人开发，完善的中英文文档和后勤保障
-- 4.支持按需引入
-- 5.支持主题定制
-- 6.支持国际化
-- 7.支持webstorm，vscode组件属性高亮
-- 8.支持SSR
-- 9.支持Typescript
+1. 提供40多个高质量通用组件
+2. 组件十分轻量
+3. 由国人开发，完善的中英文文档和后勤保障
+4. 支持按需引入
+5. 支持主题定制
+6. 支持国际化
+7. 支持webstorm，vscode组件属性高亮
+8. 支持SSR
+9. 支持Typescript
 
 ### 安装
 
 ### CDN
-`varlet.js`包含组件库的所有样式和逻辑, 引入即可。
+`varlet.js`包含组件库的所有样式和逻辑，引入即可。
 
 ```html
 <div id="app"></div>