diff --git a/docs/vimMode/actions.txt b/docs/vimMode/actions.txt new file mode 100644 index 0000000..9dfb7b2 --- /dev/null +++ b/docs/vimMode/actions.txt @@ -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. diff --git a/docs/vimMode/index.txt b/docs/vimMode/index.txt new file mode 100644 index 0000000..a30fe74 --- /dev/null +++ b/docs/vimMode/index.txt @@ -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.