[docs] using vuepress (vuejs#1277)

alcrabie · May 21, 2018 · 2a91153 · 2a91153
1 parent d1a1d01
commit 2a91153
Show file tree

Hide file tree

Showing 164 changed files with 8,314 additions and 3,052 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,7 @@
 node_modules
 TODO.md
 lib
-docs/_book
+docs/.vuepress/dist
 examples/**/build.js
 types/typings
 types/test/*.js

diff --git a/docs/LANGS.md → docs-gitbook/LANGS.md b/docs/LANGS.md → docs-gitbook/LANGS.md
diff --git a/docs/assets/CNAME → docs-gitbook/assets/CNAME b/docs/assets/CNAME → docs-gitbook/assets/CNAME
diff --git a/docs/assets/circle.yml → docs-gitbook/assets/circle.yml b/docs/assets/circle.yml → docs-gitbook/assets/circle.yml
diff --git a/docs/assets/vuex.ai → docs-gitbook/assets/vuex.ai b/docs/assets/vuex.ai → docs-gitbook/assets/vuex.ai
diff --git a/docs/book.json → docs-gitbook/book.json b/docs/book.json → docs-gitbook/book.json
diff --git a/docs/en/book.json → docs-gitbook/en/book.json b/docs/en/book.json → docs-gitbook/en/book.json
diff --git a/docs/en/README.md → docs-gitbook/fr/README.md b/docs/en/README.md → docs-gitbook/fr/README.md
diff --git a/docs/fr/SUMMARY.md → docs-gitbook/fr/SUMMARY.md b/docs/fr/SUMMARY.md → docs-gitbook/fr/SUMMARY.md
diff --git a/docs/fr/actions.md → docs-gitbook/fr/actions.md b/docs/fr/actions.md → docs-gitbook/fr/actions.md
diff --git a/docs/fr/api.md → docs-gitbook/fr/api.md b/docs/fr/api.md → docs-gitbook/fr/api.md
diff --git a/docs/fr/book.json → docs-gitbook/fr/book.json b/docs/fr/book.json → docs-gitbook/fr/book.json
diff --git a/docs/fr/core-concepts.md → docs-gitbook/fr/core-concepts.md b/docs/fr/core-concepts.md → docs-gitbook/fr/core-concepts.md
diff --git a/docs/fr/forms.md → docs-gitbook/fr/forms.md b/docs/fr/forms.md → docs-gitbook/fr/forms.md
diff --git a/docs/fr/getters.md → docs-gitbook/fr/getters.md b/docs/fr/getters.md → docs-gitbook/fr/getters.md
diff --git a/docs/fr/getting-started.md → docs-gitbook/fr/getting-started.md b/docs/fr/getting-started.md → docs-gitbook/fr/getting-started.md
diff --git a/docs/fr/hot-reload.md → docs-gitbook/fr/hot-reload.md b/docs/fr/hot-reload.md → docs-gitbook/fr/hot-reload.md
diff --git a/docs/fr/images/flow.png → docs-gitbook/fr/images/flow.png b/docs/fr/images/flow.png → docs-gitbook/fr/images/flow.png
diff --git a/docs/fr/images/vuex.png → docs-gitbook/fr/images/vuex.png b/docs/fr/images/vuex.png → docs-gitbook/fr/images/vuex.png
diff --git a/docs/fr/installation.md → docs-gitbook/fr/installation.md b/docs/fr/installation.md → docs-gitbook/fr/installation.md
diff --git a/docs/fr/intro.md → docs-gitbook/fr/intro.md b/docs/fr/intro.md → docs-gitbook/fr/intro.md
diff --git a/docs/fr/modules.md → docs-gitbook/fr/modules.md b/docs/fr/modules.md → docs-gitbook/fr/modules.md
diff --git a/docs/fr/mutations.md → docs-gitbook/fr/mutations.md b/docs/fr/mutations.md → docs-gitbook/fr/mutations.md
diff --git a/docs/fr/plugins.md → docs-gitbook/fr/plugins.md b/docs/fr/plugins.md → docs-gitbook/fr/plugins.md
diff --git a/docs/fr/state.md → docs-gitbook/fr/state.md b/docs/fr/state.md → docs-gitbook/fr/state.md
diff --git a/docs/fr/strict.md → docs-gitbook/fr/strict.md b/docs/fr/strict.md → docs-gitbook/fr/strict.md
diff --git a/docs/fr/structure.md → docs-gitbook/fr/structure.md b/docs/fr/structure.md → docs-gitbook/fr/structure.md
diff --git a/docs/fr/testing.md → docs-gitbook/fr/testing.md b/docs/fr/testing.md → docs-gitbook/fr/testing.md
diff --git a/docs/gitbook/images/favicon.ico → docs-gitbook/gitbook/images/favicon.ico b/docs/gitbook/images/favicon.ico → docs-gitbook/gitbook/images/favicon.ico
diff --git a/docs/ja/README.md → docs-gitbook/ja/README.md b/docs/ja/README.md → docs-gitbook/ja/README.md
diff --git a/docs/ja/SUMMARY.md → docs-gitbook/ja/SUMMARY.md b/docs/ja/SUMMARY.md → docs-gitbook/ja/SUMMARY.md
diff --git a/docs/ja/actions.md → docs-gitbook/ja/actions.md b/docs/ja/actions.md → docs-gitbook/ja/actions.md
diff --git a/docs/ja/api.md → docs-gitbook/ja/api.md b/docs/ja/api.md → docs-gitbook/ja/api.md
diff --git a/docs/ja/book.json → docs-gitbook/ja/book.json b/docs/ja/book.json → docs-gitbook/ja/book.json
diff --git a/docs/ja/core-concepts.md → docs-gitbook/ja/core-concepts.md b/docs/ja/core-concepts.md → docs-gitbook/ja/core-concepts.md
diff --git a/docs/ja/forms.md → docs-gitbook/ja/forms.md b/docs/ja/forms.md → docs-gitbook/ja/forms.md
diff --git a/docs/ja/getters.md → docs-gitbook/ja/getters.md b/docs/ja/getters.md → docs-gitbook/ja/getters.md
diff --git a/docs/ja/getting-started.md → docs-gitbook/ja/getting-started.md b/docs/ja/getting-started.md → docs-gitbook/ja/getting-started.md
diff --git a/docs/ja/hot-reload.md → docs-gitbook/ja/hot-reload.md b/docs/ja/hot-reload.md → docs-gitbook/ja/hot-reload.md
diff --git a/docs/en/images/flow.png → docs-gitbook/ja/images/flow.png b/docs/en/images/flow.png → docs-gitbook/ja/images/flow.png
diff --git a/docs/en/images/vuex.png → docs-gitbook/ja/images/vuex.png b/docs/en/images/vuex.png → docs-gitbook/ja/images/vuex.png
diff --git a/docs/ja/installation.md → docs-gitbook/ja/installation.md b/docs/ja/installation.md → docs-gitbook/ja/installation.md
diff --git a/docs/ja/intro.md → docs-gitbook/ja/intro.md b/docs/ja/intro.md → docs-gitbook/ja/intro.md
diff --git a/docs/ja/modules.md → docs-gitbook/ja/modules.md b/docs/ja/modules.md → docs-gitbook/ja/modules.md
diff --git a/docs/ja/mutations.md → docs-gitbook/ja/mutations.md b/docs/ja/mutations.md → docs-gitbook/ja/mutations.md
diff --git a/docs/ja/plugins.md → docs-gitbook/ja/plugins.md b/docs/ja/plugins.md → docs-gitbook/ja/plugins.md
diff --git a/docs/ja/state.md → docs-gitbook/ja/state.md b/docs/ja/state.md → docs-gitbook/ja/state.md
diff --git a/docs/ja/strict.md → docs-gitbook/ja/strict.md b/docs/ja/strict.md → docs-gitbook/ja/strict.md
diff --git a/docs/ja/structure.md → docs-gitbook/ja/structure.md b/docs/ja/structure.md → docs-gitbook/ja/structure.md
diff --git a/docs/ja/testing.md → docs-gitbook/ja/testing.md b/docs/ja/testing.md → docs-gitbook/ja/testing.md
diff --git a/docs/kr/README.md → docs-gitbook/kr/README.md b/docs/kr/README.md → docs-gitbook/kr/README.md
diff --git a/docs/kr/SUMMARY.md → docs-gitbook/kr/SUMMARY.md b/docs/kr/SUMMARY.md → docs-gitbook/kr/SUMMARY.md
diff --git a/docs/kr/actions.md → docs-gitbook/kr/actions.md b/docs/kr/actions.md → docs-gitbook/kr/actions.md
diff --git a/docs/kr/api.md → docs-gitbook/kr/api.md b/docs/kr/api.md → docs-gitbook/kr/api.md
diff --git a/docs/kr/book.json → docs-gitbook/kr/book.json b/docs/kr/book.json → docs-gitbook/kr/book.json
diff --git a/docs/kr/forms.md → docs-gitbook/kr/forms.md b/docs/kr/forms.md → docs-gitbook/kr/forms.md
diff --git a/docs/kr/getters.md → docs-gitbook/kr/getters.md b/docs/kr/getters.md → docs-gitbook/kr/getters.md
diff --git a/docs/kr/getting-started.md → docs-gitbook/kr/getting-started.md b/docs/kr/getting-started.md → docs-gitbook/kr/getting-started.md
diff --git a/docs/kr/hot-reload.md → docs-gitbook/kr/hot-reload.md b/docs/kr/hot-reload.md → docs-gitbook/kr/hot-reload.md
diff --git a/docs/ja/images/flow.png → docs-gitbook/kr/images/flow.png b/docs/ja/images/flow.png → docs-gitbook/kr/images/flow.png
diff --git a/docs/ja/images/vuex.png → docs-gitbook/kr/images/vuex.png b/docs/ja/images/vuex.png → docs-gitbook/kr/images/vuex.png
diff --git a/docs/kr/installation.md → docs-gitbook/kr/installation.md b/docs/kr/installation.md → docs-gitbook/kr/installation.md
diff --git a/docs/kr/intro.md → docs-gitbook/kr/intro.md b/docs/kr/intro.md → docs-gitbook/kr/intro.md
diff --git a/docs/kr/modules.md → docs-gitbook/kr/modules.md b/docs/kr/modules.md → docs-gitbook/kr/modules.md
diff --git a/docs/kr/mutations.md → docs-gitbook/kr/mutations.md b/docs/kr/mutations.md → docs-gitbook/kr/mutations.md
diff --git a/docs/kr/plugins.md → docs-gitbook/kr/plugins.md b/docs/kr/plugins.md → docs-gitbook/kr/plugins.md
diff --git a/docs/kr/state.md → docs-gitbook/kr/state.md b/docs/kr/state.md → docs-gitbook/kr/state.md
diff --git a/docs/kr/strict.md → docs-gitbook/kr/strict.md b/docs/kr/strict.md → docs-gitbook/kr/strict.md
diff --git a/docs/kr/structure.md → docs-gitbook/kr/structure.md b/docs/kr/structure.md → docs-gitbook/kr/structure.md
diff --git a/docs/kr/testing.md → docs-gitbook/kr/testing.md b/docs/kr/testing.md → docs-gitbook/kr/testing.md
diff --git a/docs/old/README.md → docs-gitbook/old/README.md b/docs/old/README.md → docs-gitbook/old/README.md
diff --git a/docs/old/SUMMARY.md → docs-gitbook/old/SUMMARY.md b/docs/old/SUMMARY.md → docs-gitbook/old/SUMMARY.md
diff --git a/docs/fr/README.md → docs-gitbook/pt-br/README.md b/docs/fr/README.md → docs-gitbook/pt-br/README.md
diff --git a/docs/pt-br/SUMMARY.md → docs-gitbook/pt-br/SUMMARY.md b/docs/pt-br/SUMMARY.md → docs-gitbook/pt-br/SUMMARY.md
diff --git a/docs/pt-br/actions.md → docs-gitbook/pt-br/actions.md b/docs/pt-br/actions.md → docs-gitbook/pt-br/actions.md
diff --git a/docs/pt-br/api.md → docs-gitbook/pt-br/api.md b/docs/pt-br/api.md → docs-gitbook/pt-br/api.md
diff --git a/docs/pt-br/book.json → docs-gitbook/pt-br/book.json b/docs/pt-br/book.json → docs-gitbook/pt-br/book.json
diff --git a/docs/pt-br/core-concepts.md → docs-gitbook/pt-br/core-concepts.md b/docs/pt-br/core-concepts.md → docs-gitbook/pt-br/core-concepts.md
diff --git a/docs/pt-br/forms.md → docs-gitbook/pt-br/forms.md b/docs/pt-br/forms.md → docs-gitbook/pt-br/forms.md
diff --git a/docs/pt-br/getters.md → docs-gitbook/pt-br/getters.md b/docs/pt-br/getters.md → docs-gitbook/pt-br/getters.md
diff --git a/docs/pt-br/getting-started.md → docs-gitbook/pt-br/getting-started.md b/docs/pt-br/getting-started.md → docs-gitbook/pt-br/getting-started.md
diff --git a/docs/pt-br/hot-reload.md → docs-gitbook/pt-br/hot-reload.md b/docs/pt-br/hot-reload.md → docs-gitbook/pt-br/hot-reload.md
diff --git a/docs/pt-br/images/flow.png → docs-gitbook/pt-br/images/flow.png b/docs/pt-br/images/flow.png → docs-gitbook/pt-br/images/flow.png
diff --git a/docs/pt-br/images/vuex.png → docs-gitbook/pt-br/images/vuex.png b/docs/pt-br/images/vuex.png → docs-gitbook/pt-br/images/vuex.png
diff --git a/docs/pt-br/installation.md → docs-gitbook/pt-br/installation.md b/docs/pt-br/installation.md → docs-gitbook/pt-br/installation.md
diff --git a/docs/pt-br/intro.md → docs-gitbook/pt-br/intro.md b/docs/pt-br/intro.md → docs-gitbook/pt-br/intro.md
diff --git a/docs/pt-br/modules.md → docs-gitbook/pt-br/modules.md b/docs/pt-br/modules.md → docs-gitbook/pt-br/modules.md
diff --git a/docs/pt-br/mutations.md → docs-gitbook/pt-br/mutations.md b/docs/pt-br/mutations.md → docs-gitbook/pt-br/mutations.md
diff --git a/docs/pt-br/plugins.md → docs-gitbook/pt-br/plugins.md b/docs/pt-br/plugins.md → docs-gitbook/pt-br/plugins.md
diff --git a/docs/pt-br/state.md → docs-gitbook/pt-br/state.md b/docs/pt-br/state.md → docs-gitbook/pt-br/state.md
diff --git a/docs/pt-br/strict.md → docs-gitbook/pt-br/strict.md b/docs/pt-br/strict.md → docs-gitbook/pt-br/strict.md
diff --git a/docs/pt-br/structure.md → docs-gitbook/pt-br/structure.md b/docs/pt-br/structure.md → docs-gitbook/pt-br/structure.md
diff --git a/docs/pt-br/testing.md → docs-gitbook/pt-br/testing.md b/docs/pt-br/testing.md → docs-gitbook/pt-br/testing.md
diff --git a/docs/pt-br/README.md → docs-gitbook/ru/README.md b/docs/pt-br/README.md → docs-gitbook/ru/README.md
diff --git a/docs/ru/SUMMARY.md → docs-gitbook/ru/SUMMARY.md b/docs/ru/SUMMARY.md → docs-gitbook/ru/SUMMARY.md
diff --git a/docs/ru/actions.md → docs-gitbook/ru/actions.md b/docs/ru/actions.md → docs-gitbook/ru/actions.md
diff --git a/docs/ru/api.md → docs-gitbook/ru/api.md b/docs/ru/api.md → docs-gitbook/ru/api.md
diff --git a/docs/ru/book.json → docs-gitbook/ru/book.json b/docs/ru/book.json → docs-gitbook/ru/book.json
diff --git a/docs/ru/core-concepts.md → docs-gitbook/ru/core-concepts.md b/docs/ru/core-concepts.md → docs-gitbook/ru/core-concepts.md
diff --git a/docs/ru/forms.md → docs-gitbook/ru/forms.md b/docs/ru/forms.md → docs-gitbook/ru/forms.md
diff --git a/docs/ru/getters.md → docs-gitbook/ru/getters.md b/docs/ru/getters.md → docs-gitbook/ru/getters.md
diff --git a/docs/ru/getting-started.md → docs-gitbook/ru/getting-started.md b/docs/ru/getting-started.md → docs-gitbook/ru/getting-started.md
diff --git a/docs/ru/hot-reload.md → docs-gitbook/ru/hot-reload.md b/docs/ru/hot-reload.md → docs-gitbook/ru/hot-reload.md
diff --git a/docs/ru/images/flow.png → docs-gitbook/ru/images/flow.png b/docs/ru/images/flow.png → docs-gitbook/ru/images/flow.png
diff --git a/docs/ru/images/vuex.png → docs-gitbook/ru/images/vuex.png b/docs/ru/images/vuex.png → docs-gitbook/ru/images/vuex.png
diff --git a/docs/ru/installation.md → docs-gitbook/ru/installation.md b/docs/ru/installation.md → docs-gitbook/ru/installation.md
diff --git a/docs/ru/intro.md → docs-gitbook/ru/intro.md b/docs/ru/intro.md → docs-gitbook/ru/intro.md
diff --git a/docs/ru/modules.md → docs-gitbook/ru/modules.md b/docs/ru/modules.md → docs-gitbook/ru/modules.md
diff --git a/docs/ru/mutations.md → docs-gitbook/ru/mutations.md b/docs/ru/mutations.md → docs-gitbook/ru/mutations.md
diff --git a/docs/ru/plugins.md → docs-gitbook/ru/plugins.md b/docs/ru/plugins.md → docs-gitbook/ru/plugins.md
diff --git a/docs/ru/state.md → docs-gitbook/ru/state.md b/docs/ru/state.md → docs-gitbook/ru/state.md
diff --git a/docs/ru/strict.md → docs-gitbook/ru/strict.md b/docs/ru/strict.md → docs-gitbook/ru/strict.md
diff --git a/docs/ru/structure.md → docs-gitbook/ru/structure.md b/docs/ru/structure.md → docs-gitbook/ru/structure.md
diff --git a/docs/ru/testing.md → docs-gitbook/ru/testing.md b/docs/ru/testing.md → docs-gitbook/ru/testing.md
diff --git a/docs/zh-cn/book.json → docs-gitbook/zh-cn/book.json b/docs/zh-cn/book.json → docs-gitbook/zh-cn/book.json
diff --git a/docs/kr/images/flow.png → docs-gitbook/zh-cn/images/flow.png b/docs/kr/images/flow.png → docs-gitbook/zh-cn/images/flow.png
diff --git a/docs/kr/images/vuex.png → docs-gitbook/zh-cn/images/vuex.png b/docs/kr/images/vuex.png → docs-gitbook/zh-cn/images/vuex.png
diff --git a/docs/.vuepress/_redirects b/docs/.vuepress/_redirects
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,104 @@
+module.exports = {
+  locales: {
+    '/': {
+      lang: 'en-US',
+      title: 'Vuex',
+      description: 'Centralized State Management for Vue.js'
+    },
+    '/zh/': {
+      lang: 'zh-CN',
+      title: 'Vuex',
+      description: 'Vue.js 的中心化状态管理方案'
+    }
+  },
+  serviceWorker: true,
+  theme: 'vue',
+  themeConfig: {
+    repo: 'vuejs/vuex',
+    docsDir: 'docs',
+    locales: {
+      '/': {
+        label: 'English',
+        selectText: 'Languages',
+        editLinkText: 'Edit this page on GitHub',
+        nav: [
+          {
+            text: 'Getting Started',
+            link: '/getting-started'
+          },
+          {
+            text: 'API Reference',
+            link: '/api'
+          },
+          {
+            text: 'Release Notes',
+            link: 'https://github.com/vuejs/vuex/releases'
+          }
+        ],
+        sidebar: [
+          '/installation',
+          '/',
+          '/getting-started',
+          {
+            title: 'Core Concepts',
+            collapsable: false,
+            children: [
+              '/state',
+              '/getters',
+              '/mutations',
+              '/actions',
+              '/modules'
+            ]
+          },
+          '/structure',
+          '/plugins',
+          '/strict',
+          '/forms',
+          '/testing',
+          '/hot-reload'
+        ]
+      },
+      '/zh/': {
+        label: '简体中文',
+        selectText: '选择语言',
+        editLinkText: '在 GitHub 上编辑此页',
+        nav: [
+          {
+            text: '指南',
+            link: '/zh/getting-started'
+          },
+          {
+            text: 'API 参考',
+            link: '/zh/api'
+          },
+          {
+            text: '更新记录',
+            link: 'https://github.com/vuejs/vuex/releases'
+          }
+        ],
+        sidebar: [
+          '/zh/installation',
+          '/zh/',
+          '/zh/getting-started',
+          {
+            title: '核心概念',
+            collapsable: false,
+            children: [
+              '/zh/state',
+              '/zh/getters',
+              '/zh/mutations',
+              '/zh/actions',
+              '/zh/modules'
+            ]
+          },
+          '/zh/structure',
+          '/zh/plugins',
+          '/zh/strict',
+          '/zh/forms',
+          '/zh/testing',
+          '/zh/hot-reload'
+        ]
+      }
+    }
+  }
+}
diff --git a/docs/zh-cn/images/flow.png → docs/.vuepress/public/flow.png b/docs/zh-cn/images/flow.png → docs/.vuepress/public/flow.png
diff --git a/docs/zh-cn/images/vuex.png → docs/.vuepress/public/vuex.png b/docs/zh-cn/images/vuex.png → docs/.vuepress/public/vuex.png
diff --git a/docs/en/intro.md → docs/README.md b/docs/en/intro.md → docs/README.md
@@ -36,7 +36,7 @@ It is a self-contained app with the following parts:
 This is an extremely simple representation of the concept of "one-way data flow":
 
 <p style="text-align: center; margin: 2em">
-  <img style="width:100%;max-width:450px;" src="./images/flow.png">
+  <img style="width:100%;max-width:450px;" src="/flow.png">
 </p>
 
 However, the simplicity quickly breaks down when we have **multiple components that share common state**:
@@ -52,7 +52,7 @@ In addition, by defining and separating the concepts involved in state managemen
 
 This is the basic idea behind Vuex, inspired by [Flux](https://facebook.github.io/flux/docs/overview.html), [Redux](http://redux.js.org/) and [The Elm Architecture](https://guide.elm-lang.org/architecture/). Unlike the other patterns, Vuex is also a library implementation tailored specifically for Vue.js to take advantage of its granular reactivity system for efficient updates.
 
-![vuex](./images/vuex.png)
+![vuex](/vuex.png)
 
 ### When Should I Use It?
 

diff --git a/docs/en/actions.md → docs/actions.md b/docs/en/actions.md → docs/actions.md
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,263 @@
+---
+sidebar: auto
+---
+
+# API Reference
+
+## Vuex.Store
+
+``` js
+import Vuex from 'vuex'
+
+const store = new Vuex.Store({ ...options })
+```
+
+## Vuex.Store Constructor Options
+
+### state
+
+- type: `Object | Function`
+
+  The root state object for the Vuex store. [Details](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)
+
+### mutations
+
+- type: `{ [type: string]: Function }`
+
+  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)
+
+### actions
+
+- type: `{ [type: string]: Function }`
+
+  Register actions on the store. The handler function receives a `context` object that exposes the following properties:
+
+  ``` js
+  {
+    state,      // same as `store.state`, or local state if in modules
+    rootState,  // same as `store.state`, only in modules
+    commit,     // same as `store.commit`
+    dispatch,   // same as `store.dispatch`
+    getters,    // same as `store.getters`, or local getters if in modules
+    rootGetters // same as `store.getters`, only in modules
+  }
+  ```
+
+  And also receives a second `payload` argument if there is one.
+
+  [Details](actions.md)
+
+### getters
+
+- type: `{ [key: string]: Function }`
+
+  Register getters on the store. The getter function receives the following arguments:
+
+  ```
+  state,     // will be module local state if defined in a module.
+  getters    // same as store.getters
+  ```
+
+  Specific when defined in a module
+
+  ```
+  state,       // will be module local state if defined in a module.
+  getters,     // module local getters of the current module
+  rootState,   // global state
+  rootGetters  // all getters
+  ```
+
+  Registered getters are exposed on `store.getters`.
+
+  [Details](getters.md)
+
+### modules
+
+- type: `Object`
+
+  An object containing sub modules to be merged into the store, in the shape of:
+
+  ``` js
+  {
+    key: {
+      state,
+      namespaced?,
+      mutations?,
+      actions?,
+      getters?,
+      modules?
+    },
+    ...
+  }
+  ```
+
+  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)
+
+### plugins
+
+- type: `Array<Function>`
+
+  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)
+
+### strict
+
+- type: `Boolean`
+- default: `false`
+
+  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)
+
+## Vuex.Store Instance Properties
+
+### state
+
+- type: `Object`
+
+  The root state. Read only.
+
+### getters
+
+- type: `Object`
+
+  Exposes registered getters. Read only.
+
+## Vuex.Store Instance Methods
+
+### commit
+
+-  `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)
+
+### 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)
+
+### replaceState
+
+-  `replaceState(state: Object)`
+
+  Replace the store's root state. Use this only for state hydration / time-travel purposes.
+
+### watch
+
+-  `watch(fn: Function, callback: Function, options?: Object): Function`
+
+  Reactively watch `fn`'s return value, and call the callback when the value changes. `fn` receives the store's state as the first argument, and getters as the second argument. Accepts an optional options object that takes the same options as Vue's `vm.$watch` method.
+
+  To stop watching, call the returned unwatch function.
+
+### subscribe
+
+-  `subscribe(handler: Function): Function`
+
+  Subscribe to store mutations. The `handler` is called after every mutation and receives the mutation descriptor and post-mutation state as arguments:
+
+  ``` js
+  store.subscribe((mutation, state) => {
+    console.log(mutation.type)
+    console.log(mutation.payload)
+  })
+  ```
+
+  To stop subscribing, call the returned unsubscribe function.
+
+  Most commonly used in plugins. [Details](plugins.md)
+
+### subscribeAction
+
+-  `subscribeAction(handler: Function): Function`
+
+  > New in 2.5.0
+
+  Subscribe to store actions. The `handler` is called for every dispatched action and receives the action descriptor and current store state as arguments:
+
+  ``` js
+  store.subscribeAction((action, state) => {
+    console.log(action.type)
+    console.log(action.payload)
+  })
+  ```
+
+  To stop subscribing, call the returned unsubscribe function.
+
+  Most commonly used in plugins. [Details](plugins.md)
+
+### registerModule
+
+-  `registerModule(path: string | Array<string>, module: Module, options?: Object)`
+
+  Register a dynamic module. [Details](modules.md#dynamic-module-registration)
+
+  `options` can have `preserveState: true` that allows to preserve the previous state. Useful with Server Side Rendering.
+
+### unregisterModule
+
+-  `unregisterModule(path: string | Array<string>)`
+
+  Unregister a dynamic module. [Details](modules.md#dynamic-module-registration)
+
+### hotUpdate
+
+-  `hotUpdate(newOptions: Object)`
+
+  Hot swap new actions and mutations. [Details](hot-reload.md)
+
+## Component Binding Helpers
+
+### mapState
+
+-  `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)
+
+  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)` 
+
+### 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)
+
+  The first argument can optionally be a namespace string. [Details](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)
+
+  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)
+
+  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)
diff --git a/docs/en/core-concepts.md → docs/core-concepts.md b/docs/en/core-concepts.md → docs/core-concepts.md