Skip to content

Commit a1e6481

Browse files
authored
Update book to include typable command remapping (#1240)
* Update book to include typable command remapping * Add additional example
1 parent 29c053e commit a1e6481

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

book/src/remapping.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ this:
1111
```toml
1212
# At most one section each of 'keys.normal', 'keys.insert' and 'keys.select'
1313
[keys.normal]
14+
C-s = ":w" # Maps the Control-s to the typable command :w which is an alias for :write (save file)
15+
C-o = ":open ~/.config/helix/config.toml" # Maps the Control-o to opening of the helix config file
1416
a = "move_char_left" # Maps the 'a' key to the move_char_left command
1517
w = "move_line_up" # Maps the 'w' key move_line_up
1618
"C-S-esc" = "extend_line" # Maps Control-Shift-Escape to extend_line
@@ -21,6 +23,7 @@ g = { a = "code_action" } # Maps `ga` to show possible code actions
2123
"A-x" = "normal_mode" # Maps Alt-X to enter normal mode
2224
j = { k = "normal_mode" } # Maps `jk` to exit insert mode
2325
```
26+
> NOTE: Typable commands can also be remapped, remember to keep the `:` prefix to indicate it's a typable command.
2427
2528
Control, Shift and Alt modifiers are encoded respectively with the prefixes
2629
`C-`, `S-` and `A-`. Special keys are encoded as follows:
@@ -53,4 +56,4 @@ Control, Shift and Alt modifiers are encoded respectively with the prefixes
5356
Keys can be disabled by binding them to the `no_op` command.
5457

5558
Commands can be found at [Keymap](https://docs.helix-editor.com/keymap.html) Commands.
56-
> Commands can also be found 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 `commands!` macro.
59+
> Commands can also be found 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`.

0 commit comments

Comments
 (0)