add ci: markdown lint (#27)

marcoieni · web-flow · commit 6cfd297fc3ba · 2021-01-13T14:20:23.000-08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,17 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches: [master, vspacecode-next, which-key-next]
+  pull_request:
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Lint all files recursively
+        uses: avto-dev/markdown-lint@v1
+        with:
+          config: '.markdownlint.yaml' 
+          args: "'**/*.md' --ignore node_modules --ignore docs/default-keybindings.md"
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,24 @@
+---
+# allow tabs only in code blocks
+MD010:
+  code_blocks: false
+
+# Use `#` for headers
+MD003:
+  style: atx
+
+# Set maximum line length
+MD013:
+  line_length: 150
+
+# Use `---` for horizontal rule
+MD035:
+  style: ---
+
+# Use ``` for code blocks
+MD046:
+  style: fenced
+MD048:
+  style: backtick
+
+# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for additional info
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,10 +1,12 @@
 # Contributing
 
-This website contains the [VSpaceCode](https://github.com/VSpaceCode/VSpaceCode) and [Which Key](https://github.com/VSpaceCode/vscode-which-key) extensions documentation.
+This website contains the [VSpaceCode](https://github.com/VSpaceCode/VSpaceCode) and
+[Which Key](https://github.com/VSpaceCode/vscode-which-key) extensions documentation.
 
 ## Branches
 
 There are three branches:
+
 - `vspacecode-next`: contains the doc for the upcoming changes of VSpaceCode extension
 - `which-key-next`: contains the doc for the upcoming changes of WhichKey extension
 - `master`: it is used to build the website
diff --git a/README.md b/README.md
@@ -2,24 +2,24 @@
 
 This website is built using the [Docusaurus 2](https://v2.docusaurus.io/) static website generator.
 
-### Installation
+## Installation
 
-```
-$ npm install
+```sh
+npm install
 ```
 
-### Local Development
+## Local Development
 
-```
-$ npm start
+```sh
+npm start
 ```
 
 This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
 
-### Build
+## Build
 
-```
-$ npm run build
+```sh
+npm run build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
diff --git a/blog/2020-09-18-hello.md b/blog/2020-09-18-hello.md
@@ -42,7 +42,9 @@ If you have any doubts about this, just open an issue on GitHub, you can check b
 yourself that at the moment, me and Steven are really active and we do our best
 to answer.
 
-You will see some issues labeled as [good first issues](https://github.com/VSpaceCode/VSpaceCode/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) on all the projects of the [VSpaceCode](https://github.com/VSpaceCode)
+You will see some issues labeled as
+[good first issues](https://github.com/VSpaceCode/VSpaceCode/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+on all the projects of the [VSpaceCode](https://github.com/VSpaceCode)
 GitHub organization. Look at those first, if you are just starting 😉
 
 Goodbye, and enjoy using VSpaceCode! ‍🧑‍🚀
diff --git a/docs/bonus.md b/docs/bonus.md
@@ -7,7 +7,8 @@ This section contains additional config that might be helpful beyond the default
 
 ## Quick Window Navigation
 
-To navigate all the windows including slide and bottom pane with `Ctrl-h/j/k/l`, you can merge the following config system's key bindings to your `keybindings.json` file.
+To navigate all the windows including slide and bottom pane with `Ctrl-h/j/k/l`,
+you can merge the following config system's key bindings to your `keybindings.json` file.
 
 :::caution
 This config might be in conflict with "Easy List Navigation" below.
@@ -63,7 +64,9 @@ This config might be in conflict with "Easy List Navigation" below.
 
 ## Easy List Navigation
 
-Although [VSCode Vim already bound](https://github.com/VSCodeVim/Vim/blob/v1.14.5/package.json#L124-L152) these to `h/j/k/l`, however, they might not work in all lists like in the problem pane. You can merge the following keybindings to `keybindings.json` to bind `ctrl+h/l/j/k` for those situations.
+Although [VSCode Vim already bound](https://github.com/VSCodeVim/Vim/blob/v1.14.5/package.json#L124-L152)
+these to `h/j/k/l`, however, they might not work in all lists like in the problem pane.
+You can merge the following keybindings to `keybindings.json` to bind `ctrl+h/l/j/k` for those situations.
 
 :::caution
 This config might be in conflict with "Quick Window Navigation" above.
@@ -98,7 +101,10 @@ This config might be in conflict with "Quick Window Navigation" above.
 
 ## Rebind action menu for file-browser
 
-File browser, which is bound to `<spc> f f` by default, binds `ctrl+a` to open an action menu; however, `ctrl+a` can be used move the text cursor to the front. Your can merge the following example keybindings to `keybindings.json` to use `ctrl+o` instead of `ctrl+a` in the file browser to open an action menu.
+File browser, which is bound to `<spc> f f` by default, binds `ctrl+a` to open an action menu;
+however, `ctrl+a` can be used move the text cursor to the front.
+Your can merge the following example keybindings to `keybindings.json` to use `ctrl+o` instead of
+`ctrl+a` in the file browser to open an action menu.
 
 `keybindings.json`:
 
@@ -127,6 +133,7 @@ The argument of `vim.remap` is specified by the `"args"` field.
 If the `"args"` field contains the `after` key, the vim key combination specified in the value will be executed.
 
 The following example json overrides `<spc> y` to execute vim keys of `y y`.
+
 ```json
 "vspacecode.bindingOverrides": [
     {
@@ -142,9 +149,12 @@ The following example json overrides `<spc> y` to execute vim keys of `y y`.
 ```
 
 ### Execute vim command
+
 If the `"args"` field contains the `commands` key, the vim and vscode commands specified in the array will be executed.
 
-The following example json overrides `<spc> c` to execute the vim command `:noh` and the vscode command `editor.action.codeAction` with `{ "kind": "refactor.extract" }` as argument.
+The following example json overrides `<spc> c` to execute the vim command `:noh` and the
+vscode command `editor.action.codeAction` with `{ "kind": "refactor.extract" }` as argument.
+
 ```json
 "vspacecode.bindingOverrides": [
     {
@@ -165,7 +175,6 @@ The following example json overrides `<spc> c` to execute the vim command `:noh`
 ]
 ```
 
-
 ## Use non-character keys
 
 See in [Which Key](./whichkey/extra#use-non-character-keys)
diff --git a/docs/installation.md b/docs/installation.md
@@ -8,7 +8,9 @@ This extension is published as an extension pack, i.e. it installs all the neces
 However, if you do not like the bundled extensions or you are not using VSCode Vim, please go to the
 [vscode-which-key](https://github.com/VSpaceCode/vscode-which-key) extension for a standalone which key menu function.
 
-After the installation of the [VSpaceCode extension](https://marketplace.visualstudio.com/items?itemName=VSpaceCode.vspacecode), a notification will help you to configure both the necessary settings and user bindings.
+After the installation of the
+[VSpaceCode extension](https://marketplace.visualstudio.com/items?itemName=VSpaceCode.vspacecode),
+a notification will help you to configure both the necessary settings and user bindings.
 
 :::note
 By following this automatic procedure, the formatting of `settings.json` and `keybindings.json` may be lost.
@@ -17,10 +19,12 @@ If you want to prevent this, you can choose to follow the manual configuration b
 
 ## Manual Configuration (optional)
 
-The [`settings.jsonc`][settings] and [`keybindings.jsonc`][keybindings] in the repo contains the configurations needed. You can merge them manually to your user's `settings.json` and `keybindings.json`.
+The [`settings.jsonc`][settings] and [`keybindings.jsonc`][keybindings] in the repo contains the
+configurations needed. You can merge them manually to your user's `settings.json` and `keybindings.json`.
 
 :::tip
-You can access your user's `settings.json` and `keybindings.json` by searching `Preference: Open Settings (JSON)` and `Preference: Open Keyboard Shortcuts (JSON)` in the command palette (Ctl+Shift+P)
+You can access your user's `settings.json` and `keybindings.json` by searching `Preference: Open Settings (JSON)`
+and `Preference: Open Keyboard Shortcuts (JSON)` in the command palette (Ctl+Shift+P)
 :::
 
 The following commands can be access through command palette to rerun the automatic configuration step.
diff --git a/docs/major-mode.md b/docs/major-mode.md
@@ -3,10 +3,13 @@ id: major-mode
 title: Major Mode
 ---
 
-Major mode offers dynamic menu and functions based on the active buffer. You can access key bindings specific to the current major mode by pressing `<spc> m` or `,` if you want to save one keystroke.
+Major mode offers dynamic menu and functions based on the active buffer.
+You can access key bindings specific to the current major mode by pressing `<spc> m` or `,` if you want to save one keystroke.
 
 :::note
-If `,` isn't bound, you might need to update your settings. You can add the necessary keybindings to your `settings.json` by pressing `Ctrl+Shift+p` and running the command "VSpaceCode: Configure Default Settings". More information can be found in the [Installation](./) instructions.
+If `,` isn't bound, you might need to update your settings.
+You can add the necessary keybindings to your `settings.json` by pressing `Ctrl+Shift+p` and running the command "VSpaceCode: Configure Default Settings".
+More information can be found in the [Installation](./) instructions.
 :::
 
 For example, you can press `<spc> m x b` to make the text bold in a markdown buffer.
@@ -17,17 +20,20 @@ To find the active language mode of your current buffer, you can look at the bot
 
 The major mode is using which-key's conditional bindings. If you want to modify the default bindings, check out the conditional bindings [docs](./whichkey/extra#conditional-bindings-experimental).
 
-The vast majority of major mode specific key bindings will require the installation of additional extensions in order to work properly. The section below lists all the extensions required by each major mode.
+The vast majority of major mode specific key bindings will require the installation of additional extensions in order to work properly.
+The section below lists all the extensions required by each major mode.
 
 In the following you can see all the currently available major modes.
 If your favorite one is missing, please [contribute](https://github.com/VSpaceCode/VSpaceCode/blob/master/CONTRIBUTING.md)!
 
 ## Go
 
 Required extensions:
+
 - [Go](https://marketplace.visualstudio.com/items?itemName=golang.Go)
 
 ## Markdown
 
 Required extensions:
+
 - [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
diff --git a/docs/menu-customization.md b/docs/menu-customization.md
@@ -3,23 +3,29 @@ id: menu-customization
 title: Menu Customization
 ---
 
-There are two ways to customize the menu: incrementally, and from scratch. Incrementally is great for when you only need to modify a few bindings from the default. Customizing from scratch is great for total control of the customization.
+There are two ways to customize the menu: incrementally, and from scratch.
+Incrementally is great for when you only need to modify a few bindings from the default. Customizing from scratch is great for total control of the customization.
 
 ## Default bindings
 
 See [Default Keybindings](./default-keybindings) for default bindings.
 
 :::note
-The default menu bindings are subject to change before `1.0.0`. If you find something that you think it should bind to a particular key by default, or you want a particular command, please open an issue as a feature request.
+The default menu bindings are subject to change before `1.0.0`.
+If you find something that you think it should bind to a particular key by default, or you want a particular command,
+please open an issue as a feature request.
 :::
 
 ## Incrementally
 
-Using this option will allow to you surgically update the default bindings (`vspacecode.bindings`). The extension will override bindings sequentially base on `vspacecode.bindingOverrides`.
+Using this option will allow to you surgically update the default bindings (`vspacecode.bindings`).
+The extension will override bindings sequentially base on `vspacecode.bindingOverrides`.
 
 ### Add/Replace
 
-The following json will replace `<SPC> g s` in the same position if the binding exists in `vspacecode.bindings`, and append `s` to menu `<SPC> g` if it doesn't exists. This override will only execute if `<SPC> g` menu exists. An optional `position` key can be used to specified index of where the item should be inserted/moved to.
+The following json will replace `<SPC> g s` in the same position if the binding exists in `vspacecode.bindings`,
+and append `s` to menu `<SPC> g` if it doesn't exists. This override will only execute if `<SPC> g` menu exists.
+An optional `position` key can be used to specified index of where the item should be inserted/moved to.
 
 ```jsonc
 {
@@ -76,7 +82,8 @@ In the following example, any item bound to `<SPC> g s` will be remove.
 
 ## From Scratch
 
-To customize the menu items from scratch, you can override the menu completely by putting your own `vspacecode.bindings` into your `settings.json`. Using this option will prevent any update to your own bindings.
+To customize the menu items from scratch, you can override the menu completely by putting your own `vspacecode.bindings` into your `settings.json`.
+Using this option will prevent any update to your own bindings.
 
 An example of a `settings.json` file that overrides space menu is as follows:
 
@@ -119,4 +126,5 @@ An example of a `settings.json` file that overrides space menu is as follows:
 }
 ```
 
-The default value can be found in the `contributes.configuration.vspacecode.bindings.default` section of the `package.json` in this repo. You can use the default value as an example to craft your own custom menu.
+The default value can be found in the `contributes.configuration.vspacecode.bindings.default` section of the `package.json` in this repo.
+You can use the default value as an example to craft your own custom menu.
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -5,7 +5,8 @@ title: Troubleshooting
 
 ## Error "␣ is undefined" when pressing SPC SPC
 
-When pressing `SPC SPC` quickly on macOS, which-key doesn't recognize the second `SPC` sometimes, and the error "␣ is undefined" is displayed on the status bar.
+When pressing `SPC SPC` quickly on macOS, which-key doesn't recognize the second `SPC` sometimes,
+and the error "␣ is undefined" is displayed on the status bar.
 
 This problem is due to a keyboard settings on macOS that add a period with double-space.
 
@@ -47,15 +48,17 @@ Example:
 ]
 ```
 
-In order to solve it, remove the conflicting vim bindings from your `settings.json` completely, or use the VSpaceCode's [overrides](./menu-customization#addreplace) instead.
+In order to solve it, remove the conflicting vim bindings from your `settings.json` completely,
+or use the VSpaceCode's [overrides](./menu-customization#addreplace) instead.
 
 ### Virtual Machine or slow hardware
 
 If you are working on limiting resources consider using [VSCode remote](https://code.visualstudio.com/docs/remote/remote-overview)
 
 ### Other conflicts
 
-Try to remove all the extensions except the ones installed by VSpaceCode, and clean your `settings.json` and `keybindings.json` files in order to spot some weird conflicts.
+Try to remove all the extensions except the ones installed by VSpaceCode, and clean your `settings.json`
+and `keybindings.json` files in order to spot some weird conflicts.
 
 ## Known Issues
 
diff --git a/docs/whichkey/extra.md b/docs/whichkey/extra.md
diff --git a/docs/whichkey/usage.md b/docs/whichkey/usage.md
