소스 검색

docs: reorganize file structure

Evan You 7 년 전
부모
커밋
fab5054bc7
44개의 변경된 파일140개의 추가작업 그리고 133개의 파일을 삭제
  1. 42 42
      docs/.vuepress/config.js
  2. 7 1
      docs/.vuepress/public/_redirects
  3. 29 29
      docs/api/README.md
  4. 1 1
      docs/guide/README.md
  5. 0 0
      docs/guide/actions.md
  6. 9 8
      docs/guide/core-concepts.md
  7. 0 0
      docs/guide/forms.md
  8. 0 0
      docs/guide/getters.md
  9. 0 0
      docs/guide/hot-reload.md
  10. 0 0
      docs/guide/modules.md
  11. 0 0
      docs/guide/mutations.md
  12. 0 0
      docs/guide/plugins.md
  13. 0 0
      docs/guide/state.md
  14. 0 0
      docs/guide/strict.md
  15. 0 0
      docs/guide/structure.md
  16. 0 0
      docs/guide/testing.md
  17. 26 26
      docs/ja/api/README.md
  18. 1 1
      docs/ja/guide/README.md
  19. 0 0
      docs/ja/guide/actions.md
  20. 0 0
      docs/ja/guide/core-concepts.md
  21. 0 0
      docs/ja/guide/forms.md
  22. 0 0
      docs/ja/guide/getters.md
  23. 0 0
      docs/ja/guide/hot-reload.md
  24. 0 0
      docs/ja/guide/modules.md
  25. 0 0
      docs/ja/guide/mutations.md
  26. 0 0
      docs/ja/guide/plugins.md
  27. 0 0
      docs/ja/guide/state.md
  28. 0 0
      docs/ja/guide/strict.md
  29. 0 0
      docs/ja/guide/structure.md
  30. 0 0
      docs/ja/guide/testing.md
  31. 24 24
      docs/zh/api/README.md
  32. 1 1
      docs/zh/guide/README.md
  33. 0 0
      docs/zh/guide/actions.md
  34. 0 0
      docs/zh/guide/core-concepts.md
  35. 0 0
      docs/zh/guide/forms.md
  36. 0 0
      docs/zh/guide/getters.md
  37. 0 0
      docs/zh/guide/hot-reload.md
  38. 0 0
      docs/zh/guide/modules.md
  39. 0 0
      docs/zh/guide/mutations.md
  40. 0 0
      docs/zh/guide/plugins.md
  41. 0 0
      docs/zh/guide/state.md
  42. 0 0
      docs/zh/guide/strict.md
  43. 0 0
      docs/zh/guide/structure.md
  44. 0 0
      docs/zh/guide/testing.md

+ 42 - 42
docs/.vuepress/config.js

