Merge branch 'master' into fix_doc

i5ting · Feb 12, 2019 · 2df736f · 2df736f
2 parents 88f39ee + f0c3c35
commit 2df736f
Show file tree

Hide file tree

Showing 6 changed files with 1,071 additions and 50 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -6,50 +6,114 @@ module.exports = {
     '/': {
       lang: 'zh-CN',
       title: 'Midway',
-      description: '面向未来的 Web 全栈应用开发框架'
+      description: '面向未来的 Web 全栈应用开发框架',
+    },
+    '/en/': {
+      lang: 'en-US',
+      title: 'Midway',
+      description: 'Future oriented full-stack web framework',
     },
   },
   themeConfig: {
-    lang: 'zh-CN',
-    title: 'Midway',
-    description: '面向未来的 Web 全栈应用开发框架',
-    repo: 'midwayjs/midway',
-    docsDir: 'docs',
-    editLinks: true,
-    serviceWorker: {
-      updatePopup: true
-    },
-    nav: [
-      { text: '首页', link: '/' },
-      { text: '使用文档', link: '/guide' },
-      { text: '依赖注入手册', link: '/ioc' },
-      { text: '工具集', link: '/tool_set' },
-      { text: 'TS 新手指南', link: '/ts_start' },
-      { text: 'API', link: 'http://www.midwayjs.org/midway/api-reference/globals.html' },
-      {
-        text: 'MidwayJs 系列产品',
-        items: [
+    locales: {
+      '/': {
+        lang: 'zh-CN',
+        title: 'Midway',
+        description: '面向未来的 Web 全栈应用开发框架',
+        repo: 'midwayjs/midway',
+        docsDir: 'docs',
+        editLinks: true,
+        serviceWorker: {
+          updatePopup: true,
+        },
+        nav: [
+          { text: '首页', link: '/' },
+          { text: '使用文档', link: '/guide' },
+          { text: '依赖注入手册', link: '/ioc' },
+          { text: '工具集', link: '/tool_set' },
+          { text: 'TS 新手指南', link: '/ts_start' },
           {
-            text: '框架',
-            items: [
-              { text: 'Midway - 面向未来的 Web 全栈框架', link: '/' },
-            ]
+            text: 'API',
+            link: 'http://www.midwayjs.org/midway/api-reference/globals.html',
           },
           {
-            text: '应用管理',
+            text: 'MidwayJs 系列产品',
             items: [
-              { text: 'Pandora.js - Node.js 应用管理器', link: 'http://midwayjs.org/pandora/' },
-            ]
+              {
+                text: '框架',
+                items: [
+                  { text: 'Midway - 面向未来的 Web 全栈框架', link: '/' },
+                ],
+              },
+              {
+                text: '应用管理',
+                items: [
+                  {
+                    text: 'Pandora.js - Node.js 应用管理器',
+                    link: 'http://midwayjs.org/pandora/',
+                  },
+                ],
+              },
+              {
+                text: '监控产品',
+                items: [
+                  { text: 'Sandbox - 私有化 Node.js 监控产品', link: '#' },
+                ],
+              },
+            ],
           },
+        ],
+      },
+      '/en/': {
+        lang: 'en-US',
+        title: 'Midway',
+        description: 'Future oriented full-stack Web framework',
+        repo: 'midwayjs/midway',
+        docsDir: 'docs',
+        editLinks: true,
+        serviceWorker: {
+          updatePopup: true,
+        },
+        nav: [
+          { text: 'Home', link: '/en/' },
+          { text: 'Guide', link: '/en/guide' },
+          { text: 'IoC', link: '/en/ioc' },
+          { text: 'Toolkit', link: '/en/tool_set' },
+          { text: 'TS Guide', link: '/en/ts_start' },
           {
-            text: '监控产品',
+            text: 'API',
+            link: 'http://www.midwayjs.org/midway/api-reference/globals.html',
+          },
+          {
+            text: 'MidwayJs Team',
             items: [
-              { text: 'Sandbox - 私有化 Node.js 监控产品', link: '#' },
-            ]
-          }
-        ]
-      }
-    ]
+              {
+                text: 'Framework',
+                items: [
+                  {
+                    text: 'Midway - Future oriented Web framework',
+                    link: '/en/',
+                  },
+                ],
+              },
+              {
+                text: 'Application Manger',
+                items: [
+                  {
+                    text: 'Pandora.js - Node.js Application Manager',
+                    link: 'http://midwayjs.org/pandora/',
+                  },
+                ],
+              },
+              {
+                text: 'Monitoring',
+                items: [{ text: 'Sandbox - Private Node.js APM', link: '#' }],
+              },
+            ],
+          },
+        ],
+      },
+    },
   },
   lastUpdated: 'Last Updated',
 };
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -1,24 +1,19 @@
 ---
