Skip to content

Commit ee5ad83

Browse files
committed
docs: align keymap docs with demo wording
1 parent cd5a404 commit ee5ad83

3 files changed

Lines changed: 52 additions & 42 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,20 @@ On first install/update, the plugin also shows a one-time welcome notification.
3535

3636
## GUI -> Vim Keymap Comparison
3737

38-
| GUI Shortcut | Action | Vim Equivalent |
39-
|--------------|--------|----------------|
40-
| Ctrl+C | Copy | `y` / `yy` |
41-
| Ctrl+V | Paste | `p` |
42-
| Ctrl+X | Cut | `d` |
43-
| Ctrl+A | Select All | `ggVG` |
44-
| Ctrl+Z | Undo | `u` |
45-
| Ctrl+Y | Redo | `<C-r>` |
46-
| Ctrl+S | Save | `:write` |
47-
| Ctrl+Q | Save and close | `:confirm wq` |
48-
| Home | Move to line start | `0` |
49-
| End | Move to line end | `$` |
50-
| Ctrl+Backspace | Delete previous word | GUI-style previous-word delete |
51-
| Ctrl+Delete | Delete next word | GUI-style next-word delete |
38+
| GUI Shortcut | Vim Equivalent | Action |
39+
|--------------|----------------|--------|
40+
| Ctrl+C | `y` / `yy` | Copy |
41+
| Ctrl+V | `p` | Paste |
42+
| Ctrl+X | `d` | Cut |
43+
| Ctrl+A | `ggVG` | Select All |
44+
| Ctrl+Z | `u` | Undo |
45+
| Ctrl+Y | `<C-r>` | Redo |
46+
| Ctrl+S | `:write` | Save |
47+
| Ctrl+Q | `:confirm wq` | Save and close |
48+
| Home | `0` | Move to line start |
49+
| End | `$` | Move to line end |
50+
| Ctrl+Backspace | GUI-style previous-word delete | Delete previous word |
51+
| Ctrl+Delete | GUI-style next-word delete | Delete next word |
5252

5353
## Installation
5454

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ It provides:
3232
3. Test the shortcuts in the scratch buffer.
3333
4. Open `:GuiKeymapInfo` if something does not behave as expected.
3434

35+
The demo and keymap reference use the same teaching order:
36+
37+
- GUI shortcut
38+
- Vim equivalent
39+
- resulting action
40+
3541
## Project links
3642

3743
- Repository: [Only-Moon/gui-keymap.nvim](https://github.com/Only-Moon/gui-keymap.nvim)

docs/keymaps.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,38 @@
22

33
## GUI shortcut table
44

5-
| Shortcut | Mode | Behavior | Vim equivalent |
6-
|----------|------|----------|----------------|
7-
| `Ctrl+C` | normal | copy line | `yy` |
8-
| `Ctrl+C` | visual | copy selection | `y` |
9-
| `Ctrl+V` | normal | paste | `p` |
10-
| `Ctrl+V` | insert | paste | insert paste |
11-
| `Ctrl+X` | visual | cut selection | `d` |
12-
| `Ctrl+A` | normal | select all | `ggVG` |
13-
| `Ctrl+A` | insert | select all | `<Esc>ggVG` |
14-
| `Ctrl+Z` | normal | undo | `u` |
15-
| `Ctrl+Z` | insert | undo | `<C-o>u` |
16-
| `Ctrl+Y` | normal | redo | `<C-r>` |
17-
| `Ctrl+Y` | insert | redo | `<C-o><C-r>` |
18-
| `Ctrl+S` | normal | save buffer | `:write` |
19-
| `Ctrl+S` | insert | save buffer | `:write` |
20-
| `Ctrl+S` | visual | save buffer | `:write` |
21-
| `Ctrl+Q` | normal | save and close | `:confirm wq` |
22-
| `Ctrl+Q` | insert | save and close | `:confirm wq` |
23-
| `Home` | normal | line start | `0` |
24-
| `Home` | insert | line start | `<C-o>0` |
25-
| `Home` | visual | line start | `0` |
26-
| `End` | normal | line end | `$` |
27-
| `End` | insert | line end | `<C-o>$` |
28-
| `End` | visual | line end | `$` |
29-
| `Ctrl+Backspace` | normal | delete previous word | GUI-style previous-word delete |
30-
| `Ctrl+Backspace` | insert | delete previous word | GUI-style previous-word delete |
31-
| `Ctrl+Delete` | normal | delete next word | GUI-style next-word delete |
32-
| `Ctrl+Delete` | insert | delete next word | GUI-style next-word delete |
5+
This page follows the same teaching order as `:GuiKeymapDemo`:
6+
7+
`GUI shortcut -> Vim equivalent -> action`
8+
9+
| Shortcut | Mode | Vim equivalent | Action |
10+
|----------|------|----------------|--------|
11+
| `Ctrl+C` | normal | `yy` | Copy line |
12+
| `Ctrl+C` | visual | `y` | Copy selection |
13+
| `Ctrl+V` | normal | `p` | Paste |
14+
| `Ctrl+V` | insert | insert paste | Paste |
15+
| `Ctrl+X` | visual | `d` | Cut selection |
16+
| `Ctrl+A` | normal | `ggVG` | Select all |
17+
| `Ctrl+A` | insert | `<Esc>ggVG` | Select all |
18+
| `Ctrl+Z` | normal | `u` | Undo |
19+
| `Ctrl+Z` | insert | `<C-o>u` | Undo |
20+
| `Ctrl+Y` | normal | `<C-r>` | Redo |
21+
| `Ctrl+Y` | insert | `<C-o><C-r>` | Redo |
22+
| `Ctrl+S` | normal | `:write` | Save buffer |
23+
| `Ctrl+S` | insert | `:write` | Save buffer |
24+
| `Ctrl+S` | visual | `:write` | Save buffer |
25+
| `Ctrl+Q` | normal | `:confirm wq` | Save and close |
26+
| `Ctrl+Q` | insert | `:confirm wq` | Save and close |
27+
| `Home` | normal | `0` | Move to line start |
28+
| `Home` | insert | `<C-o>0` | Move to line start |
29+
| `Home` | visual | `0` | Move to line start |
30+
| `End` | normal | `$` | Move to line end |
31+
| `End` | insert | `<C-o>$` | Move to line end |
32+
| `End` | visual | `$` | Move to line end |
33+
| `Ctrl+Backspace` | normal | GUI-style previous-word delete | Delete previous word |
34+
| `Ctrl+Backspace` | insert | GUI-style previous-word delete | Delete previous word |
35+
| `Ctrl+Delete` | normal | GUI-style next-word delete | Delete next word |
36+
| `Ctrl+Delete` | insert | GUI-style next-word delete | Delete next word |
3337

3438
## Delete-selection mappings
3539

0 commit comments

Comments
 (0)