Merge pull request #211 from pit-ray/add-59 (close #59, close #183)

Add help command.
pit-ray · Jan 14, 2024 · b7770ee · b7770ee
2 parents 7581643 + b3e512b
commit b7770ee
Show file tree

Hide file tree

Showing 23 changed files with 257 additions and 91 deletions.
diff --git a/docs/cheat_sheet/defaults/big/index.md b/docs/cheat_sheet/defaults/big/index.md
@@ -19,8 +19,8 @@ nav: Big Mappings
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
 |`V`|[\<select_all\>]({{ site.url }}/cheat_sheet/functions/#select_all)|
-|`Y`, `y`, `yy`|[\<hotkey_copy\>]({{ site.url }}/cheat_sheet/functions/#hotkey_copy)|
-|`p`, `P`|[\<hotkey_paste\>]({{ site.url }}/cheat_sheet/functions/#hotkey_paste)|
+|`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)|
 |`x`, `<Del>`|[\<hotkey_delete\>]({{ site.url }}/cheat_sheet/functions/#hotkey_delete)|
 |`X`|[\<hotkey_backspace\>]({{ site.url }}/cheat_sheet/functions/#hotkey_backspace)|
@@ -52,16 +52,16 @@ nav: Big Mappings
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
 |`<BS>`, `<Left>`, `h`|[\<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)|
+|`l`, `<Space>`, `<Right>`|[\<move_cursor_right\>]({{ site.url }}/cheat_sheet/functions/#move_cursor_right)|
+|`<Up>`, `-`, `k`|[\<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)|
@@ -77,17 +77,17 @@ nav: Big Mappings
 |`<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)|
 |`<C-f>`|[\<scroll_down_onepage\>]({{ site.url }}/cheat_sheet/functions/#scroll_down_onepage)|
-|`<C-h>`, `zh`|[\<scroll_left\>]({{ site.url }}/cheat_sheet/functions/#scroll_left)|
-|`<C-l>`, `zl`|[\<scroll_right\>]({{ site.url }}/cheat_sheet/functions/#scroll_right)|
+|`zh`, `<C-h>`|[\<scroll_left\>]({{ site.url }}/cheat_sheet/functions/#scroll_left)|
+|`zl`, `<C-l>`|[\<scroll_right\>]({{ site.url }}/cheat_sheet/functions/#scroll_right)|
 |`zH`|[\<scroll_left_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_left_halfpage)|
 |`zL`|[\<scroll_right_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_right_halfpage)|
 
 ### Hotkey
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`Y`, `y`, `yy`|[\<hotkey_copy\>]({{ site.url }}/cheat_sheet/functions/#hotkey_copy)|
-|`p`, `P`|[\<hotkey_paste\>]({{ site.url }}/cheat_sheet/functions/#hotkey_paste)|
+|`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)|
 |`x`, `<Del>`|[\<hotkey_delete\>]({{ site.url }}/cheat_sheet/functions/#hotkey_delete)|
 |`X`|[\<hotkey_backspace\>]({{ site.url }}/cheat_sheet/functions/#hotkey_backspace)|
@@ -98,7 +98,7 @@ nav: Big Mappings
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`guivisual`, `gv`|[\<to_gui_visual\>]({{ site.url }}/cheat_sheet/functions/#to_gui_visual)|
+|`gv`, `guivisual`|[\<to_gui_visual\>]({{ site.url }}/cheat_sheet/functions/#to_gui_visual)|
 
 ### Shortcut
 
@@ -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!`, `q`, `tabclose`|[\<close_current_tab\>]({{ site.url }}/cheat_sheet/functions/#close_current_tab)|
+|`tabclose`, `q`, `q!`|[\<close_current_tab\>]({{ site.url }}/cheat_sheet/functions/#close_current_tab)|
 |`ex`, `explorer`|[\<start_explorer\>]({{ site.url }}/cheat_sheet/functions/#start_explorer)|
-|`win`, `start`|[\<open_startmenu\>]({{ site.url }}/cheat_sheet/functions/#open_startmenu)|
-|`open`, `find`|[\<open\>]({{ site.url }}/cheat_sheet/functions/#open)|
+|`start`, `win`|[\<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)|

diff --git a/docs/cheat_sheet/defaults/normal/index.md b/docs/cheat_sheet/defaults/normal/index.md
@@ -10,7 +10,7 @@ nav: Normal Mappings
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`I`, `<ctrl-[>`, `<esc-right>`|[\<click_left\>]({{ site.url }}/cheat_sheet/functions/#click_left)[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
+|`I`, `<esc-right>`, `<ctrl-[>`|[\<click_left\>]({{ site.url }}/cheat_sheet/functions/#click_left)[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
 
 ## Editor Normal Mode
 
@@ -35,8 +35,8 @@ nav: Normal Mappings
 |`<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)|
 |`<C-f>`|[\<scroll_down_onepage\>]({{ site.url }}/cheat_sheet/functions/#scroll_down_onepage)|
-|`<C-h>`, `zh`|[\<scroll_left\>]({{ site.url }}/cheat_sheet/functions/#scroll_left)|
-|`<C-l>`, `zl`|[\<scroll_right\>]({{ site.url }}/cheat_sheet/functions/#scroll_right)|
+|`zh`, `<C-h>`|[\<scroll_left\>]({{ site.url }}/cheat_sheet/functions/#scroll_left)|
+|`zl`, `<C-l>`|[\<scroll_right\>]({{ site.url }}/cheat_sheet/functions/#scroll_right)|
 |`zH`|[\<scroll_left_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_left_halfpage)|
 |`zL`|[\<scroll_right_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_right_halfpage)|
 
@@ -64,10 +64,10 @@ nav: Normal Mappings
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`<C-h>`, `<BS>`, `<Left>`, `h`|[\<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)|
-|`k`, `<Up>`, `gk`, `<C-p>`, `-`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
-|`<C-n>`, `<C-m>`, `gj`, `j`, `<Enter>`, `+`, `<Down>`|[\<move_caret_down\>]({{ site.url }}/cheat_sheet/functions/#move_caret_down)|
+|`<BS>`, `<C-h>`, `<Left>`, `h`|[\<move_caret_left\>]({{ site.url }}/cheat_sheet/functions/#move_caret_left)|
+|`l`, `<Space>`, `<Right>`|[\<move_caret_right\>]({{ site.url }}/cheat_sheet/functions/#move_caret_right)|
+|`gk`, `<C-p>`, `<Up>`, `-`, `k`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
+|`j`, `gj`, `<C-n>`, `<Down>`, `<Enter>`, `+`, `<C-m>`|[\<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)|
@@ -81,16 +81,16 @@ nav: Normal Mappings
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`g0`, `0`, `<Home>`|[\<jump_caret_to_BOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bol)|
-|`<End>`, `g$`, `$`|[\<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)|
 
 ### Edit on Vim Emulation
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`Y`, `yy`|[\<yank_line\>]({{ site.url }}/cheat_sheet/functions/#yank_line)|
+|`yy`, `Y`|[\<yank_line\>]({{ site.url }}/cheat_sheet/functions/#yank_line)|
 |`y`|[\<yank_with_motion\>]({{ site.url }}/cheat_sheet/functions/#yank_with_motion)|
 |`p`|[\<put_after\>]({{ site.url }}/cheat_sheet/functions/#put_after)|
 |`P`|[\<put_before\>]({{ site.url }}/cheat_sheet/functions/#put_before)|
@@ -118,7 +118,7 @@ nav: Normal Mappings
 |`<Esc-Left>`, `<ctrl-]>`|[\<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)|
-|`<Esc-Right>`, `<ctrl-[>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
+|`<ctrl-[>`, `<Esc-Right>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
 
 ### Scrolling
 
@@ -130,28 +130,28 @@ nav: Normal Mappings
 |`<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)|
 |`<C-f>`|[\<scroll_down_onepage\>]({{ site.url }}/cheat_sheet/functions/#scroll_down_onepage)|
-|`<C-h>`, `zh`|[\<scroll_left\>]({{ site.url }}/cheat_sheet/functions/#scroll_left)|
-|`<C-l>`, `zl`|[\<scroll_right\>]({{ site.url }}/cheat_sheet/functions/#scroll_right)|
+|`zh`, `<C-h>`|[\<scroll_left\>]({{ site.url }}/cheat_sheet/functions/#scroll_left)|
+|`zl`, `<C-l>`|[\<scroll_right\>]({{ site.url }}/cheat_sheet/functions/#scroll_right)|
 |`zH`|[\<scroll_left_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_left_halfpage)|
 |`zL`|[\<scroll_right_halfpage\>]({{ site.url }}/cheat_sheet/functions/#scroll_right_halfpage)|
 
 ### Caret Movement on Vim Emulation
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`<C-h>`, `<BS>`, `<Left>`, `h`|[\<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)|
-|`k`, `<Up>`, `gk`, `<C-p>`, `-`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
-|`<C-n>`, `<C-m>`, `gj`, `j`, `<Enter>`, `+`, `<Down>`|[\<move_caret_down\>]({{ site.url }}/cheat_sheet/functions/#move_caret_down)|
+|`<BS>`, `<C-h>`, `<Left>`, `h`|[\<move_caret_left\>]({{ site.url }}/cheat_sheet/functions/#move_caret_left)|
+|`l`, `<Space>`, `<Right>`|[\<move_caret_right\>]({{ site.url }}/cheat_sheet/functions/#move_caret_right)|
+|`gk`, `<C-p>`, `<Up>`, `-`, `k`|[\<move_caret_up\>]({{ site.url }}/cheat_sheet/functions/#move_caret_up)|
+|`j`, `gj`, `<C-n>`, `<Down>`, `<Enter>`, `+`, `<C-m>`|[\<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**|
 |:---:|:---:|
-|`g0`, `0`, `<Home>`|[\<jump_caret_to_BOL\>]({{ site.url }}/cheat_sheet/functions/#jump_caret_to_bol)|
-|`<End>`, `g$`, `$`|[\<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)|
 
@@ -160,14 +160,14 @@ nav: Normal Mappings
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
 |`y`|[\<yank_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#yank_highlight_text)|
-|`X`, `x`, `d`|[\<delete_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#delete_highlight_text)|
+|`X`, `d`, `x`|[\<delete_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#delete_highlight_text)|
 |`c`, `S`, `s`|[\<change_highlight_text\>]({{ site.url }}/cheat_sheet/functions/#change_highlight_text)|
 
 ## Insert Mode
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`<Esc-Right>`, `<ctrl-[>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
+|`<ctrl-[>`, `<Esc-Right>`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
 
 ## Resident Mode
 
@@ -179,9 +179,9 @@ nav: Normal Mappings
 
 |**Trigger Commands**|**Called Commands**|
 |:---:|:---:|
-|`en`, `edinormal`|[\<to_edi_normal\>]({{ site.url }}/cheat_sheet/functions/#to_edi_normal)|
-|`edivisual`, `ev`|[\<to_edi_visual\>]({{ site.url }}/cheat_sheet/functions/#to_edi_visual)|
-|`edivisualline`, `evl`|[\<to_edi_visual_line\>]({{ site.url }}/cheat_sheet/functions/#to_edi_visual_line)|
+|`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)|
 
 ### Shortcut