docs: add troubleshooting

marcoieni · marcoieni · commit 17f6a4e6077b · 2020-09-14T20:34:01.000+02:00
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -0,0 +1,28 @@
+---
+id: troubleshooting
+title: Troubleshooting
+sidebar_label: Troubleshooting
+---
+
+## Error "␣ is undefined" when pressing SPC SPC
+
+When pressing `SPC SPC` quickly on Mac OS, most of the time it doesn't recognize
+the second `SPC` and the error "␣ is undefined" is raised.
+
+This problem is due to this setting of mac os:
+
+![Mac keyboard preferences](/img/docs/mac_double_space.png)
+
+If you don't use this feature, you can just disable it and you are done.
+Otherwise add the following to your `settings.json`:
+
+```json
+"vspacecode.bindingOverrides": [
+    {
+        "keys": ["."],
+        "name": "Commands...",
+        "type": "command",
+        "command": "workbench.action.showCommands"
+    }
+],
+```
diff --git a/sidebars.js b/sidebars.js
@@ -1,6 +1,6 @@
 module.exports = {
   someSidebar: {
-    Docusaurus: ['doc1', 'doc2', 'doc3'],
+    Docusaurus: ['doc1', 'doc2', 'doc3', 'troubleshooting'],
     Features: ['mdx'],
   },
 };
diff --git a/static/img/docs/mac_double_space.png b/static/img/docs/mac_double_space.png
