docs: reorganize nav

Author: yyx990803

docs/.vuepress/config.js

@@ -23,123 +23,131 @@ module.exports = {
         editLinkText: 'Edit this page on GitHub',
         nav: [
           {
-            text: 'Getting Started',
-            link: '/essentials/getting-started'
+            text: 'Guide',
+            link: '/guide/'
           },
           {
             text: 'API Reference',
-            link: '/api/options'
+            link: '/api/'
           },
           {
             text: 'Release Notes',
-            link: 'https://github.com/vuejs/vue-router/releasess'
+            link: 'https://github.com/vuejs/vue-router/releases'
           }
         ],
-        sidebar: [
-          '/installation.md',
-          '/',
-          {
-            title: 'Essentials',
-            collapsable: false,
-            children: [
-              '/essentials/getting-started.md',
-              '/essentials/dynamic-matching.md',
-              '/essentials/nested-routes.md',
-              '/essentials/navigation.md',
-              '/essentials/named-routes.md',
-              '/essentials/named-views.md',
-              '/essentials/redirect-and-alias.md',
-              '/essentials/passing-props.md',
-              '/essentials/history-mode.md'
-            ]
-          },
-          {
-            title: 'Advanced',
-            collapsable: false,
-            children: [
-              '/advanced/navigation-guards.md',
-              '/advanced/meta.md',
-              '/advanced/transitions.md',
-              '/advanced/data-fetching.md',
-              '/advanced/scroll-behavior.md',
-              '/advanced/lazy-loading.md'
-            ]
-          },
-          {
-            title: 'API Reference',
-            collapsable: false,
-            children: [
-              '/api/options.md',
-              '/api/router-instance.md',
-              '/api/route-object.md',
-              '/api/component-injections.md',
-              '/api/router-link.md',
-              '/api/router-view.md'
-            ]
-          }
-        ]
+        sidebar: {
+          '/api/': [
+            {
+              title: 'API Reference',
+              collapsable: false,
+              children: [
+                '/api/options.md',
+                '/api/router-instance.md',
+                '/api/route-object.md',
+                '/api/component-injections.md',
+                '/api/router-link.md',
+                '/api/router-view.md'
+              ]
+            }
+          ],
+          '/': [
+            '/installation.md',
+            '/',
+            {
+              title: 'Essentials',
+              collapsable: false,
+              children: [
+                '/guide/essentials/getting-started.md',
+                '/guide/essentials/dynamic-matching.md',
+                '/guide/essentials/nested-routes.md',
+                '/guide/essentials/navigation.md',
+                '/guide/essentials/named-routes.md',
+                '/guide/essentials/named-views.md',
+                '/guide/essentials/redirect-and-alias.md',
+                '/guide/essentials/passing-props.md',
+                '/guide/essentials/history-mode.md'
+              ]
+            },
+            {
+              title: 'Advanced',
+              collapsable: false,
+              children: [
+                '/guide/advanced/navigation-guards.md',
+                '/guide/advanced/meta.md',
+                '/guide/advanced/transitions.md',
+                '/guide/advanced/data-fetching.md',
+                '/guide/advanced/scroll-behavior.md',
+                '/guide/advanced/lazy-loading.md'
+              ]
+            }
+          ]
+        }
       },
       '/zh/': {
         label: '简体中文',
         selectText: '选择语言',
         editLinkText: '在 GitHub 上编辑此页',
         nav: [
           {
-            text: '起步',
-            link: '/zh/essentials/getting-started'
+            text: '指南',
+            link: '/zh/guide/'
           },
           {
             text: 'API 参考',
-            link: '/zh/api/options'
+            link: '/zh/api/'
           },
           {
             text: '更新记录',
-            link: 'https://github.com/vuejs/vue-router/releasess'
+            link: 'https://github.com/vuejs/vue-router/releases'
           }
         ],
-        sidebar: [
-          '/zh/installation.md',
-          '/zh/',
-          {
-            title: '基础',
-            collapsable: false,
-            children: [
-              '/zh/essentials/getting-started.md',
-              '/zh/essentials/dynamic-matching.md',
-              '/zh/essentials/nested-routes.md',
-              '/zh/essentials/navigation.md',
-              '/zh/essentials/named-routes.md',
-              '/zh/essentials/named-views.md',
-              '/zh/essentials/redirect-and-alias.md',
-              '/zh/essentials/passing-props.md',
-              '/zh/essentials/history-mode.md'
-            ]
-          },
-          {
-            title: '进阶',
-            collapsable: false,
-            children: [
-              '/zh/advanced/navigation-guards.md',
-              '/zh/advanced/meta.md',
-              '/zh/advanced/transitions.md',
-              '/zh/advanced/data-fetching.md',
-              '/zh/advanced/scroll-behavior.md',
-              '/zh/advanced/lazy-loading.md'
-            ]
-          },
-          {
-            title: 'API 参考',
-            collapsable: false,
-            children: [
-              '/zh/api/options.md',
-              '/zh/api/router-instance.md',
-              '/zh/api/route-object.md',
-              '/zh/api/component-injections.md',
-              '/zh/api/router-link.md',
-              '/zh/api/router-view.md'
-            ]
-          }
-        ]
+        sidebar: {
+          '/zh/api/': [
+            {
+              title: 'API 参考',
+              collapsable: false,
+              children: [
+                '/zh/api/options.md',
+                '/zh/api/router-instance.md',
+                '/zh/api/route-object.md',
+                '/zh/api/component-injections.md',
+                '/zh/api/router-link.md',
+                '/zh/api/router-view.md'
+              ]
+            }
+          ],
+          '/zh/': [
+            '/zh/installation.md',
+            '/zh/',
+            {
+              title: '基础',
+              collapsable: false,
+              children: [
+                '/zh/guide/essentials/getting-started.md',
+                '/zh/guide/essentials/dynamic-matching.md',
+                '/zh/guide/essentials/nested-routes.md',
+                '/zh/guide/essentials/navigation.md',
+                '/zh/guide/essentials/named-routes.md',
+                '/zh/guide/essentials/named-views.md',
+                '/zh/guide/essentials/redirect-and-alias.md',
+                '/zh/guide/essentials/passing-props.md',
+                '/zh/guide/essentials/history-mode.md'
+              ]
+            },
+            {
+              title: '进阶',
+              collapsable: false,
+              children: [
+                '/zh/guide/advanced/navigation-guards.md',
+                '/zh/guide/advanced/meta.md',
+                '/zh/guide/advanced/transitions.md',
+                '/zh/guide/advanced/data-fetching.md',
+                '/zh/guide/advanced/scroll-behavior.md',
+                '/zh/guide/advanced/lazy-loading.md'
+              ]
+            }
+          ]
+        }
       }
     }
   }

