Bladeren bron

scaffolding docs

Evan You 9 jaren geleden
bovenliggende
commit
ce6cd50113
13 gewijzigde bestanden met toevoegingen van 34 en 1 verwijderingen
  1. 1 0
      .gitignore
  2. 1 0
      docs/LANGS.md
  3. 22 0
      docs/en/README.md
  4. 8 0
      docs/en/SUMMARY.md
  5. 0 0
      docs/en/actions.md
  6. 0 0
      docs/en/concepts.md
  7. 0 0
      docs/en/debug.md
  8. 0 0
      docs/en/hot-reload.md
  9. 0 0
      docs/en/middlewares.md
  10. 0 0
      docs/en/mutations.md
  11. 0 0
      docs/en/state.md
  12. 0 0
      docs/en/structure.md
  13. 2 1
      package.json

+ 1 - 0
.gitignore

@@ -2,3 +2,4 @@
 node_modules
 TODO.md
 lib
+docs/_book

+ 1 - 0
docs/LANGS.md

@@ -0,0 +1 @@
+* [English](en/)

+ 22 - 0
docs/en/README.md

@@ -0,0 +1,22 @@
+## What is Vuex?
+
+A state management library.
+
+And an application architecture for Vue.js.
+
+## Principles
+
+- Terse
+- Testable
+- Reactive
+- Single State Tree
+- Hot Reloading
+- Time Travel
+
+## Difference from Redux/Flux
+
+- Simplified concepts.
+
+- Specifically built for Vue.js, therefore reactive by default. Super simple for components to bind to state.
+
+- Doesn't enforce immutability, but retains the same benefits of hot reloading and time travel debugging.

+ 8 - 0
docs/en/SUMMARY.md

@@ -0,0 +1,8 @@
+- [Core Concepts](concepts.md)
+  - [State](state.md)
+  - [Actions](actions.md)
+  - [Mutations](mutations.md)
+- [Application Structure](structure.md)
+- [Debug Mode](debug.md)
+- [Middlewares](middlewares.md)
+- [Hot Reloading](hot-reload.md)

+ 0 - 0
docs/en/actions.md


+ 0 - 0
docs/en/concepts.md


+ 0 - 0
docs/en/debug.md


+ 0 - 0
docs/en/hot-reload.md


+ 0 - 0
docs/en/middlewares.md


+ 0 - 0
docs/en/mutations.md


+ 0 - 0
docs/en/state.md


+ 0 - 0
docs/en/structure.md


+ 2 - 1
package.json

@@ -13,7 +13,8 @@
     "todomvc": "cd examples/todomvc && webpack-dev-server --inline --hot --config ../webpack.shared.config.js",
     "cart": "cd examples/shopping-cart && webpack-dev-server --inline --hot --config ../webpack.shared.config.js",
     "prepublish": "babel src --out-dir lib --presets es2015 --plugins add-module-exports",
-    "test": "eslint src && mocha --compilers js:babel-core/register"
+    "test": "eslint src && mocha --compilers js:babel-core/register",
+    "docs": "cd docs && gitbook serve"
   },
   "repository": {
     "type": "git",