Skip to content

Commit d12af29

Browse files
committed
docs: document keymaps in readme
1 parent 6b99444 commit d12af29

1 file changed

Lines changed: 80 additions & 0 deletions

File tree

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,86 @@ npm run format:lua:check
3737
nvim --headless +qa
3838
```
3939

40+
## Keymaps
41+
42+
<details>
43+
<summary>Navigation</summary>
44+
45+
| Key | Mode | Action |
46+
| --- | --- | --- |
47+
| `<Left>` / `<Down>` / `<Up>` / `<Right>` | normal, visual | Use `h`, `gj`, `gk`, `l` style movement. |
48+
| `<Home>` / `<End>` | normal, visual | Jump to first non-blank char or end of line. |
49+
| `<C-Left>` / `<C-Right>` | normal, visual, insert | Move by word. |
50+
| `<C-S-Left>` / `<C-S-Right>` | normal, visual, insert | Select or extend by word. |
51+
| `<C-S-Up>` / `<C-S-Down>` | normal, visual, insert | Select or extend by display line. |
52+
53+
</details>
54+
55+
<details>
56+
<summary>Editing</summary>
57+
58+
| Key | Mode | Action |
59+
| --- | --- | --- |
60+
| `<C-BS>` / `<C-h>` | insert | Delete the previous code chunk, not just a plain word. |
61+
| `<C-w>` | insert | Uses the same code-aware backward delete behavior. |
62+
| `<C-BS>` / `<C-h>` | normal, visual | Delete the previous selection chunk backward. |
63+
| `<BS>` | visual | Delete selection into the black hole register. |
64+
65+
</details>
66+
67+
<details>
68+
<summary>Clipboard And Save</summary>
69+
70+
| Key | Mode | Action |
71+
| --- | --- | --- |
72+
| `<C-x>` | normal, visual | Cut to system clipboard. |
73+
| `<C-c>` | normal, visual | Copy to system clipboard. |
74+
| `<C-v>` | normal, visual | Paste from system clipboard. |
75+
| `<C-z>` / `<C-y>` | normal, visual | Undo / redo. |
76+
| `<C-s>` | normal, visual, insert | Save current buffer. |
77+
| `<C-a>` | normal, insert | Select the entire buffer. |
78+
79+
</details>
80+
81+
<details>
82+
<summary>Window Management</summary>
83+
84+
| Key | Mode | Action |
85+
| --- | --- | --- |
86+
| `<C-q>` | normal | Close current buffer. |
87+
| `<leader>v` / `<leader>h` | normal | Vertical split / horizontal split. |
88+
| `<leader>q` / `<leader>o` | normal | Close current window / keep only current window. |
89+
| `<leader><Left>` / `<leader><Down>` / `<leader><Up>` / `<leader><Right>` | normal | Move across windows. |
90+
91+
</details>
92+
93+
<details>
94+
<summary>UI And Search</summary>
95+
96+
| Key | Mode | Action |
97+
| --- | --- | --- |
98+
| `<leader>e` | normal | Open `oil.nvim` in the current directory. |
99+
| `<leader><leader>` | normal | Find files with Telescope. |
100+
| `<C-p>` | normal | Open recent buffers with Telescope. |
101+
| `<leader>g` | normal | Run live grep with Telescope. |
102+
| `<Esc>` | normal | Clear search highlight and keep escape behavior. |
103+
| `<Esc>` | insert, visual, select, operator-pending | Keep plain escape behavior explicit. |
104+
105+
</details>
106+
107+
<details>
108+
<summary>Terminal</summary>
109+
110+
| Key | Mode | Action |
111+
| --- | --- | --- |
112+
| `<Esc>` | terminal | Leave terminal mode. |
113+
| `<C-\>` / `Ctrl+\`` / `<Nul>` / `<C-Space>` / `<C-@>` | normal, terminal | Toggle the last floating terminal. |
114+
| `<leader>tn` | normal | Create a new floating terminal. |
115+
| `<leader>ts` | normal | Pick an existing terminal from the Telescope selector. |
116+
| `<leader>tk` | normal | Close the last terminal. |
117+
118+
</details>
119+
40120
## Performance
41121

42122
- Startup benchmark (`nvim --startuptime`, 5 runs): `17.20 ms` min, `21.47 ms` avg, `30.78 ms` max.

0 commit comments

Comments
 (0)