aboutsummaryrefslogtreecommitdiff
path: root/book/src
diff options
context:
space:
mode:
authorGokul Soumya2021-11-12 01:35:32 +0000
committerGitHub2021-11-12 01:35:32 +0000
commitfa0cb010e16c6a7d95b8849f073f472b0bd710be (patch)
treed6e5b7c50bf51177b5da24946617f48dab4067b1 /book/src
parent187197afb15ae13764fc2cdde87528324e183983 (diff)
docs: Mark more keybinds that require LSP and treesitter (#1081)
Diffstat (limited to 'book/src')
-rw-r--r--book/src/keymap.md39
1 files changed, 20 insertions, 19 deletions
diff --git a/book/src/keymap.md b/book/src/keymap.md
index b9869214..c544a472 100644
--- a/book/src/keymap.md
+++ b/book/src/keymap.md
@@ -1,5 +1,8 @@
# Keymap
+- Mappings marked (**LSP**) require an active language server for the file.
+- Mappings marked (**TS**) require a tree-sitter grammar for the filetype.
+
## Normal mode
### Movement
@@ -64,7 +67,7 @@
| `"` `<reg>` | Select a register to yank to or paste from | `select_register` |
| `>` | Indent selection | `indent` |
| `<` | Unindent selection | `unindent` |
-| `=` | Format selection | `format_selections` |
+| `=` | Format selection (**LSP**) | `format_selections` |
| `d` | Delete selection | `delete_selection` |
| `c` | Change selection (delete and enter insert mode) | `change_selection` |
@@ -98,7 +101,7 @@
| `%` | Select entire file | `select_all` |
| `x` | Select current line, if already selected, extend to next line | `extend_line` |
| `X` | Extend selection to line bounds (line-wise selection) | `extend_to_line_bounds` |
-| | Expand selection to parent syntax node TODO: pick a key | `expand_selection` |
+| | Expand selection to parent syntax node TODO: pick a key (**TS**) | `expand_selection` |
| `J` | Join lines inside selection | `join_selections` |
| `K` | Keep selections matching the regex | `keep_selections` |
| `Alt-K` | Remove selections matching the regex | `remove_selections` |
@@ -143,8 +146,7 @@ over text and not actively editing it).
#### Goto mode
-Jumps to various locations. Mappings marked (**LSP**) require an
-active language server for the file to work.
+Jumps to various locations.
| Key | Description | Command |
| ----- | ----------- | ------- |
@@ -172,7 +174,7 @@ and [textobject](./usage.md#textobject) usage.
| Key | Description | Command |
| ----- | ----------- | ------- |
-| `m` | Goto matching bracket | `match_brackets` |
+| `m` | Goto matching bracket (**TS**) | `match_brackets` |
| `s` `<char>` | Surround current selection with `<char>` | `surround_add` |
| `r` `<from><to>` | Replace surround character `<from>` with `<to>` | `surround_replace` |
| `d` `<char>` | Delete surround character `<char>` | `surround_delete` |
@@ -199,18 +201,17 @@ This layer is similar to vim keybindings as kakoune does not support window.
#### Space mode
-This layer is a kludge of mappings, mostly pickers. Mappings marked
-(**LSP**) require an active language server for the file to work.
+This layer is a kludge of mappings, mostly pickers.
| Key | Description | Command |
| ----- | ----------- | ------- |
| `f` | Open file picker | `file_picker` |
| `b` | Open buffer picker | `buffer_picker` |
-| `k` | Show documentation for item under cursor (**LSP**) | `hover` |
-| `s` | Open document symbol picker (**LSP**) | `symbol_picker` |
-| `r` | Rename symbol (**LSP**) | `rename_symbol` |
-| `a` | Apply code action (**LSP**) | `code_action` |
+| `k` | Show documentation for item under cursor (**LSP**) | `hover` |
+| `s` | Open document symbol picker (**LSP**) | `symbol_picker` |
+| `r` | Rename symbol (**LSP**) | `rename_symbol` |
+| `a` | Apply code action (**LSP**) | `code_action` |
| `'` | Open last fuzzy picker | `last_picker` |
| `w` | Enter [window mode](#window-mode) | N/A |
| `p` | Paste system clipboard after selections | `paste_clipboard_after` |
@@ -226,14 +227,14 @@ This layer is a kludge of mappings, mostly pickers. Mappings marked
Mappings in the style of [vim-unimpaired](https://github.com/tpope/vim-unimpaired).
-| Key | Description | Command |
-| ----- | ----------- | ------- |
-| `[d` | Go to previous diagnostic | `goto_prev_diag` |
-| `]d` | Go to next diagnostic | `goto_next_diag` |
-| `[D` | Go to first diagnostic in document | `goto_first_diag` |
-| `]D` | Go to last diagnostic in document | `goto_last_diag` |
-| `[space` | Add newline above | `add_newline_above` |
-| `]space` | Add newline below | `add_newline_below` |
+| Key | Description | Command |
+| ----- | ----------- | ------- |
+| `[d` | Go to previous diagnostic (**LSP**) | `goto_prev_diag` |
+| `]d` | Go to next diagnostic (**LSP**) | `goto_next_diag` |
+| `[D` | Go to first diagnostic in document (**LSP**) | `goto_first_diag` |
+| `]D` | Go to last diagnostic in document (**LSP**) | `goto_last_diag` |
+| `[space` | Add newline above | `add_newline_above` |
+| `]space` | Add newline below | `add_newline_below` |
## Insert Mode