-layout: homeLayout
 home: true
 heroImage: https://img.alicdn.com/tfs/TB1k4.laW6qK1RjSZFmXXX0PFXa-237-237.png
-actionText: Quick Guide →
+actionText: Quickly Start →
 actionLink: /en/guide
-features:
-- title: Simplicity First
-  details: Using IOC to manage application dependencies helps maximize the maintainability and scalability of the application in web development, and developers do not need to focus on Object creation.
-- title: Future-oriented
-  details: Enjoy the development experience of typescript, by decorator and dependency injection, make application development smooth and natural, and focus on encoding.
-- title: Embrace community
-  details: The Koa middleware and various eggjs plug-ins make it easy for users to get started and migrate quickly, and reduce development and deployment costs.
-footer: MIT Licensed | Copyright © 2018-present MidwayJs
+footer: Copyright © 2018-present MidwayJs
 ---
 
 ```bash
-# install
+# Install toolkit
 npm install -g midway-init
+# Init a project
 midway-init
+# Install dependences
 npm install
+# Run the application
 npm run dev
 ```
 
@@ -73,9 +68,9 @@ midway requires Node.js >= 8.
   <div class="col">
     <dl>
       <dt>Common Links</dt>
-      <dd><a href="http://opensource.alibaba.com/" target="_blank">Alibaba 开源平台</a></dd>
-      <dd><a href="http://taobaofed.org/" target="_blank">Taobao FED 团队博客</a></dd>
-      <dd><a href="http://www.typescriptlang.org/" target="_blank">TypeScript</a></dd>
+      <dd><a href="http://opensource.alibaba.com/" target="_blank">Alibaba Open Source</a></dd>
+      <dd><a href="http://taobaofed.org/" target="_blank">Taobao FED Blog</a></dd>
+      <dd><a href="http://www.typescriptlang.org/" target="_blank">TypeScript office site</a></dd>
     </dl>
   </div>
   <div class="col right">

diff --git a/docs/en/guide.md b/docs/en/guide.md
@@ -1,5 +1,6 @@
 ---
 nav: default
+sidebar: auto
 ---
 
 # Midway Development Guide
@@ -8,7 +9,7 @@ nav: default
 
 Since 2013, Midway has kept upgrading almost every year, from Express to Koa1/2 without absence of trend.
 
-Nowadays, Node.js goes ahead of the simple single-page application, not only in the Alibaba Group but also the Community, and go toward to the full-stack. With this trending, the MidwayJs Team come with the responsibility of supporting the Alibaba Group's Node.js Applications, and we also provide tools like `Pandora.js`, `Sandbox` to help Applications become more stable and reliable.
+Nowadays, Node.js goes ahead of the simple single-page application, not only in the Alibaba Group but also the Community, and go toward to the full-stack. With this trending, the MidwayJs Team come with the responsibility of supporting the Alibaba Group's Node.js Applications, and we also provide tools like [`Pandora.js`](https://midwayjs.org/pandora/), [`Sandbox`](https://github.com/midwayjs/sandbox) to help Applications become more stable and reliable.
 
 During 2017, we upgraded the Midway core to Koa2 to support async/await by Midway v5.3 inside the Alibaba Group.
 ''
@@ -26,7 +27,7 @@ The Midway is a full-stack development solution which developed by the frontend
 
 ### Install Node.js
 
-Visit the office website of Node.js or using the tools like nvm.
+To download from the [office website](https://nodejs.org/en/) of Node.js or using the tools like [nvm](https://github.com/creationix/nvm).
 
 ### New project