docs/.vuepress/enhanceApp.js

@@ -0,0 +1,8 @@
+export default ({ router }) => {
+  router.addRoutes([
+    { path: '/guide/', redirect: '/guide/essentials/getting-started.html' },
+    { path: '/:lang/guide/', redirect: '/:lang/guide/essentials/getting-started.html' },
+    { path: '/api/', redirect: '/api/options.html' },
+    { path: '/:lang/api/', redirect: '/:lang/api/options.html' }
+  ])
+}

docs/.vuepress/public/_redirects

@@ -1,3 +1,9 @@
 # redirect old urls to root
+
+/en/essentials/* /guide/essentials/*
+/en/advanced/* /guide/advanced/*
 /en/* /:splat
+
+/zh-cn/essentials/* /zh/guide/essentials/*
+/zh-cn/advanced/* /zh/guide/advanced/*
 /zh-cn/* /zh/:splat

docs/advanced/data-fetching.md renamed to docs/guide/advanced/data-fetching.md

@@ -20,7 +20,7 @@ Global before guards are called in creation order, whenever a navigation is trig
 
 Every guard function receives three arguments:
 
-- **`to: Route`**: the target [Route Object](../api/route-object.md) being navigated to.
+- **`to: Route`**: the target [Route Object](../../api/route-object.md) being navigated to.
 
 - **`from: Route`**: the current route being navigated away from.
 
@@ -30,9 +30,9 @@ Every guard function receives three arguments:
 
   - **`next(false)`**: abort the current navigation. If the browser URL was changed (either manually by the user or via back button), it will be reset to that of the `from` route.
 
-  - **`next('/')` or `next({ path: '/' })`**: redirect to a different location. The current navigation will be aborted and a new one will be started. You can pass any location object to `next`, which allows you to specify options like `replace: true`, `name: 'home'` and any option used in [`router-link`'s `to` prop](../api/router-link.md) or [`router.push`](../api/router-instance.md#methods)
+  - **`next('/')` or `next({ path: '/' })`**: redirect to a different location. The current navigation will be aborted and a new one will be started. You can pass any location object to `next`, which allows you to specify options like `replace: true`, `name: 'home'` and any option used in [`router-link`'s `to` prop](../../api/router-link.md) or [`router.push`](../../api/router-instance.md#methods)
 
-  - **`next(error)`**: (2.4.0+) if the argument passed to `next` is an instance of `Error`, the navigation will be aborted and the error will be passed to callbacks registered via [`router.onError()`](../api/router-instance.html#methods).
+  - **`next(error)`**: (2.4.0+) if the argument passed to `next` is an instance of `Error`, the navigation will be aborted and the error will be passed to callbacks registered via [`router.onError()`](../../api/router-instance.html#methods).
 
 **Make sure to always call the `next` function, otherwise the hook will never be resolved.**
 

docs/advanced/lazy-loading.md renamed to docs/guide/advanced/lazy-loading.md

@@ -34,7 +34,7 @@ You can have multiple dynamic segments in the same route, and they will map to c
 | /user/:username | /user/evan | `{ username: 'evan' }` |
 | /user/:username/post/:post_id | /user/evan/post/123 | `{ username: 'evan', post_id: 123 }` |
 
-In addition to `$route.params`, the `$route` object also exposes other useful information such as `$route.query` (if there is a query in the URL), `$route.hash`, etc. You can check out the full details in the [API Reference](../api/route-object.md).
+In addition to `$route.params`, the `$route` object also exposes other useful information such as `$route.query` (if there is a query in the URL), `$route.hash`, etc. You can check out the full details in the [API Reference](../../api/route-object.md).
 
 ## Reacting to Params Changes
 

docs/advanced/meta.md renamed to docs/guide/advanced/meta.md

@@ -2,14 +2,12 @@
 
 ::: tip Note
 We will be using [ES2015](https://github.com/lukehoban/es6features) in the code samples in the guide.
+
+Also, all examples will be using the full version of Vue to make on-the-fly template compilation possible. See more details [here](https://vuejs.org/v2/guide/installation.html#Runtime-Compiler-vs-Runtime-only).
 :::
 
 Creating a Single-page Application with Vue + Vue Router is dead simple. With Vue.js, we are already composing our application with components. When adding Vue Router to the mix, all we need to do is map our components to the routes and let Vue Router know where to render them. Here's a basic example:
 
-::: tip Note
-All examples will be using the full version of Vue to make template parsing possible. See more details [here](https://vuejs.org/v2/guide/installation.html#Runtime-Compiler-vs-Runtime-only).
-:::
-
 ## HTML
 
 ``` html
@@ -94,4 +92,4 @@ Throughout the docs, we will often use the `router` instance. Keep in mind that
 
 You can also check out this example [live](https://jsfiddle.net/yyx990803/xgrjzsup/).
 
-Notice that a `<router-link>` automatically gets the `.router-link-active` class when its target route is matched. You can learn more about it in its [API reference](../api/router-link.md).
+Notice that a `<router-link>` automatically gets the `.router-link-active` class when its target route is matched. You can learn more about it in its [API reference](../../api/router-link.md).

docs/advanced/navigation-guards.md renamed to docs/guide/advanced/navigation-guards.md

@@ -24,7 +24,7 @@ router.beforeEach((to, from, next) => {
 
 每个守卫方法接收三个参数：
 
-- **`to: Route`**: 即将要进入的目标 [路由对象](../api/route-object.md)
+- **`to: Route`**: 即将要进入的目标 [路由对象](../../api/route-object.md)
 
 - **`from: Route`**: 当前导航正要离开的路由
 
@@ -34,9 +34,9 @@ router.beforeEach((to, from, next) => {
 
   - **`next(false)`**: 中断当前的导航。如果浏览器的 URL 改变了 (可能是用户手动或者浏览器后退按钮)，那么 URL 地址会重置到 `from` 路由对应的地址。
 
-  - **`next('/')` 或者 `next({ path: '/' })`**: 跳转到一个不同的地址。当前的导航被中断，然后进行一个新的导航。你可以向 `next` 传递任意位置对象，且允许设置诸如 `replace: true`、`name: 'home'` 之类的选项以及任何用在 [`router-link` 的 `to` prop](../api/router-link.md) 或 [`router.push`](../api/router-instance.md#方法) 中的选项。
+  - **`next('/')` 或者 `next({ path: '/' })`**: 跳转到一个不同的地址。当前的导航被中断，然后进行一个新的导航。你可以向 `next` 传递任意位置对象，且允许设置诸如 `replace: true`、`name: 'home'` 之类的选项以及任何用在 [`router-link` 的 `to` prop](../../api/router-link.md) 或 [`router.push`](../../api/router-instance.md#方法) 中的选项。
 
-  - **`next(error)`**: (2.4.0+) 如果传入 `next` 的参数是一个 `Error` 实例，则导航会被终止且该错误会被传递给 [`router.onError()`](../api/router-instance.html#方法) 注册过的回调。
+  - **`next(error)`**: (2.4.0+) 如果传入 `next` 的参数是一个 `Error` 实例，则导航会被终止且该错误会被传递给 [`router.onError()`](../../api/router-instance.html#方法) 注册过的回调。
 
 **确保要调用 `next` 方法，否则钩子就不会被 resolved。**
 

docs/advanced/scroll-behavior.md renamed to docs/guide/advanced/scroll-behavior.md

@@ -35,7 +35,7 @@ const User = {
 | /user/:username | /user/evan | `{ username: 'evan' }` |
 | /user/:username/post/:post_id | /user/evan/post/123 | `{ username: 'evan', post_id: 123 }` |
 
-除了 `$route.params` 外，`$route` 对象还提供了其它有用的信息，例如，`$route.query` (如果 URL 中有查询参数)、`$route.hash` 等等。你可以查看 [API 文档](../api/route-object.md) 的详细说明。
+除了 `$route.params` 外，`$route` 对象还提供了其它有用的信息，例如，`$route.query` (如果 URL 中有查询参数)、`$route.hash` 等等。你可以查看 [API 文档](../../api/route-object.md) 的详细说明。
 
 ## 响应路由参数的变化
 

docs/advanced/transitions.md renamed to docs/guide/advanced/transitions.md

@@ -2,14 +2,12 @@
 
 ::: tip 注意
 教程中的案例代码将使用 [ES2015](https://github.com/lukehoban/es6features) 来编写。
+
+同时，所有的例子都将使用完整版的 Vue 以解析模板。更多细节请[移步这里](https://cn.vuejs.org/v2/guide/installation.html#运行时-编译器-vs-只包含运行时)。
 :::
 
 用 Vue.js + Vue Router 创建单页应用，是非常简单的。使用 Vue.js ，我们已经可以通过组合组件来组成应用程序，当你要把 Vue Router 添加进来，我们需要做的是，将组件 (components) 映射到路由 (routes)，然后告诉 Vue Router 在哪里渲染它们。下面是个基本例子：
 
-::: tip 注意
-所有的例子都将使用完整版的 Vue 以解析模板。更多细节请[移步这里](https://cn.vuejs.org/v2/guide/installation.html#运行时-编译器-vs-只包含运行时)。
-:::
-
 ## HTML
 
 ``` html
@@ -92,4 +90,4 @@ export default {
 
 你可以看看这个[在线的](https://jsfiddle.net/yyx990803/xgrjzsup/)例子。
 
-要注意，当 `<router-link>` 对应的路由匹配成功，将自动设置 class 属性值  `.router-link-active`。查看 [API 文档](../api/router-link.md) 学习更多相关内容。
+要注意，当 `<router-link>` 对应的路由匹配成功，将自动设置 class 属性值  `.router-link-active`。查看 [API 文档](../../api/router-link.md) 学习更多相关内容。