Skip to content

Commit

Permalink
add document
Browse files Browse the repository at this point in the history
  • Loading branch information
pit-ray committed Jan 3, 2024
1 parent 23ac333 commit 60498e3
Show file tree
Hide file tree
Showing 6 changed files with 139 additions and 73 deletions.
40 changes: 20 additions & 20 deletions docs/cheat_sheet/defaults/big/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ nav: Big Mappings
|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`V`|[\<select_all\>]({{ site.url }}/cheat_sheet/functions/#select_all)|
|`Y`, `yy`, `y`|[\<hotkey_copy\>]({{ site.url }}/cheat_sheet/functions/#hotkey_copy)|
|`p`, `P`|[\<hotkey_paste\>]({{ site.url }}/cheat_sheet/functions/#hotkey_paste)|
|`D`, `dd`|[\<hotkey_cut\>]({{ site.url }}/cheat_sheet/functions/#hotkey_cut)|
|`<Del>`, `x`|[\<hotkey_delete\>]({{ site.url }}/cheat_sheet/functions/#hotkey_delete)|
|`yy`, `y`, `Y`|[\<hotkey_copy\>]({{ site.url }}/cheat_sheet/functions/#hotkey_copy)|
|`P`, `p`|[\<hotkey_paste\>]({{ site.url }}/cheat_sheet/functions/#hotkey_paste)|
|`dd`, `D`|[\<hotkey_cut\>]({{ site.url }}/cheat_sheet/functions/#hotkey_cut)|
|`x`, `<Del>`|[\<hotkey_delete\>]({{ site.url }}/cheat_sheet/functions/#hotkey_delete)|
|`X`|[\<hotkey_backspace\>]({{ site.url }}/cheat_sheet/functions/#hotkey_backspace)|
|`<C-r>`|[\<redo\>]({{ site.url }}/cheat_sheet/functions/#redo)|
|`u`, `U`|[\<undo\>]({{ site.url }}/cheat_sheet/functions/#undo)|
Expand All @@ -33,7 +33,7 @@ nav: Big Mappings
|`<C-v>s`|[\<taskview\>]({{ site.url }}/cheat_sheet/functions/#taskview)|
|`gT`|[\<switch_to_left_tab\>]({{ site.url }}/cheat_sheet/functions/#switch_to_left_tab)|
|`gt`|[\<switch_to_right_tab\>]({{ site.url }}/cheat_sheet/functions/#switch_to_right_tab)|
|`?`, `/`|[\<search_pattern\>]({{ site.url }}/cheat_sheet/functions/#search_pattern)|
|`/`, `?`|[\<search_pattern\>]({{ site.url }}/cheat_sheet/functions/#search_pattern)|
|`<gt>`|[\<goto_next_page\>]({{ site.url }}/cheat_sheet/functions/#goto_next_page)|
|`<lt>`|[\<goto_prev_page\>]({{ site.url }}/cheat_sheet/functions/#goto_prev_page)|
|`<win>`|[\<open_startmenu\>]({{ site.url }}/cheat_sheet/functions/#open_startmenu)|
Expand All @@ -51,17 +51,17 @@ nav: Big Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`h`, `<BS>`, `<Left>`|[\<move_cursor_left\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_left)|
|`<Right>`, `l`, `<Space>`|[\<move_cursor_right\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_right)|
|`k`, `-`, `<Up>`|[\<move_cursor_up\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_up)|
|`<Down>`, `j`, `+`|[\<move_cursor_down\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_down)|
|`<Left>`, `<BS>`, `h`|[\<move_cursor_left\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_left)|
|`l`, `<Right>`, `<Space>`|[\<move_cursor_right\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_right)|
|`-`, `k`, `<Up>`|[\<move_cursor_up\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_up)|
|`+`, `j`, `<Down>`|[\<move_cursor_down\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_down)|

### Mouse Jumping

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`^`, `0`, `<Home>`|[\<jump_cursor_to_left\>]({{ site.url }}/cheat_sheet/functions/#jump_cursor_to_left)|
|`<End>`, `$`|[\<jump_cursor_to_right\>]({{ site.url }}/cheat_sheet/functions/#jump_cursor_to_right)|
|`0`, `^`, `<Home>`|[\<jump_cursor_to_left\>]({{ site.url }}/cheat_sheet/functions/#jump_cursor_to_left)|
|`$`, `<End>`|[\<jump_cursor_to_right\>]({{ site.url }}/cheat_sheet/functions/#jump_cursor_to_right)|
|`gg`|[\<jump_cursor_to_top\>]({{ site.url }}/cheat_sheet/functions/#jump_cursor_to_top)|
|`G`|[\<jump_cursor_to_bottom\>]({{ site.url }}/cheat_sheet/functions/#jump_cursor_to_bottom)|
|`gm`|[\<jump_cursor_to_hcenter\>]({{ site.url }}/cheat_sheet/functions/#jump_cursor_to_hcenter)|
Expand All @@ -71,8 +71,8 @@ nav: Big Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`<C-y>`, `<C-k>`|[\<scroll_up\>]({{ site.url }}/cheat_sheet/functions/#scroll_up)|
|`<C-e>`, `<C-j>`|[\<scroll_down\>]({{ site.url }}/cheat_sheet/functions/#scroll_down)|
|`<C-k>`, `<C-y>`|[\<scroll_up\>]({{ site.url }}/cheat_sheet/functions/#scroll_up)|
|`<C-j>`, `<C-e>`|[\<scroll_down\>]({{ site.url }}/cheat_sheet/functions/#scroll_down)|
|`<C-u>`|[\<scroll_up_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_up_halfpage)|
|`<C-d>`|[\<scroll_down_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_down_halfpage)|
|`<C-b>`|[\<scroll_up_onepage\>]({{ site.url }}/cheat_sheet/functions/#scroll_up_onepage)|
Expand All @@ -86,10 +86,10 @@ nav: Big Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`Y`, `yy`, `y`|[\<hotkey_copy\>]({{ site.url }}/cheat_sheet/functions/#hotkey_copy)|
|`p`, `P`|[\<hotkey_paste\>]({{ site.url }}/cheat_sheet/functions/#hotkey_paste)|
|`D`, `dd`|[\<hotkey_cut\>]({{ site.url }}/cheat_sheet/functions/#hotkey_cut)|
|`<Del>`, `x`|[\<hotkey_delete\>]({{ site.url }}/cheat_sheet/functions/#hotkey_delete)|
|`yy`, `y`, `Y`|[\<hotkey_copy\>]({{ site.url }}/cheat_sheet/functions/#hotkey_copy)|
|`P`, `p`|[\<hotkey_paste\>]({{ site.url }}/cheat_sheet/functions/#hotkey_paste)|
|`dd`, `D`|[\<hotkey_cut\>]({{ site.url }}/cheat_sheet/functions/#hotkey_cut)|
|`x`, `<Del>`|[\<hotkey_delete\>]({{ site.url }}/cheat_sheet/functions/#hotkey_delete)|
|`X`|[\<hotkey_backspace\>]({{ site.url }}/cheat_sheet/functions/#hotkey_backspace)|

## Command Mode
Expand All @@ -111,10 +111,10 @@ nav: Big Mappings
|`tabprevious`|[\<switch_to_left_tab\>]({{ site.url }}/cheat_sheet/functions/#switch_to_left_tab)|
|`tabnext`|[\<switch_to_right_tab\>]({{ site.url }}/cheat_sheet/functions/#switch_to_right_tab)|
|`tabnew`|[\<open_new_tab\>]({{ site.url }}/cheat_sheet/functions/#open_new_tab)|
|`q!`, `tabclose`, `q`|[\<close_current_tab\>]({{ site.url }}/cheat_sheet/functions/#close_current_tab)|
|`q`, `q!`, `tabclose`|[\<close_current_tab\>]({{ site.url }}/cheat_sheet/functions/#close_current_tab)|
|`ex`, `explorer`|[\<start_explorer\>]({{ site.url }}/cheat_sheet/functions/#start_explorer)|
|`start`, `win`|[\<open_startmenu\>]({{ site.url }}/cheat_sheet/functions/#open_startmenu)|
|`open`, `find`|[\<open\>]({{ site.url }}/cheat_sheet/functions/#open)|
|`win`, `start`|[\<open_startmenu\>]({{ site.url }}/cheat_sheet/functions/#open_startmenu)|
|`find`, `open`|[\<open\>]({{ site.url }}/cheat_sheet/functions/#open)|
|`forward`|[\<forward_ui_navigation\>]({{ site.url }}/cheat_sheet/functions/#forward_ui_navigation)|
|`backward`|[\<backward_ui_navigation\>]({{ site.url }}/cheat_sheet/functions/#backward_ui_navigation)|
|`decide`|[\<decide_focused_ui_object\>]({{ site.url }}/cheat_sheet/functions/#decide_focused_ui_object)|
Expand Down
2 changes: 1 addition & 1 deletion docs/cheat_sheet/defaults/huge/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav: Huge Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`md`, `mkdir`|[\<makedir\>]({{ site.url }}/cheat_sheet/functions/#makedir)|
|`mkdir`, `md`|[\<makedir\>]({{ site.url }}/cheat_sheet/functions/#makedir)|

<br>
<br>
Expand Down
50 changes: 25 additions & 25 deletions docs/cheat_sheet/defaults/normal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav: Normal Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`<esc-right>`, `<ctrl-[>`, `I`|[\<click_left\>]({{ site.url }}/cheat_sheet/functions/#click_left)[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
|`<ctrl-[>`, `<esc-right>`, `I`|[\<click_left\>]({{ site.url }}/cheat_sheet/functions/#click_left)[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|

## Editor Normal Mode

Expand All @@ -29,8 +29,8 @@ nav: Normal Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`<C-y>`, `<C-k>`|[\<scroll_up\>]({{ site.url }}/cheat_sheet/functions/#scroll_up)|
|`<C-e>`, `<C-j>`|[\<scroll_down\>]({{ site.url }}/cheat_sheet/functions/#scroll_down)|
|`<C-k>`, `<C-y>`|[\<scroll_up\>]({{ site.url }}/cheat_sheet/functions/#scroll_up)|
|`<C-j>`, `<C-e>`|[\<scroll_down\>]({{ site.url }}/cheat_sheet/functions/#scroll_down)|
|`<C-u>`|[\<scroll_up_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_up_halfpage)|
|`<C-d>`|[\<scroll_down_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_down_halfpage)|
|`<C-b>`|[\<scroll_up_onepage\>]({{ site.url }}/cheat_sheet/functions/#scroll_up_onepage)|
Expand All @@ -48,7 +48,7 @@ nav: Normal Mappings
|`u`, `U`|[\<undo\>]({{ site.url }}/cheat_sheet/functions/#undo)|
|`gT`|[\<switch_to_left_tab\>]({{ site.url }}/cheat_sheet/functions/#switch_to_left_tab)|
|`gt`|[\<switch_to_right_tab\>]({{ site.url }}/cheat_sheet/functions/#switch_to_right_tab)|
|`?`, `/`|[\<search_pattern\>]({{ site.url }}/cheat_sheet/functions/#search_pattern)|
|`/`, `?`|[\<search_pattern\>]({{ site.url }}/cheat_sheet/functions/#search_pattern)|

### Mode Transition on Vim Emulation

Expand All @@ -64,10 +64,10 @@ nav: Normal Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`<C-h>`, `h`, `<BS>`, `<Left>`|[\<move_caret_left\>]({{ site.url }}/cheat_sheet/functions/#move_caret_left)|
|`<Right>`, `l`, `<Space>`|[\<move_caret_right\>]({{ site.url }}/cheat_sheet/functions/#move_caret_right)|
|`<C-p>`, `-`, `<Up>`, `gk`, `k`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
|`j`, `<C-n>`, `<Enter>`, `<Down>`, `<C-m>`, `+`, `gj`|[\<move_caret_down\>]({{ site.url }}/cheat_sheet/functions/#move_caret_down)|
|`<BS>`, `<Left>`, `<C-h>`, `h`|[\<move_caret_left\>]({{ site.url }}/cheat_sheet/functions/#move_caret_left)|
|`l`, `<Right>`, `<Space>`|[\<move_caret_right\>]({{ site.url }}/cheat_sheet/functions/#move_caret_right)|
|`<Up>`, `-`, `gk`, `<C-p>`, `k`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
|`j`, `<C-n>`, `<Down>`, `<C-m>`, `gj`, `<Enter>`, `+`|[\<move_caret_down\>]({{ site.url }}/cheat_sheet/functions/#move_caret_down)|
|`w`|[\<move_fwd_word\>]({{ site.url }}/cheat_sheet/functions/#move_fwd_word)|
|`b`|[\<move_bck_word\>]({{ site.url }}/cheat_sheet/functions/#move_bck_word)|
|`W`|[\<move_fwd_bigword\>]({{ site.url }}/cheat_sheet/functions/#move_fwd_bigword)|
Expand All @@ -81,8 +81,8 @@ nav: Normal Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`0`, `<Home>`, `g0`|[\<jump_caret_to_BOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bol)|
|`g$`, `<End>`, `$`|[\<jump_caret_to_EOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_eol)|
|`0`, `g0`, `<Home>`|[\<jump_caret_to_BOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bol)|
|`$`, `g$`, `<End>`|[\<jump_caret_to_EOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_eol)|
|`gg`|[\<jump_caret_to_BOF\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bof)|
|`G`|[\<jump_caret_to_EOF\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_eof)|

Expand All @@ -96,15 +96,15 @@ nav: Normal Mappings
|`P`|[\<put_before\>]({{ site.url }}/cheat_sheet/functions/#put_before)|
|`dd`|[\<delete_line\>]({{ site.url }}/cheat_sheet/functions/#delete_line)|
|`D`|[\<delete_line_until_EOL\>]({{ site.url }}/cheat_sheet/functions/#delete_line_until_eol)|
|`<Del>`, `x`|[\<delete_after\>]({{ site.url }}/cheat_sheet/functions/#delete_after)|
|`x`, `<Del>`|[\<delete_after\>]({{ site.url }}/cheat_sheet/functions/#delete_after)|
|`X`|[\<delete_before\>]({{ site.url }}/cheat_sheet/functions/#delete_before)|
|`J`|[\<join_next_line\>]({{ site.url }}/cheat_sheet/functions/#join_next_line)|
|`r`|[\<replace_char\>]({{ site.url }}/cheat_sheet/functions/#replace_char)|
|`R`|[\<replace_sequence\>]({{ site.url }}/cheat_sheet/functions/#replace_sequence)|
|`~`|[\<switch_char_case\>]({{ site.url }}/cheat_sheet/functions/#switch_char_case)|
|`d`|[\<delete_with_motion\>]({{ site.url }}/cheat_sheet/functions/#delete_with_motion)|
|`c`|[\<change_with_motion\>]({{ site.url }}/cheat_sheet/functions/#change_with_motion)|
|`cc`, `S`|[\<change_line\>]({{ site.url }}/cheat_sheet/functions/#change_line)|
|`S`, `cc`|[\<change_line\>]({{ site.url }}/cheat_sheet/functions/#change_line)|
|`s`|[\<change_char\>]({{ site.url }}/cheat_sheet/functions/#change_char)|
|`C`|[\<change_until_EOL\>]({{ site.url }}/cheat_sheet/functions/#change_until_eol)|
|`.`|[\<repeat_last_change\>]({{ site.url }}/cheat_sheet/functions/#repeat_last_change)|
Expand All @@ -118,14 +118,14 @@ nav: Normal Mappings
|`<ctrl-]>`, `<Esc-Left>`|[\<to_gui_normal\>]({{ site.url }}/cheat_sheet/functions/#to_gui_normal)|
|`<Esc-Down>`|[\<to_resident\>]({{ site.url }}/cheat_sheet/functions/#to_resident)|
|`:`|[\<to_command\>]({{ site.url }}/cheat_sheet/functions/#to_command)|
|`<ctrl-[>`, `<Esc-Right>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
|`<Esc-Right>`, `<ctrl-[>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|

### Scrolling

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`<C-y>`, `<C-k>`|[\<scroll_up\>]({{ site.url }}/cheat_sheet/functions/#scroll_up)|
|`<C-e>`, `<C-j>`|[\<scroll_down\>]({{ site.url }}/cheat_sheet/functions/#scroll_down)|
|`<C-k>`, `<C-y>`|[\<scroll_up\>]({{ site.url }}/cheat_sheet/functions/#scroll_up)|
|`<C-j>`, `<C-e>`|[\<scroll_down\>]({{ site.url }}/cheat_sheet/functions/#scroll_down)|
|`<C-u>`|[\<scroll_up_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_up_halfpage)|
|`<C-d>`|[\<scroll_down_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_down_halfpage)|
|`<C-b>`|[\<scroll_up_onepage\>]({{ site.url }}/cheat_sheet/functions/#scroll_up_onepage)|
Expand All @@ -139,19 +139,19 @@ nav: Normal Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`<C-h>`, `h`, `<BS>`, `<Left>`|[\<move_caret_left\>]({{ site.url }}/cheat_sheet/functions/#move_caret_left)|
|`<Right>`, `l`, `<Space>`|[\<move_caret_right\>]({{ site.url }}/cheat_sheet/functions/#move_caret_right)|
|`<C-p>`, `-`, `<Up>`, `gk`, `k`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
|`j`, `<C-n>`, `<Enter>`, `<Down>`, `<C-m>`, `+`, `gj`|[\<move_caret_down\>]({{ site.url }}/cheat_sheet/functions/#move_caret_down)|
|`<BS>`, `<Left>`, `<C-h>`, `h`|[\<move_caret_left\>]({{ site.url }}/cheat_sheet/functions/#move_caret_left)|
|`l`, `<Right>`, `<Space>`|[\<move_caret_right\>]({{ site.url }}/cheat_sheet/functions/#move_caret_right)|
|`<Up>`, `-`, `gk`, `<C-p>`, `k`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
|`j`, `<C-n>`, `<Down>`, `<C-m>`, `gj`, `<Enter>`, `+`|[\<move_caret_down\>]({{ site.url }}/cheat_sheet/functions/#move_caret_down)|
|`w`|[\<move_fwd_word_simple\>]({{ site.url }}/cheat_sheet/functions/#move_fwd_word_simple)|
|`b`|[\<move_bck_word_simple\>]({{ site.url }}/cheat_sheet/functions/#move_bck_word_simple)|

### Caret Jumping on Vim Emulation

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`0`, `<Home>`, `g0`|[\<jump_caret_to_BOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bol)|
|`g$`, `<End>`, `$`|[\<jump_caret_to_EOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_eol)|
|`0`, `g0`, `<Home>`|[\<jump_caret_to_BOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bol)|
|`$`, `g$`, `<End>`|[\<jump_caret_to_EOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_eol)|
|`gg`|[\<jump_caret_to_BOF\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bof)|
|`G`|[\<jump_caret_to_EOF\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_eof)|

Expand All @@ -160,14 +160,14 @@ nav: Normal Mappings
|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`y`|[\<yank_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#yank_highlight_text)|
|`d`, `x`, `X`|[\<delete_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#delete_highlight_text)|
|`s`, `c`, `S`|[\<change_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#change_highlight_text)|
|`x`, `X`, `d`|[\<delete_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#delete_highlight_text)|
|`S`, `c`, `s`|[\<change_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#change_highlight_text)|

## Insert Mode

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`<ctrl-[>`, `<Esc-Right>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
|`<Esc-Right>`, `<ctrl-[>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|

## Resident Mode

Expand All @@ -179,7 +179,7 @@ nav: Normal Mappings

|**Trigger Commands**|**Called Commands**|
|:---:|:---:|
|`en`, `edinormal`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
|`edinormal`, `en`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
|`ev`, `edivisual`|[\<to_edi_visual\>]({{ site.url }}/cheat_sheet/functions/#to_edi_visual)|
|`evl`, `edivisualline`|[\<to_edi_visual_line\>]({{ site.url }}/cheat_sheet/functions/#to_edi_visual_line)|

Expand Down
Loading

0 comments on commit 60498e3

Please sign in to comment.