Automatically generate book documentation of all commands

book/src/keymap/modes/goto.md

@@ -0,0 +1 @@
+Jumps to various locations.

book/src/keymap/modes/insert.md

@@ -0,0 +1,38 @@
+Insert mode bindings are somewhat minimal by default. Helix is designed to
+be a modal editor, and this is reflected in the user experience and internal
+mechanics. For example, changes to the text are only saved for undos when
+escaping from insert mode to normal mode. For this reason, new users are
+strongly encouraged to learn the modal editing paradigm to get the smoothest
+experience.
+
+
+
+
+
+
+However, if you really want navigation in insert mode, this is supported. An
+example config that gives the ability to use arrow keys while still in insert
+mode:
+
+```toml
+[keys.insert]
+"up" = "move_line_up"
+"down" = "move_line_down"
+"left" = "move_char_left"
+"right" = "move_char_right"
+"C-b" = "move_char_left"
+"C-f" = "move_char_right"
+"A-b" = "move_prev_word_end"
+"C-left" = "move_prev_word_end"
+"A-f" = "move_next_word_start"
+"C-right" = "move_next_word_start"
+"A-<" = "goto_file_start"
+"A->" = "goto_file_end"
+"pageup" = "page_up"
+"pagedown" = "page_down"
+"home" = "goto_line_start"
+"C-a" = "goto_line_start"
+"end" = "goto_line_end_newline"
+"C-e" = "goto_line_end_newline"
+"A-left" = "goto_line_start"
+```

book/src/keymap/modes/left_bracket.md

@@ -0,0 +1 @@
+Mappings in the style of [vim-unimpaired](https://github.com/tpope/vim-unimpaired).

book/src/keymap/modes/match.md

@@ -0,0 +1,7 @@
+Enter this mode using `m` from normal mode. See the relevant section
+in [Usage](./usage.md) for an explanation about [surround](./usage.md#surround)
+and [textobject](./usage.md#textobject) usage.
+
+
+
+TODO: Mappings for selecting syntax nodes (a superset of `[`).

book/src/keymap/modes/minor_modes.md

@@ -0,0 +1 @@
+These sub-modes are accessible from normal mode and typically switch back to normal mode after a command.

book/src/keymap/modes/movement.md

@@ -0,0 +1 @@
+> NOTE: Unlike Vim, `f`, `F`, `t` and `T` are not confined to the current line.

book/src/keymap/modes/right_bracket.md

@@ -0,0 +1 @@
+Mappings in the style of [vim-unimpaired](https://github.com/tpope/vim-unimpaired).

book/src/keymap/modes/search.md

@@ -0,0 +1 @@
+Search commands all operate on the `/` register by default. Use `"<char>` to operate on a different one.

book/src/keymap/modes/select.md

@@ -0,0 +1,10 @@
+This mode echoes Normal mode, but changes any movements to extend
+selections rather than replace them. Goto motions are also changed to
+extend, so that `vgl` for example extends the selection to the end of
+the line.
+
+Search is also affected. By default, `n` and `N` will remove the current
+selection and select the next instance of the search term. Toggling this
+mode before pressing `n` or `N` makes it possible to keep the current
+selection. Toggling it on and off during your iterative searching allows
+you to selectively add search terms to your selections.

book/src/keymap/modes/space.md

@@ -0,0 +1,6 @@
+This layer is a kludge of mappings, mostly pickers.
+
+
+
+
+> TIP: Global search displays results in a fuzzy picker, use `space + '` to bring it back up after opening a file.

book/src/keymap/modes/unmapped_commands.md

@@ -0,0 +1,5 @@
+Some commands exist but do not have a default keybinding. These commands
+may be quite niche, or simply alternatives to the standard commands. If you
+want to use them, simply map them in your configuration (see [remapping]).
+
+[remapping]: ./remapping.md

book/src/keymap/modes/view.md

@@ -0,0 +1,4 @@
+View mode is intended for scrolling and manipulating the view without changing
+the selection. The "sticky" variant of this mode is persistent; use the
+`Escape` key to return to normal mode after usage (useful when you're simply
+looking over text and not actively editing it).

book/src/keymap/modes/window.md

@@ -0,0 +1 @@
+This layer is similar to Vim keybindings as Kakoune does not support window.

book/src/keymap/picker.md

@@ -0,0 +1,16 @@
+Keys to use within picker. Remapping currently not supported.
+
+| Key                          | Description       |
+| -----                        | -------------     |
+| `Tab`, `Up`, `Ctrl-p`        | Previous entry    |
+| `PageUp`, `Ctrl-u`           | Page up           |
+| `Shift-tab`, `Down`, `Ctrl-n`| Next entry        |
+| `PageDown`, `Ctrl-d`         | Page down         |
+| `Home`                       | Go to first entry |
+| `End`                        | Go to last entry  |
+| `Ctrl-space`                 | Filter options    |
+| `Enter`                      | Open selected     |
+| `Ctrl-s`                     | Open horizontally |
+| `Ctrl-v`                     | Open vertically   |
+| `Ctrl-t`                     | Toggle preview    |
+| `Escape`, `Ctrl-c`           | Close picker      |

book/src/keymap/prompt.md

@@ -0,0 +1,24 @@
+Keys to use within prompt, Remapping currently not supported.
+
+| Key                                         | Description                                                             |
+| -----                                       | -------------                                                           |
+| `Escape`, `Ctrl-c`                          | Close prompt                                                            |
+| `Alt-b`, `Ctrl-Left`                        | Backward a word                                                         |
+| `Ctrl-b`, `Left`                            | Backward a char                                                         |
+| `Alt-f`, `Ctrl-Right`                       | Forward a word                                                          |
+| `Ctrl-f`, `Right`                           | Forward a char                                                          |
+| `Ctrl-e`, `End`                             | Move prompt end                                                         |
+| `Ctrl-a`, `Home`                            | Move prompt start                                                       |
+| `Ctrl-w`, `Alt-Backspace`, `Ctrl-Backspace` | Delete previous word                                                    |
+| `Alt-d`, `Alt-Delete`, `Ctrl-Delete`        | Delete next word                                                        |
+| `Ctrl-u`                                    | Delete to start of line                                                 |
+| `Ctrl-k`                                    | Delete to end of line                                                   |
+| `backspace`, `Ctrl-h`                       | Delete previous char                                                    |
+| `delete`, `Ctrl-d`                          | Delete next char                                                        |
+| `Ctrl-s`                                    | Insert a word under doc cursor, may be changed to Ctrl-r Ctrl-w later   |
+| `Ctrl-p`, `Up`                              | Select previous history                                                 |
+| `Ctrl-n`, `Down`                            | Select next history                                                     |
+| `Ctrl-r`                                    | Insert the content of the register selected by following input char     |
+| `Tab`                                       | Select next completion item                                             |
+| `BackTab`                                   | Select previous completion item                                         |
+| `Enter`                                     | Open selected                                                           |

book/src/remapping.md

@@ -50,5 +50,5 @@ Control, Shift and Alt modifiers are encoded respectively with the prefixes
 
 Keys can be disabled by binding them to the `no_op` command.
 
-Commands can be found at [Keymap](https://docs.helix-editor.com/keymap.html) Commands.
+Commands can be found at [Keymap](./keymap.md) Commands.
 > 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`.