complete docs

Author: yyx990803

docs/en/SUMMARY.md

@@ -14,7 +14,7 @@
   - [Redirect and Alias](essentials/redirect-and-alias.md)
   - [HTML5 History Mode](essentials/history-mode.md)
 - Advanced
-  - [Navigation Hooks](advanced/navigation-guards.md)
+  - [Navigation Guards](advanced/navigation-guards.md)
   - [Route Meta Fields](advanced/meta.md)
   - [Transitions](advanced/transitions.md)
   - [Data Fetching](advanced/data-fetching.md)
@@ -25,6 +25,5 @@
   - [router-view](api/router-view.md)
   - [The Route Object](api/route-object.md)
   - [Router Constructor Options](api/options.md)
-  - [Routes Configuration](api/route-config.md)
   - [Router Instance](api/router-instance.md)
   - [Component Injections](api/component-injections.md)

docs/en/advanced/navigation-guards.md

@@ -18,7 +18,7 @@ Global before guards are called in creation order, whenever a navigation is trig
 
 Every guard function receives three arguments:
 
-- `route: Route`: the target route object being navigated to.
+- `route: Route`: the target [Route Object](../api/route-object.md) being navigated to.
 
 - `redirect: Function`: calling this function will abort the current navigation and start a new navigation towards the redirect target.
 

docs/en/api/component-injections.md

@@ -0,0 +1,20 @@
+# Component Injections
+
+### Injected Properties
+
+These properties are injected into every child component by passing the router instance to the root instance as the `router` option.
+
+- #### $router
+
+  The router instance.
+
+- #### $route
+
+  The current active [Route](route-object.md). This property is read-only and its properties are immutable, but it can be watched.
+
+### Enabled Options
+
+- **beforeRouteEnter**
+- **beforeRouteLeave**
+
+  See [In Component Guards](../advanced/navigation-guards.md#incomponent-guards).

docs/en/api/options.md

@@ -1 +1,69 @@
 # Router Construction Options
+
+### routes
+
+- type: `Array<RouteConfig>`
+
+  Type declaration for `RouteConfig`:
+
+  ``` js
+  declare type RouteConfig = {
+    path: string;
+    component?: Component;
+    name?: string; // for named routes
+    components?: { [name: string]: Component }; // for named views
+    redirect?: string | Location | Function;
+    alias?: string | Array<string>;
+    children?: Array<RouteConfig>; // for nested routes
+    beforeEnter?: (route: Route, redirect: Function, next: Function) => void;
+    meta?: any;
+  }
+  ```
+
+### mode
+
+- type: `string`
+
+- default: `"hash" (in browser) | "abstract" (in Node.js)`
+
+- available values: `"hash" | "history" | "abstract"`
+
+  Configure the router mode.
+
+  - `hash`: uses the URL hash for routing. Works in all Vue-supported browsers, including those that do not support HTML5 History API.
+
+  - `history`: requires HTML5 History API and server config. See [HTML5 History Mode](../essentials/history.md).
+
+  - `abstract`: works in all JavaScript environments, e.g. server-side with Node.js. **The router will automatically be forced into this mode if no browser API is present.**
+
+### base
+
+- type: `string`
+
+- default: `"/"`
+
+  The base URL of the app. For example, if the entire single page application is served under `/app/`, then `base` should use the value `"/app/"`.
+
+### linkActiveClass
+
+- type: `string`
+
+- default: `"router-link-active"`
+
+  Globally configure `<router-link>` default active class. Also see [router-link](router-link.md).
+
+### scrollBehavior
+
+- type: `Function`
+
+  Signature:
+
+  ```
+  (
+    to: Route,
+    from: Route,
+    savedPosition?: { x: number, y: number }
+  ) => { x: number, y: number } | { selector: string } | ?{}
+  ```
+
+  For more details see [Scroll Behavior](../advanced/scroll-behavior.md).

docs/en/api/route-config.md

@@ -0,0 +1,41 @@
+# Router Instance
+
+### Properties
+
+#### router.app
+
+- type: `Vue instance`
+
+  The root Vue instance the `router` was injected into.
+
+#### router.mode
+
+- type: `string`
+
+  The [mode](options.md#mode) the router is using.
+
+#### router.currentRoute
+
+- type: `Route`
+
+  The current route represented as a [Route Object](route-object.md).
+
+### Methods
+
+- **router.beforeEach(guard)**
+- **router.afterEach(hook)**
+
+  Add global navigation guards. See [Navigation Guards](../advanced/navigation-gaurds.md).
+
+
+- **router.push(location)**
+- **router.replace(location)**
+- **router.go(n)**
+- **router.back()**
+- **router.forward()**
+
+  Programmatically navigate to a new URL. See [Programmatic Navigation](../essentials/navigation.md).
+
+- **router.getMatchedComponents()**
+
+  Returns an Array of the components (definition/constructor, not instances) matched by the current route. This is mostly used during server-side rendering to perform data prefetching.

docs/en/api/router-instance.md

@@ -14,7 +14,7 @@
 
 - **to**
 
-  - type: `string | Object`
+  - type: `string | Location`
 
   - required
 
@@ -86,7 +86,7 @@
 
   - default: `"router-link-active"`
 
-  Configure the active CSS class applied when the link is active.
+  Configure the active CSS class applied when the link is active. Note the default value can also be configured globally via the `linkActiveClass` router constructor option.
 
 - **exact**
 

docs/en/api/router-link.md

@@ -46,7 +46,7 @@ https://github.com/bripkens/connect-history-api-fallback
 
 There is a caveats to this, because that your server will no longer report 404 errors as all paths will serve up your `index.html` file. To get around the issue, you should implement a catch-all route within your Vue app to show a 404 page:
 
-```javascript
+``` js
 const router = new VueRouter({
   mode: 'history',
   routes: [

docs/en/essentials/history-mode.md

@@ -13,7 +13,7 @@ declare type RouterOptions = {
   scrollBehavior?: Function;
 }
 
-declare type RedirectOption = string | { name: string } | Function
+declare type RedirectOption = RawLocation | Function
 
 declare type RouteConfig = {
   path: string;