docs: add english document

ly525
1 parent 2f1132b4
Showing 3 changed files with 27 additions and 12 deletions
README.en.md
docs/.vuepress/config.js
front-end/h5/src/components/common/header/links.js
-English | [简体中文](./README.md)
+[Online English Document](https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us) | [简体中文](./README.md)
+
+
+<p align="left">
+<a href="https://github.com/ly525/luban-h5/releases"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/ly525/luban-h5"></a>
+</p>
+
 ### What's LuBan-H5?
-> LuBan-H5 is a mobile page builder based on Vue.js, which is similar with http://www.eqxiu.com、[Baidu-H5](https://h5.bce.baidu.com/). It also supports parsing PSD file to HMTL5 Page
+> LuBan-H5 is a mobile page builder based on Vue.js, which is similar with [Amolink](www.amolink.com) [eqx](http://www.eqxiu.com)(it's a chinese website, you may need to translate the page). It also supports parsing PSD file to HMTL5 Page
 ### Screenshots
-![image](https://user-images.githubusercontent.com/12668546/61186568-974b1c80-a699-11e9-831b-a87a506699b9.png)
+<img src="https://user-images.githubusercontent.com/12668546/64076899-3df88480-ccfd-11e9-877b-8e6a86888da3.png" style="margin: 10px;" width="60%" />
+<img src="https://user-images.githubusercontent.com/12668546/64076911-6d0ef600-ccfd-11e9-9376-e65a42478853.png" style="margin: 10px;" width="60%" />
+<img src="https://user-gold-cdn.xitu.io/2019/8/17/16ca02d61136ed30?imageslim" style="margin: 10px;" width="60%" />
+<img src="https://user-images.githubusercontent.com/12668546/63207252-4f367400-c0f5-11e9-952a-9a3f6f72a710.png" style="margin: 10px;" width="60%"/>
+
-###Features 功能
+### Features
 1. Editor
     - [x] Reference Line/GuideLine
     - [x] Adsorption Line
@@ -49,9 +59,7 @@ English | [简体中文](./README.md)
 ### Installs
 > proj: project root path
-
-  1. Front End
-      Editor: please refer to: [`project/front-end/h5/README.md`](https://github.com/ly525/luban-h5/blob/dev/front-end/h5/README.md)
+please refer to: [`Document/Quick Start`](https://www.yuque.com/liuyan-ew1qk/oh5d0n/gpfy6g)
 ---
@@ -60,7 +68,10 @@ English | [简体中文](./README.md)
 1. `lbp-`: `lu-ban-plugin-`, means `Luban H5 plugin`, location: `proj/front-end/h5/src/components/plugins`
-#### Technology Stack (current)
+#### Build With (current)
   1. Front end: Vue.js
   2. Back End: Strapi
-  3. Storage: Sqlite
 \ No newline at end of file
+  3. Storage: Sqlite
+
+
+Read more here [Online English Document](https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us)
 \ No newline at end of file
@@ -74,6 +74,7 @@ module.exports = {
   // ga: '',
   themeConfig: {
     nav: [
+      { text: 'Document(En)', link: 'https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us' },
       { text: 'Website', link: 'https://ly525.github.io/luban-h5' },
     ],
     versions: [
@@ -12,9 +12,6 @@ export default {
         defaultSelectedKeys={['2']}
         style={{ lineHeight: '64px', display: 'inline-block', float: 'right' }}
       >
-        <a-menu-item key="document">
-          <a href="https://ly525.github.io/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />文档</a>
-        </a-menu-item>
         <a-menu-item key="dingtalk" >
           <a-popover title="👨🏻‍💻👩🏻‍💻欢迎加入鲁班-H5交流群">
             <template slot="content">
@@ -26,6 +23,12 @@ export default {
             <span style={{ color: 'white', lineHeight: '64px', height: '64px', display: 'inline-block' }}><a-icon type="qrcode" />交流群</span>
           </a-popover>
         </a-menu-item>
+        <a-menu-item key="document">
+          <a href="https://ly525.github.io/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />文档</a>
+        </a-menu-item>
+        <a-menu-item key="document-en">
+          <a href="https://www.yuque.com/liuyan-ew1qk/oh5d0n?language=en-us" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="read" />Document(En)</a>
+        </a-menu-item>
         <a-menu-item key="github">
           <a href="https://github.com/ly525/luban-h5" target="_blank" rel="noopener" style={{ color: 'white' }}><a-icon type="github" />Github</a>
         </a-menu-item>