Skip to content

Commit

Permalink
chore: auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gbprod authored and github-actions[bot] committed Nov 23, 2023
1 parent ea4913e commit 631b44d
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions doc/yanky.txt
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,9 @@ Yanky comes with the following defaults:

⌨️ MAPPINGS ~

This plugin contains no default mappings and will have no effect until you add
your own maps to it. You should at least set those keymaps:
**This plugin contains no default mappings and will have no effect until you
add your own maps to it.** You should at least set those keymaps for yank ring
usage:

>lua
vim.keymap.set({"n","x"}, "p", "<Plug>(YankyPutAfter)")
Expand All @@ -169,6 +170,23 @@ your own maps to it. You should at least set those keymaps:
vim.keymap.set({"n","x"}, "gP", "<Plug>(YankyGPutBefore)")
<

And those keymaps for `tpope/vim-unimpaired` like usage:

>lua
vim.keymap.set("n", "]p", "<Plug>(YankyPutIndentAfterLinewise)")
vim.keymap.set("n", "[p", "<Plug>(YankyPutIndentBeforeLinewise)")
vim.keymap.set("n", "]P", "<Plug>(YankyPutIndentAfterLinewise)")
vim.keymap.set("n", "[P", "<Plug>(YankyPutIndentBeforeLinewise)")

vim.keymap.set("n", ">p", "<Plug>(YankyPutIndentAfterShiftRight)")
vim.keymap.set("n", "<p", "<Plug>(YankyPutIndentAfterShiftLeft)")
vim.keymap.set("n", ">P", "<Plug>(YankyPutIndentBeforeShiftRight)")
vim.keymap.set("n", "<P", "<Plug>(YankyPutIndentBeforeShiftLeft)")

vim.keymap.set("n", "=p", "<Plug>(YankyPutAfterFilter)")
vim.keymap.set("n", "=P", "<Plug>(YankyPutBeforeFilter)")
<

Some features requires specific mappings, refer to feature documentation
section.

Expand Down

0 comments on commit 631b44d

Please sign in to comment.