@@ -29,11 +29,11 @@ module.exports = {
         nav: [
           {
             text: 'Guide',
-            link: '/getting-started'
+            link: '/guide/'
           },
           {
             text: 'API Reference',
-            link: '/api'
+            link: '/api/'
           },
           {
             text: 'Release Notes',
@@ -43,24 +43,24 @@ module.exports = {
         sidebar: [
           '/installation',
           '/',
-          '/getting-started',
+          '/guide/',
           {
             title: 'Core Concepts',
             collapsable: false,
             children: [
-              '/state',
-              '/getters',
-              '/mutations',
-              '/actions',
-              '/modules'
+              '/guide/state',
+              '/guide/getters',
+              '/guide/mutations',
+              '/guide/actions',
+              '/guide/modules'
             ]
           },
-          '/structure',
-          '/plugins',
-          '/strict',
-          '/forms',
-          '/testing',
-          '/hot-reload'
+          '/guide/structure',
+          '/guide/plugins',
+          '/guide/strict',
+          '/guide/forms',
+          '/guide/testing',
+          '/guide/hot-reload'
         ]
       },
       '/zh/': {
@@ -70,11 +70,11 @@ module.exports = {
         nav: [
           {
             text: '指南',
-            link: '/zh/getting-started'
+            link: '/zh/guide/'
           },
           {
             text: 'API 参考',
-            link: '/zh/api'
+            link: '/zh/api/'
           },
           {
             text: '更新记录',
@@ -84,24 +84,24 @@ module.exports = {
         sidebar: [
           '/zh/installation',
           '/zh/',
-          '/zh/getting-started',
+          '/zh/guide/',
           {
             title: '核心概念',
             collapsable: false,
             children: [
-              '/zh/state',
-              '/zh/getters',
-              '/zh/mutations',
-              '/zh/actions',
-              '/zh/modules'
+              '/zh/guide/state',
+              '/zh/guide/getters',
+              '/zh/guide/mutations',
+              '/zh/guide/actions',
+              '/zh/guide/modules'
             ]
           },
-          '/zh/structure',
-          '/zh/plugins',
-          '/zh/strict',
-          '/zh/forms',
-          '/zh/testing',
-          '/zh/hot-reload'
+          '/zh/guide/structure',
+          '/zh/guide/plugins',
+          '/zh/guide/strict',
+          '/zh/guide/forms',
+          '/zh/guide/testing',
+          '/zh/guide/hot-reload'
         ]
       },
       '/ja/': {
@@ -110,11 +110,11 @@ module.exports = {
         editLinkText: 'GitHub 上でこのページを編集する',
         nav: [{
             text: 'ガイド',
-            link: '/ja/getting-started'
+            link: '/ja/guide/'
           },
           {
             text: 'API リファレンス',
-            link: '/ja/api'
+            link: '/ja/api/'
           },
           {
             text: 'リリースノート',
@@ -124,24 +124,24 @@ module.exports = {
         sidebar: [
           '/ja/installation',
           '/ja/',
-          '/ja/getting-started',
+          '/ja/guide/',
           {
             title: 'コアコンセプト',
             collapsable: false,
             children: [
-              '/ja/state',
-              '/ja/getters',
-              '/ja/mutations',
-              '/ja/actions',
-              '/ja/modules'
+              '/ja/guide/state',
+              '/ja/guide/getters',
+              '/ja/guide/mutations',
+              '/ja/guide/actions',
+              '/ja/guide/modules'
             ]
           },
-          '/ja/structure',
-          '/ja/plugins',
-          '/ja/strict',
-          '/ja/forms',
-          '/ja/testing',
-          '/ja/hot-reload'
+          '/ja/guide/structure',
+          '/ja/guide/plugins',
+          '/ja/guide/strict',
+          '/ja/guide/forms',
+          '/ja/guide/testing',
+          '/ja/guide/hot-reload'
         ]
       }
     }

+ 7 - 1
docs/.vuepress/public/_redirects

@@ -1,3 +1,9 @@
 # redirect old urls to root
-/en/* /:splat
+
+/en/api.html  /api/
+/en/* /guide/:splat
+
+/zh-cn/api.html  /zh/api/
 /zh-cn/* /zh/:splat
+
+/ja/api.html  /ja/api/

+ 29 - 29
docs/api.md → docs/api/README.md

@@ -18,9 +18,9 @@ const store = new Vuex.Store({ ...options })
 
 - type: `Object | Function`
 
-  The root state object for the Vuex store. [Details](state.md)
+  The root state object for the Vuex store. [Details](../guide/state.md)
 
-  If you pass a function that returns an object, the returned object is used as the root state. This is useful when you want to reuse the state object especially for module reuse. [Details](modules.md#module-reuse)
+  If you pass a function that returns an object, the returned object is used as the root state. This is useful when you want to reuse the state object especially for module reuse. [Details](../guide/modules.md#module-reuse)
 
 ### mutations
 
@@ -28,7 +28,7 @@ const store = new Vuex.Store({ ...options })
 
   Register mutations on the store. The handler function always receives `state` as the first argument (will be module local state if defined in a module), and receives a second `payload` argument if there is one.
 
-  [Details](mutations.md)
+  [Details](../guide/mutations.md)
 
 ### actions
 
@@ -46,10 +46,10 @@ const store = new Vuex.Store({ ...options })
     rootGetters // same as `store.getters`, only in modules
   }
   ```
-  
+
   And also receives a second `payload` argument if there is one.
 
-  [Details](actions.md)
+  [Details](../guide/actions.md)
 
 ### getters
 
@@ -73,7 +73,7 @@ const store = new Vuex.Store({ ...options })
 
   Registered getters are exposed on `store.getters`.
 
-  [Details](getters.md)
+  [Details](../guide/getters.md)
 
 ### modules
 
@@ -97,7 +97,7 @@ const store = new Vuex.Store({ ...options })
 
   Each module can contain `state` and `mutations` similar to the root options. A module's state will be attached to the store's root state using the module's key. A module's mutations and getters will only receives the module's local state as the first argument instead of the root state, and module actions' `context.state` will also point to the local state.
 
-  [Details](modules.md)
+  [Details](../guide/modules.md)
 
 ### plugins
 
@@ -105,7 +105,7 @@ const store = new Vuex.Store({ ...options })
 
   An array of plugin functions to be applied to the store. The plugin simply receives the store as the only argument and can either listen to mutations (for outbound data persistence, logging, or debugging) or dispatch mutations (for inbound data e.g. websockets or observables).
 
-  [Details](plugins.md)
+  [Details](../guide/plugins.md)
 
 ### strict
 
@@ -114,7 +114,7 @@ const store = new Vuex.Store({ ...options })
 
   Force the Vuex store into strict mode. In strict mode any mutations to Vuex state outside of mutation handlers will throw an Error.
 
-  [Details](strict.md)
+  [Details](../guide/strict.md)
 
 ## Vuex.Store Instance Properties
 
@@ -137,14 +137,14 @@ const store = new Vuex.Store({ ...options })
 -  `commit(type: string, payload?: any, options?: Object)`
 -  `commit(mutation: Object, options?: Object)`
 
-  Commit a mutation. `options` can have `root: true` that allows to commit root mutations in [namespaced modules](modules.md#namespacing). [Details](mutations.md)
+  Commit a mutation. `options` can have `root: true` that allows to commit root mutations in [namespaced modules](../guide/modules.md#namespacing). [Details](../guide/mutations.md)
 
 ### dispatch
 
 -  `dispatch(type: string, payload?: any, options?: Object)`
 -  `dispatch(action: Object, options?: Object)`
 
-  Dispatch an action. `options` can have `root: true` that allows to dispatch root actions in [namespaced modules](modules.md#namespacing). Returns a Promise that resolves all triggered action handlers. [Details](actions.md)
+  Dispatch an action. `options` can have `root: true` that allows to dispatch root actions in [namespaced modules](../guide/modules.md#namespacing). Returns a Promise that resolves all triggered action handlers. [Details](../guide/actions.md)
 
 ### replaceState
 
@@ -175,7 +175,7 @@ const store = new Vuex.Store({ ...options })
 
   To stop subscribing, call the returned unsubscribe function.
 
-  Most commonly used in plugins. [Details](plugins.md)
+  Most commonly used in plugins. [Details](../guide/plugins.md)
 
 ### subscribeAction
 
@@ -194,13 +194,13 @@ const store = new Vuex.Store({ ...options })
 
   To stop subscribing, call the returned unsubscribe function.
 
-  Most commonly used in plugins. [Details](plugins.md)
+  Most commonly used in plugins. [Details](../guide/plugins.md)
 
 ### registerModule
 
 -  `registerModule(path: string | Array<string>, module: Module, options?: Object)`
 
-  Register a dynamic module. [Details](modules.md#dynamic-module-registration)
+  Register a dynamic module. [Details](../guide/modules.md#dynamic-module-registration)
 
   `options` can have `preserveState: true` that allows to preserve the previous state. Useful with Server Side Rendering.
 
@@ -208,13 +208,13 @@ const store = new Vuex.Store({ ...options })
 
 -  `unregisterModule(path: string | Array<string>)`
 
-  Unregister a dynamic module. [Details](modules.md#dynamic-module-registration)
+  Unregister a dynamic module. [Details](../guide/modules.md#dynamic-module-registration)
 
 ### hotUpdate
 
 -  `hotUpdate(newOptions: Object)`
 
-  Hot swap new actions and mutations. [Details](hot-reload.md)
+  Hot swap new actions and mutations. [Details](../guide/hot-reload.md)
 
 ## Component Binding Helpers
 
@@ -222,42 +222,42 @@ const store = new Vuex.Store({ ...options })
 
 -  `mapState(namespace?: string, map: Array<string> | Object<string | function>): Object`
 
-  Create component computed options that return the sub tree of the Vuex store. [Details](state.md#the-mapstate-helper)
+  Create component computed options that return the sub tree of the Vuex store. [Details](../guide/state.md#the-mapstate-helper)
+
+  The first argument can optionally be a namespace string. [Details](../guide/modules.md#binding-helpers-with-namespace)
 
-  The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
-  
-  The second object argument's members can be a function. `function(state: any)` 
+  The second object argument's members can be a function. `function(state: any)`
 
 ### mapGetters
 
 -  `mapGetters(namespace?: string, map: Array<string> | Object<string>): Object`
 
-  Create component computed options that return the evaluated value of a getter. [Details](getters.md#the-mapgetters-helper)
+  Create component computed options that return the evaluated value of a getter. [Details](../guide/getters.md#the-mapgetters-helper)
 
-  The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
+  The first argument can optionally be a namespace string. [Details](../guide/modules.md#binding-helpers-with-namespace)
 
 ### mapActions
 
 -  `mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object`
 
-  Create component methods options that dispatch an action. [Details](actions.md#dispatching-actions-in-components)
+  Create component methods options that dispatch an action. [Details](../guide/actions.md#dispatching-actions-in-components)
+
+  The first argument can optionally be a namespace string. [Details](../guide/modules.md#binding-helpers-with-namespace)
 
-  The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
-  
   The second object argument's members can be a function. `function(dispatch: function, ...args: any[])`
 
 ### mapMutations
 
 -  `mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object`
 
-  Create component methods options that commit a mutation. [Details](mutations.md#committing-mutations-in-components)
+  Create component methods options that commit a mutation. [Details](../guide/mutations.md#committing-mutations-in-components)
+
+  The first argument can optionally be a namespace string. [Details](../guide/modules.md#binding-helpers-with-namespace)
 
-  The first argument can optionally be a namespace string. [Details](modules.md#binding-helpers-with-namespace)
-  
   The second object argument's members can be a function. `function(commit: function, ...args: any[])`
 
 ### createNamespacedHelpers
 
 -  `createNamespacedHelpers(namespace: string): Object`
 
-  Create namespaced component binding helpers. The returned object contains `mapState`, `mapGetters`, `mapActions` and `mapMutations` that are bound with the given namespace. [Details](modules.md#binding-helpers-with-namespace)
+  Create namespaced component binding helpers. The returned object contains `mapState`, `mapGetters`, `mapActions` and `mapMutations` that are bound with the given namespace. [Details](../guide/modules.md#binding-helpers-with-namespace)

+ 1 - 1
docs/getting-started.md → docs/guide/README.md

@@ -10,7 +10,7 @@ At the center of every Vuex application is the **store**. A "store" is basically
 
 > **NOTE:** We will be using ES2015 syntax for code examples for the rest of the docs. If you haven't picked it up, [you should](https://babeljs.io/docs/learn-es2015/)!
 
-After [installing](installation.md) Vuex, let's create a store. It is pretty straightforward - just provide an initial state object, and some mutations:
+After [installing](../installation.md) Vuex, let's create a store. It is pretty straightforward - just provide an initial state object, and some mutations:
 
 ``` js
 // Make sure to call Vue.use(Vuex) first if using a module system

+ 0 - 0
docs/actions.md → docs/guide/actions.md


+ 9 - 8
docs/core-concepts.md → docs/guide/core-concepts.md

@@ -1,12 +1,13 @@
 # Core Concepts
 
-We will be learning the core concepts of Vuex in these chapters. They are
-  - [State](state.md)
-  - [Getters](getters.md)
-  - [Mutations](mutations.md)
-  - [Actions](actions.md)
-  - [Modules](modules.md)
-
-A deep understanding of all these concepts is essential for using vuex. 
+We will be learning the core concepts of Vuex in these chapters. They are:
+
+- [State](state.md)
+- [Getters](getters.md)
+- [Mutations](mutations.md)
+- [Actions](actions.md)
+- [Modules](modules.md)
+
+A deep understanding of all these concepts is essential for using vuex.
 
 Let's get started.

+ 0 - 0
docs/forms.md → docs/guide/forms.md


+ 0 - 0
docs/getters.md → docs/guide/getters.md


+ 0 - 0
docs/hot-reload.md → docs/guide/hot-reload.md


+ 0 - 0
docs/modules.md → docs/guide/modules.md


+ 0 - 0
docs/mutations.md → docs/guide/mutations.md


+ 0 - 0
docs/plugins.md → docs/guide/plugins.md


+ 0 - 0
docs/state.md → docs/guide/state.md


+ 0 - 0
docs/strict.md → docs/guide/strict.md


+ 0 - 0
docs/structure.md → docs/guide/structure.md


+ 0 - 0
docs/testing.md → docs/guide/testing.md


+ 26 - 26
docs/ja/api.md → docs/ja/api/README.md

@@ -18,9 +18,9 @@ const store = new Vuex.Store({ ...options })
 
   - 型: `Object | Function`
 
-    ストアのための ルートステートオブジェクトです。[詳細](state.md)
+    ストアのための ルートステートオブジェクトです。[詳細](../guide/state.md)
 
-    オブジェクトを返す関数を渡す場合、返されたオブジェクトはルートステートとして使用されます。これは特にモジュールの再利用のためにステートオブジェクトを再利用する場合に便利です。[詳細](modules.md#モジュールの再利用)
+    オブジェクトを返す関数を渡す場合、返されたオブジェクトはルートステートとして使用されます。これは特にモジュールの再利用のためにステートオブジェクトを再利用する場合に便利です。[詳細](../guide/modules.md#モジュールの再利用)
 
 ### mutations
 
@@ -28,7 +28,7 @@ const store = new Vuex.Store({ ...options })
 
     ストアにミューテーションを登録します。ハンドラ関数は第一引数に `state` を常に受け取り(モジュール内で定義されていれば、モジュールのローカルステートを受け取り)、指定されていれば第二引数に `payload` を受け取ります。
 
-    [詳細](mutations.md)
+    [詳細](../guide/mutations.md)
 
 ### actions
 
@@ -49,7 +49,7 @@ const store = new Vuex.Store({ ...options })
 
     そして、第 2 引数の `payload` があれば、それを受け取ります。
 
-    [詳細](actions.md)
+    [詳細](../guide/actions.md)
 
 ### getters
 
@@ -63,7 +63,7 @@ const store = new Vuex.Store({ ...options })
     ```
 
     モジュールで定義されたときの仕様
-    
+
     ```
     state,       // モジュールで定義された場合、モジュールのローカルステート
     getters,     // 現在のモジュールのモジュールのローカルゲッター
@@ -73,7 +73,7 @@ const store = new Vuex.Store({ ...options })
 
     登録されたゲッターは `store.getters` 上に公開されます。
 
-    [詳細](getters.md)
+    [詳細](../guide/getters.md)
 
 ### modules
 
@@ -89,7 +89,7 @@ const store = new Vuex.Store({ ...options })
         actions?,
         getters?,
         modules?
-    
+
       },
       ...
     }
@@ -97,7 +97,7 @@ const store = new Vuex.Store({ ...options })
 
     各モジュールは、ルートオプションに似た `state` と `mutations` を含むことができます。モジュールの状態は、モジュールのキーを使って、ストアのルートステートに結合されます。モジュールのミューテーションとゲッターは、第一引数としてルートステートの代わりに、モジュールのローカルステートだけを受け取り、モジュールのアクションの `context.state` もローカルステートを指すようになります。
 
-    [詳細](modules.md)
+    [詳細](../guide/modules.md)
 
 ### plugins
 
@@ -105,7 +105,7 @@ const store = new Vuex.Store({ ...options })
 
     プラグイン関数の配列は、ストアに適用されます。このプラグインは、ストアだけを引数として受け取り、外部への永続化、ロギング、デバッギングのために、ミューテーションを監視するか、または、 websocket や observable のような外から渡されるデータのためにミューテーションをディスパッチします。
 
-    [詳細](plugins.md)
+    [詳細](../guide/plugins.md)
 
 ### strict
 
@@ -114,7 +114,7 @@ const store = new Vuex.Store({ ...options })
 
     Vuex ストアを厳格モードにします。厳格モードでは、ミューテーションハンドラ以外で、 Vuex の状態の変更を行うと、エラーが投げられます。
 
-    [詳細](strict.md)
+    [詳細](../guide/strict.md)
 
 ## Vuex.Store インスタンスプロパティ
 
@@ -137,14 +137,14 @@ const store = new Vuex.Store({ ...options })
 - **`commit(type: string, payload?: any, options?: Object)`**
 - **`commit(mutation: Object, options?: Object)`**
 
-  ミューテーションをコミットします。`options` は[名前空間付きモジュール](modules.md#名前空間)で root なミューテーションにコミットできる `root: true` を持つことできます。[詳細](mutations.md)
+  ミューテーションをコミットします。`options` は[名前空間付きモジュール](../guide/modules.md#名前空間)で root なミューテーションにコミットできる `root: true` を持つことできます。[詳細](../guide/mutations.md)
 
 ### dispatch
 
 - **`dispatch(type: string, payload?: any, options?: Object)`**
 - **`dispatch(action: Object, options?: Object)`**
 
-  アクションをディスパッチします。`options` は[名前空間付きモジュール](modules.md#名前空間)で root なアクションにディスパッチできる `root: true` を持つことできます。 すべてのトリガーされたアクションハンドラを解決するPromiseを返します。[詳細](actions.md)
+  アクションをディスパッチします。`options` は[名前空間付きモジュール](../guide/modules.md#名前空間)で root なアクションにディスパッチできる `root: true` を持つことできます。 すべてのトリガーされたアクションハンドラを解決するPromiseを返します。[詳細](../guide/actions.md)
 
 ### replaceState
 
@@ -173,7 +173,7 @@ const store = new Vuex.Store({ ...options })
   })
   ```
 
-  プラグインの中でもっともよく利用されます。[詳細](plugins.md)
+  プラグインの中でもっともよく利用されます。[詳細](../guide/plugins.md)
 
 ### subscribeAction
 
@@ -190,13 +190,13 @@ const store = new Vuex.Store({ ...options })
   })
   ```
 
- プラグインで最も一般的に使用されます。[Details](plugins.md)
+ プラグインで最も一般的に使用されます。[Details](../guide/plugins.md)
 
 ### registerModule
 
 - **`registerModule(path: string | Array<string>, module: Module, options?: Object)`**
 
-  動的なモジュールを登録します。[詳細](modules.md#dynamic-module-registration)
+  動的なモジュールを登録します。[詳細](../guide/modules.md#dynamic-module-registration)
 
   `options` は前の状態を保存する `preserveState: true` を持つことができます。サーバサイドレンダリングに役立ちます。
 
@@ -204,13 +204,13 @@ const store = new Vuex.Store({ ...options })
 
 - **`unregisterModule(path: string | Array<string>)`**
 
-  動的なモジュールを解除します。[詳細](modules.md#dynamic-module-registration)
+  動的なモジュールを解除します。[詳細](../guide/modules.md#dynamic-module-registration)
 
 ### hotUpdate
 
 - **`hotUpdate(newOptions: Object)`**
 
-  新しいアクションとミューテーションをホットスワップします。[詳細](hot-reload.md)
+  新しいアクションとミューテーションをホットスワップします。[詳細](../guide/hot-reload.md)
 
 ## コンポーネントをバインドするヘルパー
 
@@ -218,36 +218,36 @@ const store = new Vuex.Store({ ...options })
 
 - **`mapState(namespace?: string, map: Array<string> | Object): Object`**
 
-  ストアのサブツリーを返すコンポーネントの computed オプションを作成します。[詳細](state.md#the-mapstate-helper)
+  ストアのサブツリーを返すコンポーネントの computed オプションを作成します。[詳細](../guide/state.md#the-mapstate-helper)
 
-  第1引数は、オプションで名前空間文字列にすることができます。[詳細](modules.md#binding-helpers-with-namespace)
+  第1引数は、オプションで名前空間文字列にすることができます。[詳細](../guide/modules.md#binding-helpers-with-namespace)
 
 ### mapGetters
 
 - **`mapGetters(namespace?: string, map: Array<string> | Object): Object`**
 
-  ゲッターの評価後の値を返すコンポーネントの computed オプションを作成します。[詳細](getters.md#the-mapgetters-helper)
+  ゲッターの評価後の値を返すコンポーネントの computed オプションを作成します。[詳細](../guide/getters.md#the-mapgetters-helper)
 
-  第1引数は、オプションで名前空間文字列にすることができます。[詳細](modules.md#binding-helpers-with-namespace)
+  第1引数は、オプションで名前空間文字列にすることができます。[詳細](../guide/modules.md#binding-helpers-with-namespace)
 
 ### mapActions
 
 - **`mapActions(namespace?: string, map: Array<string> | Object): Object`**
 
-  アクションをディスパッチするコンポーネントの methods オプションを作成します。[詳細](actions.md#dispatching-actions-in-components)
+  アクションをディスパッチするコンポーネントの methods オプションを作成します。[詳細](../guide/actions.md#dispatching-actions-in-components)
 
-  第1引数は、オプションで名前空間文字列にすることができます。[詳細](modules.md#binding-helpers-with-namespace)
+  第1引数は、オプションで名前空間文字列にすることができます。[詳細](../guide/modules.md#binding-helpers-with-namespace)
 
 ### mapMutations
 
 - **`mapMutations(namespace?: string, map: Array<string> | Object): Object`**
 
-  ミューテーションをコミットするコンポーネントの methods オプションを作成します。[詳細](mutations.md#commiting-mutations-in-components)
+  ミューテーションをコミットするコンポーネントの methods オプションを作成します。[詳細](../guide/mutations.md#commiting-mutations-in-components)
 
-  第1引数は、オプションで名前空間文字列にすることができます。[詳細](modules.md#binding-helpers-with-namespace)
+  第1引数は、オプションで名前空間文字列にすることができます。[詳細](../guide/modules.md#binding-helpers-with-namespace)
 
 ### createNamespaceHelpers
 
 - **`createNamespacedHelpers(namespace: string): Object`**
 
-  名前空間付けられたコンポーネントバインディングのヘルパーを作成します。返されるオブジェクトは指定された名前空間にバインドされた `mapState`、`mapGetters`、`mapActions` そして `mapMutations` が含まれます。[詳細はこちら](modules.md#binding-helpers-with-namespace)
+  名前空間付けられたコンポーネントバインディングのヘルパーを作成します。返されるオブジェクトは指定された名前空間にバインドされた `mapState`、`mapGetters`、`mapActions` そして `mapMutations` が含まれます。[詳細はこちら](../guide/modules.md#binding-helpers-with-namespace)

+ 1 - 1
docs/ja/getting-started.md → docs/ja/guide/README.md

@@ -10,7 +10,7 @@ Vuex アプリケーションの中心にあるものは**ストア**です。"
 
 > **注意:** 私たちは、このドキュメントのコード例に ES2015 のシンタックスを利用しています。 もし触れたことがなければ、[ぜひ触れてください](https://babeljs.io/docs/learn-es2015/)!
 
-Vuex を[インストール](installation.md) してから、ストアをつくってみましょう。Vuex ストアの作成は、とても簡単です。ストアオブジェクトの初期状態と、いくつかのミューテーションを準備するだけです。
+Vuex を[インストール](../installation.md) してから、ストアをつくってみましょう。Vuex ストアの作成は、とても簡単です。ストアオブジェクトの初期状態と、いくつかのミューテーションを準備するだけです。
 
 ``` js
 // モジュールシステムを利用しているときはあらかじめ Vue.use(Vuex) を呼び出していることを確認しておいてください

+ 0 - 0
docs/ja/actions.md → docs/ja/guide/actions.md


+ 0 - 0
docs/ja/core-concepts.md → docs/ja/guide/core-concepts.md


+ 0 - 0
docs/ja/forms.md → docs/ja/guide/forms.md


+ 0 - 0
docs/ja/getters.md → docs/ja/guide/getters.md


+ 0 - 0
docs/ja/hot-reload.md → docs/ja/guide/hot-reload.md


+ 0 - 0
docs/ja/modules.md → docs/ja/guide/modules.md


+ 0 - 0
docs/ja/mutations.md → docs/ja/guide/mutations.md


+ 0 - 0
docs/ja/plugins.md → docs/ja/guide/plugins.md


+ 0 - 0
docs/ja/state.md → docs/ja/guide/state.md


+ 0 - 0
docs/ja/strict.md → docs/ja/guide/strict.md


+ 0 - 0
docs/ja/structure.md → docs/ja/guide/structure.md


+ 0 - 0
docs/ja/testing.md → docs/ja/guide/testing.md


+ 24 - 24
docs/zh/api.md → docs/zh/api/README.md

@@ -18,9 +18,9 @@ const store = new Vuex.Store({ ...options })
 
 - 类型: `Object | Function`
 
-  Vuex store 实例的根 state 对象。[详细介绍](state.md)
+  Vuex store 实例的根 state 对象。[详细介绍](../guide/state.md)
 
-  如果你传入返回一个对象的函数,其返回的对象会被用作根 state。这在你想要重用 state 对象,尤其是对于重用 module 来说非常有用。[详细介绍](modules.md#模块重用)
+  如果你传入返回一个对象的函数,其返回的对象会被用作根 state。这在你想要重用 state 对象,尤其是对于重用 module 来说非常有用。[详细介绍](../guide/modules.md#模块重用)
 
 ### mutations
 
@@ -28,7 +28,7 @@ const store = new Vuex.Store({ ...options })
 
   在 store 上注册 mutation,处理函数总是接受 `state` 作为第一个参数(如果定义在模块中,则为模块的局部状态),`payload` 作为第二个参数(可选)。
 
-  [详细介绍](mutations.md)
+  [详细介绍](../guide/mutations.md)
 
 ### actions
 
@@ -51,7 +51,7 @@ const store = new Vuex.Store({ ...options })
 
   同时如果有第二个参数 `payload` 的话也能够接收。
 
-  [详细介绍](actions.md)
+  [详细介绍](../guide/actions.md)
 
 ### getters
 
@@ -75,7 +75,7 @@ const store = new Vuex.Store({ ...options })
 
   注册的 getter 暴露为 `store.getters`。
 
-  [详细介绍](getters.md)
+  [详细介绍](../guide/getters.md)
 
 ### modules
 
@@ -99,7 +99,7 @@ const store = new Vuex.Store({ ...options })
 
   与根模块的选项一样,每个模块也包含 `state` 和 `mutations` 选项。模块的状态使用 key 关联到 store 的根状态。模块的 mutation 和 getter 只会接收 module 的局部状态作为第一个参数,而不是根状态,并且模块 action 的 `context.state` 同样指向局部状态。
 
-  [详细介绍](modules.md)
+  [详细介绍](../guide/modules.md)
 
 ### plugins
 
@@ -107,7 +107,7 @@ const store = new Vuex.Store({ ...options })
 
   一个数组,包含应用在 store 上的插件方法。这些插件直接接收 store 作为唯一参数,可以监听 mutation(用于外部地数据持久化、记录或调试)或者提交 mutation (用于内部数据,例如 websocket 或 某些观察者)
 
-  [详细介绍](plugins.md)
+  [详细介绍](../guide/plugins.md)
 
 ### strict
 
@@ -116,7 +116,7 @@ const store = new Vuex.Store({ ...options })
 
   使 Vuex store 进入严格模式,在严格模式下,任何 mutation 处理函数以外修改 Vuex state 都会抛出错误。
 
-  [详细介绍](strict.md)
+  [详细介绍](../guide/strict.md)
 
 ## Vuex.Store 实例属性
 
@@ -139,14 +139,14 @@ const store = new Vuex.Store({ ...options })
 - `commit(type: string, payload?: any, options?: Object)`
 - `commit(mutation: Object, options?: Object)`
 
-  提交 mutation。`options` 里可以有 `root: true`,它允许在[命名空间模块](modules.md#命名空间)里提交根的 mutation。[详细介绍](mutations.md)
+  提交 mutation。`options` 里可以有 `root: true`,它允许在[命名空间模块](../guide/modules.md#命名空间)里提交根的 mutation。[详细介绍](../guide/mutations.md)
 
 ### dispatch
 
 - `dispatch(type: string, payload?: any, options?: Object)`
 - `dispatch(action: Object, options?: Object)`
 
-  分发 action。`options` 里可以有 `root: true`,它允许在[命名空间模块](modules.md#命名空间)里分发根的 action。返回一个解析所有被触发的 action 处理器的 Promise。[详细介绍](actions.md)
+  分发 action。`options` 里可以有 `root: true`,它允许在[命名空间模块](../guide/modules.md#命名空间)里分发根的 action。返回一个解析所有被触发的 action 处理器的 Promise。[详细介绍](../guide/actions.md)
 
 ### replaceState
 
@@ -177,7 +177,7 @@ const store = new Vuex.Store({ ...options })
 
   要停止订阅,调用此方法返回的函数即可停止订阅。
 
-  通常用于插件。[详细介绍](plugins.md)
+  通常用于插件。[详细介绍](../guide/plugins.md)
 
 ### subscribeAction
 
@@ -196,13 +196,13 @@ const store = new Vuex.Store({ ...options })
 
   要停止订阅,调用此方法返回的函数即可停止订阅。
 
-  该功能常用于插件。[详细介绍](plugins.md)
+  该功能常用于插件。[详细介绍](../guide/plugins.md)
 
 ### registerModule
 
 - `registerModule(path: string | Array<string>, module: Module, options?: Object)`
 
-  注册一个动态模块。[详细介绍](modules.md#模块动态注册)
+  注册一个动态模块。[详细介绍](../guide/modules.md#模块动态注册)
 
   `options` 可以包含 `preserveState: true` 以允许保留之前的 state。用于服务端渲染。
 
@@ -210,13 +210,13 @@ const store = new Vuex.Store({ ...options })
 
 - `unregisterModule(path: string | Array<string>)`
 
-  卸载一个动态模块。[详细介绍](modules.md#模块动态注册)
+  卸载一个动态模块。[详细介绍](../guide/modules.md#模块动态注册)
 
 ### hotUpdate
 
 - `hotUpdate(newOptions: Object)`
 
-  热替换新的 action 和 mutation。[详细介绍](hot-reload.md)
+  热替换新的 action 和 mutation。[详细介绍](../guide/hot-reload.md)
 
 ## 组件绑定的辅助函数
 
@@ -224,9 +224,9 @@ const store = new Vuex.Store({ ...options })
 
 - `mapState(namespace?: string, map: Array<string> | Object<string | function>): Object`
 
-  为组件创建计算属性以返回 Vuex store 中的状态。[详细介绍](state.md#mapstate-辅助函数)
+  为组件创建计算属性以返回 Vuex store 中的状态。[详细介绍](../guide/state.md#mapstate-辅助函数)
 
-  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](modules.md#带命名空间的绑定函数)
+  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
 
   对象形式的第二个参数的成员可以是一个函数。`function(state: any)`
 
@@ -234,17 +234,17 @@ const store = new Vuex.Store({ ...options })
 
 - `mapGetters(namespace?: string, map: Array<string> | Object<string>): Object`
 
-  为组件创建计算属性以返回 getter 的返回值。[详细介绍](getters.md#mapgetters-辅助函数)
+  为组件创建计算属性以返回 getter 的返回值。[详细介绍](../guide/getters.md#mapgetters-辅助函数)
 
-  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](modules.md#带命名空间的绑定函数)
+  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
 
 ### mapActions
 
 - `mapActions(namespace?: string, map: Array<string> | Object<string | function>): Object`
 
-  创建组件方法分发 action。[详细介绍](actions.md#在组件中分发-action)
+  创建组件方法分发 action。[详细介绍](../guide/actions.md#在组件中分发-action)
 
-  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](modules.md#带命名空间的绑定函数)
+  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
 
   对象形式的第二个参数的成员可以是一个函数。`function(dispatch: function, ...args: any[])`
 
@@ -252,9 +252,9 @@ const store = new Vuex.Store({ ...options })
 
 - `mapMutations(namespace?: string, map: Array<string> | Object<string | function>): Object`
 
-  创建组件方法提交 mutation。[详细介绍](mutations.md#在组件中提交-mutation)
+  创建组件方法提交 mutation。[详细介绍](../guide/mutations.md#在组件中提交-mutation)
 
-  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](modules.md#带命名空间的绑定函数)
+  第一个参数是可选的,可以是一个命名空间字符串。[详细介绍](../guide/modules.md#带命名空间的绑定函数)
 
   对象形式的第二个参数的成员可以是一个函数。`function(commit: function, ...args: any[])`
 
@@ -262,4 +262,4 @@ const store = new Vuex.Store({ ...options })
 
 - `createNamespacedHelpers(namespace: string): Object`
 
-  创建基于命名空间的组件绑定辅助函数。其返回一个包含 `mapState`、`mapGetters`、`mapActions` 和 `mapMutations` 的对象。它们都已经绑定在了给定的命名空间上。[详细介绍](modules.md#带命名空间的绑定函数)
+  创建基于命名空间的组件绑定辅助函数。其返回一个包含 `mapState`、`mapGetters`、`mapActions` 和 `mapMutations` 的对象。它们都已经绑定在了给定的命名空间上。[详细介绍](../guide/modules.md#带命名空间的绑定函数)

+ 1 - 1
docs/zh/getting-started.md → docs/zh/guide/README.md

@@ -10,7 +10,7 @@
 
 > **提示:**我们将在后续的文档示例代码中使用 ES2015 语法。如果你还没能掌握 ES2015,[你得抓紧了](https://babeljs.io/docs/learn-es2015/)!
 
-[安装](installation.md) Vuex 之后,让我们来创建一个 store。创建过程直截了当——仅需要提供一个初始 state 对象和一些 mutation:
+[安装](../installation.md) Vuex 之后,让我们来创建一个 store。创建过程直截了当——仅需要提供一个初始 state 对象和一些 mutation:
 
 ``` js
 // 如果在模块化构建系统中,请确保在开头调用了 Vue.use(Vuex)

+ 0 - 0
docs/zh/actions.md → docs/zh/guide/actions.md


+ 0 - 0
docs/zh/core-concepts.md → docs/zh/guide/core-concepts.md


+ 0 - 0
docs/zh/forms.md → docs/zh/guide/forms.md


+ 0 - 0
docs/zh/getters.md → docs/zh/guide/getters.md


+ 0 - 0
docs/zh/hot-reload.md → docs/zh/guide/hot-reload.md


+ 0 - 0
docs/zh/modules.md → docs/zh/guide/modules.md


+ 0 - 0
docs/zh/mutations.md → docs/zh/guide/mutations.md


+ 0 - 0
docs/zh/plugins.md → docs/zh/guide/plugins.md


+ 0 - 0
docs/zh/state.md → docs/zh/guide/state.md


+ 0 - 0
docs/zh/strict.md → docs/zh/guide/strict.md


+ 0 - 0
docs/zh/structure.md → docs/zh/guide/structure.md


+ 0 - 0
docs/zh/testing.md → docs/zh/guide/testing.md