Merge pull request #116 from JacobChang/chinese-documents

Chinese documents

Author: yyx990803

docs/LANGS.md

@@ -1,2 +1,3 @@
 * [English](en/)
 * [日本語](ja/)
+* [中文](zh-cn/)

docs/zh-cn/README.md

@@ -0,0 +1 @@
+SUMMARY.md

docs/zh-cn/SUMMARY.md

@@ -0,0 +1,29 @@
+# vue-router文档 [![npm package](https://img.shields.io/npm/v/vue-router.svg)](https://www.npmjs.com/package/vue-router)
+
+- [安装](installation.md)
+- [基本用法](basic.md)
+- [嵌套路由](nested.md)
+- [路由对象和路由匹配](route.md)
+- [路由配置项](options.md)
+- [router-view](view.md)
+- [v-link](link.md)
+- [切换控制流水线](pipeline/README.md)
+  - [切换勾子函数](pipeline/hooks.md)
+  - [data](pipeline/data.md)
+  - [activate](pipeline/activate.md)
+  - [deactivate](pipeline/deactivate.md)
+  - [canActivate](pipeline/can-activate.md)
+  - [canDeactivate](pipeline/can-deactivate.md)
+  - [canReuse](pipeline/can-reuse.md)
+- [API](api/README.md)
+  - [路由实例属性](api/properties.md)
+  - [router.start](api/start.md)
+  - [router.stop](api/stop.md)
+  - [router.map](api/map.md)
+  - [router.on](api/on.md)
+  - [router.go](api/go.md)
+  - [router.replace](api/replace.md)
+  - [router.redirect](api/redirect.md)
+  - [router.alias](api/alias.md)
+  - [router.beforeEach](api/before-each.md)
+  - [router.afterEach](api/after-each.md)

docs/zh-cn/api/README.md

@@ -0,0 +1,13 @@
+# API 索引
+
+- [路由器实例属性](properties.md)
+- [router.start](start.md)
+- [router.stop](stop.md)
+- [router.map](map.md)
+- [router.on](on.md)
+- [router.go](go.md)
+- [router.replace](replace.md)
+- [router.redirect](redirect.md)
+- [router.alias](alias.md)
+- [router.beforeEach](before-each.md)
+- [router.afterEach](after-each.md)

docs/zh-cn/api/after-each.md

