mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-01 19:23:24 +00:00
docs: add docs for vim mode
This commit is contained in:
parent
f73c6d4aa8
commit
24b88a0483
16
docs/vimMode/actions.txt
Normal file
16
docs/vimMode/actions.txt
Normal file
@ -0,0 +1,16 @@
|
||||
Vim actions are essentially just when a user uses a Vim keybind.
|
||||
Things like yanking and pasting are Vim actions.
|
||||
This is not an "offical Vim thing," just a Hilbish thing.
|
||||
|
||||
The `hilbish.vimAction` hook is thrown whenever a Vim action occurs.
|
||||
It passes 2 arguments: the action name, and an array (table) of args
|
||||
relating to it.
|
||||
|
||||
Here is documentation for what the table of args will hold for an
|
||||
appropriate Vim action.
|
||||
|
||||
- `yank`: register, yankedText
|
||||
The first argument for the yank action is the register yankedText goes to.
|
||||
|
||||
- `paste`: register, pastedText
|
||||
The first argument for the paste action is the register pastedText is taken from.
|
4
docs/vimMode/index.txt
Normal file
4
docs/vimMode/index.txt
Normal file
@ -0,0 +1,4 @@
|
||||
Hilbish has a Vim binding input mode accessible for use.
|
||||
It can be enabled with the `hilbish.inputMode` function (check `doc hilbish`).
|
||||
|
||||
This is documentation for everything relating to it.
|
Loading…
x
Reference in New Issue
Block a user