Added file protocol and HTML5 mode incompatibility mention in documentation (#565)

hugohil · yyx990803 · commit 67ba261ab013 · 2016-07-31T19:36:19.000-04:00
* Add english mention on file protocol and HTML5 mode

* Add gitbook required package to package.json dev dependencies
diff --git a/docs/en/options.md b/docs/en/options.md
@@ -17,6 +17,8 @@ There are a number of options you can use to customize the router behavior when
 
   **Note**: when using the history mode, the server needs to be [properly configured](http://readystate4.com/2012/05/17/nginx-and-apache-rewrite-to-support-html5-pushstate/) so that a user directly visiting a deep link on your site doesn't get a 404.
 
+  **Note**: if you plan to serve your files with the `file://` protocol (for example, when using with [Electron](electron.atom.io)), enabling this mode will break your app. That is because your app URLs would look like `file:///path/to/your/app/index.html/my-route/`, which makes no sense in UNIX filesystem architecture.
+
 ####  abstract
 
 - default: false
diff --git a/package.json b/package.json
@@ -48,6 +48,8 @@
     "es6-promise": "^3.0.2",
     "eslint": "^1.3.1",
     "express": "^4.12.3",
+    "gitbook-plugin-edit-link": "^2.0.2",
+    "gitbook-plugin-github": "^2.0.0",
     "istanbul-instrumenter-loader": "^0.1.3",
     "jasmine-core": "^2.3.2",
     "karma": "^0.13.8",
