aboutsummaryrefslogtreecommitdiff
path: root/book
diff options
context:
space:
mode:
authorJJ2023-11-01 01:19:02 +0000
committerJJ2023-11-01 04:08:47 +0000
commit7260812a720336111dc4643c9852e34820745338 (patch)
treed8398e3779b4aaad3c6cc749673a1b55ef44df7f /book
parent368995b51f2b0b8574a87ebe04749cb556b4c538 (diff)
Add unbind-default-keys config option
ref: https://github.com/helix-editor/helix/issues/2720 ref: https://github.com/helix-editor/helix/pull/2733 Co-authored-by: Linden Krouse <ztaticnull@gmail.com>
Diffstat (limited to 'book')
-rw-r--r--book/src/remapping.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/book/src/remapping.md b/book/src/remapping.md
index d762c6ad..cc27eed7 100644
--- a/book/src/remapping.md
+++ b/book/src/remapping.md
@@ -75,5 +75,24 @@ Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
Keys can be disabled by binding them to the `no_op` command.
+
+To remove all default bindings, `unbind-default-keys = true` can be added to the top level configuration.
+
+```toml
+unbind-default-keys = true
+
+# Only these normal mode bindings will be used
+[keys.normal]
+n = "normal_mode"
+t = "goto_definition"
+
+# remember to add bindings to return to normal mode
+[keys.select]
+esc = "normal_mode"
+
+[keys.insert]
+esc = "normal_mode"
+```
+
A list of commands is available in the [Keymap](https://docs.helix-editor.com/keymap.html) documentation
and in the source code at [`helix-term/src/commands.rs`](https://github.com/helix-editor/helix/blob/master/helix-term/src/commands.rs) at the invocation of `static_commands!` macro and the `TypableCommandList`.