docs: improve guide docs

geist-org · Mar 30, 2020 · cf9622a · cf9622a
1 parent 8bdde36
commit cf9622a
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 15 deletions.
diff --git a/docs/en-us/customization/icons.md b/docs/en-us/customization/icons.md
@@ -14,7 +14,7 @@ You need to install <zi-code>@zeit-ui/icons</zi-code> if you want to use any ico
   1. Install package: <zi-code>yarn add @zeit-ui/vue-icons</zi-code>
 
   2. Import to Vue:
-  ```vue
+  ```js
   import { install } from '@zeit-ui/vue-icons'
   import Vue from 'vue'
 
@@ -24,7 +24,7 @@ You need to install <zi-code>@zeit-ui/icons</zi-code> if you want to use any ico
   3. Try use icon component:
   ```html
   <template>
-    <zicon-apple/>
+    <apple-icon/>
   </template>
   ```
 

diff --git a/docs/en-us/getting-started/installation.md b/docs/en-us/getting-started/installation.md
@@ -5,8 +5,8 @@
 <br/>
 
 <zi-note>
-Ensure your have the latest version of <zi-link href="https://nodejs.org/en/download/">NodeJS</zi-link>,
-and also need a package manager of NodeJS: <zi-link href="https://www.npmjs.com/">NPM</zi-link> or <zi-link href="https://yarnpkg.com/">Yarn</zi-link>.
+Ensure your have the latest version of <zi-link pure href="https://nodejs.org/en/download/">NodeJS</zi-link>,
+and a package manager: <zi-link pure href="https://www.npmjs.com/">NPM</zi-link> or <zi-link pure href="https://yarnpkg.com/">Yarn</zi-link>.
 </zi-note>
 
 <br/>
@@ -37,12 +37,13 @@ Get the latest version from unpkg.com:
 
 You can also refer to [Example with UMD](https://github.com/zeit-ui/vue/blob/master/examples/umd/index.html)
 
+
 <br>
 <br>
 
 ### Import a component
 
-`@zeit-ui/vue` supports import components when you actually need. e.g.:
+`@zeit-ui/vue` supports import components when you actually need:
 
 ```js
 import Vue from 'vue'

diff --git a/docs/en-us/getting-started/introduction.md b/docs/en-us/getting-started/introduction.md
@@ -2,17 +2,20 @@
 
 ### Why @zeit-ui/vue
 
-`@zeit-ui/vue` is a Vue implementation for [zeit style](https://github.com/zeit-ui/zeit-style), originating from [Zeit Design](https://zeit.co/design).
-Lean more at [GITHUB](https://github.com/zeit-ui/vue).
+`@zeit-ui/vue` is a Vue implementation for <zi-link pure href="https://github.com/zeit-ui/zeit-style">Styles</zi-link>,
+originating from <zi-link pure href="https://zeit.co/design">ZEIT Design</zi-link>.
 
-The design of the Zeit is concise and aesthetic feeling, this is an important reason for popular of Zeit.
-Now you can use them through the `@zeit-ui/vue`.
+The design of the ZEIT is concise and aesthetic feeling, this is an important reason for popular of ZEIT.
+Now you can use them at will in Vue.
+
+ZEIT UI is an unofficial organization, all our projects are open source.
 
 <br>
 
 
 ### Contact
 
+- [Chat on Spectrum](https://spectrum.chat/zeit-ui/vue?tab=posts)
 - [Report an issue](https://github.com/zeit-ui/vue/issues/new)
 - Welcome share your feedback and ideas. We also love PRs.
 

diff --git a/docs/zh-cn/customization/icons.md b/docs/zh-cn/customization/icons.md
@@ -24,7 +24,7 @@
   3. 随后尝试直接使用组件：
   ```html
   <template>
-    <zicon-apple/>
+    <apple-icon/>
   </template>
   ```
 

diff --git a/docs/zh-cn/getting-started/installation.md b/docs/zh-cn/getting-started/installation.md
@@ -5,8 +5,8 @@
 <br/>
 
 <zi-note>
-请确定你的 <zi-link href="https://nodejs.org/en/download/">NodeJS</zi-link> 处于最新版本，
-同时你还需要准备 NodeJS 的包管理器: <zi-link href="https://www.npmjs.com/">NPM</zi-link> 或是 <zi-link href="https://yarnpkg.com/">Yarn</zi-link>.
+请确定你的 <zi-link pure href="https://nodejs.org/en/download/">NodeJS</zi-link> 处于最新版本，
+同时你还需要准备包管理器: <zi-link pure href="https://www.npmjs.com/">NPM</zi-link> 或是 <zi-link pure href="https://yarnpkg.com/">Yarn</zi-link>.
 </zi-note>
 
 <br/>

diff --git a/docs/zh-cn/getting-started/introduction.md b/docs/zh-cn/getting-started/introduction.md
@@ -2,16 +2,20 @@
 
 ### 什么是 ZEIT UI - VUE
 
-`@zeit-ui/vue` 是针对 [ZEIT 样式库](https://github.com/zeit-ui/zeit-style) 的一个 Vue 版本实现, 灵感来自于 [ZEIT 的设计稿](https://zeit.co/design).
-你可以在 [GITHUB](https://github.com/zeit-ui/vue) 上了解此项目的详细信息.
+`@zeit-ui/vue` 是针对 <zi-link pure href="https://github.com/zeit-ui/zeit-style">ZEIT 样式库</zi-link> 的一个 Vue 版本实现,
+灵感来自于 <zi-link pure href="https://zeit.co/design">ZEIT 的设计稿</zi-link>.
+
+ZEIT 的设计非常简洁美观，且有浓厚的 Geek 风格，这是 ZEIT 如此受欢迎的重要原因，现在你可以在 Vue 中随意使用所有设计元素。
+
+**ZEIT UI** 是非官方的组织，且所有项目都是开源的。
 
-ZEIT 的设计非常简洁美观，且有浓厚的 Geek 风格，这是 ZEIT 如此受欢迎的重要原因，现在你可以在 `@zeit-ui/vue` 中无缝的使用所有设计元素。
 
 <br>
 
 
 ### 联系我们
 
+- [在 Spectrum 上聊天](https://spectrum.chat/zeit-ui/vue?tab=posts)
 - [报告问题](https://github.com/zeit-ui/vue/issues/new)
 - 我们非常欢迎来自任何人有趣的想法或反馈，也欢迎你贡献代码。