docs: add docs for vim mode

pull/128/head
TorchedSammy 2022-03-17 20:25:38 -04:00
parent f73c6d4aa8
commit 24b88a0483
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
2 changed files with 20 additions and 0 deletions

View 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.

View 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.