@@ -0,0 +1,21 @@
+# `router.afterEach(hook)`
+
+设置全局的后置勾子函数，该函数会在每次路由切换**成功进入激活阶段**时被调用。
+
+注意，该函数调用时仅仅意味着切换已经被验证过了，也就是所有 `canDeactivate` 和 `canActivate` 勾子函数都成功的被断定( resolved )了，而且浏览器地址栏中的地址也已经更新。并不能保证所有的 `activate` 勾子函数都被断定了。
+
+注意，只能有一个全局的后置勾子函数。但是你可以在这个勾子函数内实现自己的中间件系统。
+
+### 参数
+
+- `hook {Function}`
+
+  此勾子函数一个类型为[切换对象](../pipeline/hooks.html#transition-object)的参数，但是你只能访问此参数的 `to` 和 `from` 属性, 这两个属性都是路由对象。在这个后置勾子函数里**不能**调用任何切换函数。
+
+### Example
+
+``` js
+router.afterEach(function (transition) {
+  console.log('成功浏览到: ' + transition.to.path)
+})
+```

docs/zh-cn/api/alias.md

@@ -0,0 +1,25 @@
+# `router.alias(aliasMap)`
+
+为路由器配置全局的别名规则。别名和重定向的区别在于，相对于重定向把 `fromPath` 替换为 `toPath` ，别名会保留 `fromPath` ，但是匹配时使用的是 `toPath` 。
+
+例如，如果我们把 `/a` 取别名为 `/a/b/c` ，那么当我们访问 `/a` 时，浏览器地址栏中的URL会是 `/a` 。但是路由匹配是却像是在访问 `/a/b/c` 。
+
+### 参数
+
+- `aliasMap {Object}`
+
+  别名映射对象的格式应该为 `{ fromPath: toPath, ... }` 。路径中可以包含动态片段。
+
+### Example
+
+``` js
+router.alias({
+
+  // 匹配 /a 时就像是匹配 /a/b/c
+  '/a': '/a/b/c',
+
+  // 别名可以包含动态片段
+  // 而且重定向片段必须匹配
+  '/user/:userId': '/user/profile/:userId'
+})
+```

docs/zh-cn/api/before-each.md

@@ -0,0 +1,38 @@
+# `router.beforeEach(hook)`
+
+设置全局的前置勾子函数，这个函数会在路由切换开始时调用。调用发生在整个切换流水线之前。如果此钩子函数拒绝了切换，整个切换流水线根本就不会启动。
+
+注意，只能有一个全局的前置勾子函数。但是你可以在这个勾子函数内实现自己的中间件系统。
+
+### 参数
+
+- `hook {Function}`
+
+  此勾子函数一个类型为[切换对象](../pipeline/hooks.html#transition-object)的参数。
+
+### Example
+
+简单示例
+
+``` js
+router.beforeEach(function (transition) {
+  if (transition.to.path === '/forbidden') {
+    transition.abort()
+  } else {
+    transition.next()
+  }
+})
+```
+
+使用 Promise 和 ES6
+
+``` js
+router.beforeEach(function ({ to, next }) {
+  if (to.path === '/auth-required') {
+    // 返回一个断定会 true 或者 false 的 Promise
+    return AuthService.isLoggedIn()
+  } else {
+    next()
+  }
+})
+```

docs/zh-cn/api/go.md

@@ -0,0 +1,9 @@
+# `router.go(path)`
+
+导航到一个新的路由
+
+### 参数
+
+- `path: String`
+
+  此路径为一个普通路径（也就是说没有动态片段或者全匹配片段）。路径不能以 `/` 开头，会以相对于当前路径的方式进行解析。

docs/zh-cn/api/map.md

@@ -0,0 +1,47 @@
+# `router.map(routeMap)`
+
+定义路由映射的主要方法。
+
+### 参数
+
+- `routeMap: Object`
+
+  结构体，键为路径，值为路由配置对象。对于路径匹配规则，查看[路由匹配](../route.html#route-matching).
+
+### 路由配置对象
+
+路由配置对象包含两个字段：
+
+- `component`: 当路径匹配时，会渲染到顶级 `<router-view>` 的Vue组件。此字段的值可以是调用 `Vue.extend` 后返回的构造函数，或者普通的组件选项对象。在后一种情况下，路由会隐式调用 `Vue.extend` 。
+
+- `subRoutes`: 嵌套的子路由映射。对于每一个 `subRoutes` 映射中的子路由对象，路由器在做匹配时会使用其路径拼接到父级路径后得到的全路径。成功匹配的组件会渲染到父级组件的 `<router-view>` 中。
+
+### 例子
+
+``` js
+router.map({
+  // 组件构造函数
+  '/a': {
+    component: Vue.extend({ /* ... */ })
+  },
+  // 组件选项对象
+  '/b': {
+    component: {
+      template: '<p>Hello from /b</p>'
+    }
+  },
+  // 嵌套的路由
+  '/c': {
+    component: {
+      // 渲染子视图
+      template: '<router-view></router-view>'
+    },
+    subRoutes: {
+      // 当路径是 /c/d 时进行渲染
+      '/d': { component: { template: 'D' }},
+      // 当路径是 /c/e 时进行渲染
+      '/e': { component: { template: 'E' }}
+    }
+  }
+})
+```

docs/zh-cn/api/on.md

@@ -0,0 +1,18 @@
+# `router.on(path, config)`
+
+添加一条顶级的路由配置。在内部实现时，`router.map()` 对于接收到的路由映射对象中每个键值对都调用 `router.on()` 。
+
+### 参数
+
+- `path: String` - 查看[路由匹配](../route.md#route-matching)
+- `config: Object` - 查看[路由配置对象](map.md#route-config-object).
+
+### 例子
+
+``` js
+router.on('/user/:userId', {
+  component: {
+    template: '<div>{{$route.params.userId}}</div>'
+  }
+})
+```