docs: note vendoredKeymaps and ability to disable keymap options

This commit is contained in:
alfarel 2026-03-30 10:10:02 -04:00
commit 3860063606
No known key found for this signature in database

View file

@ -1,8 +1,10 @@
# Custom keymaps {#ch-keymaps} # Custom keymaps {#ch-keymaps}
Some plugin modules provide keymap options for your convenience. If a keymap is Some plugin modules provide keymap options for your convenience. These can be
not provided by such module options, you may easily register your own custom disabled using {option}`vim.vendoredKeymaps`. It is also possible to disable
keymaps via {option}`vim.keymaps`. individual keymaps with options by setting them to `null`. If a keymap is not
provided by a module, you may easily register your own custom keymaps via
{option}`vim.keymaps`.
```nix ```nix
{ {
@ -22,7 +24,7 @@ keymaps via {option}`vim.keymaps`.
{ {
key = "<leader>k"; key = "<leader>k";
mode = ["n" "x"]; mode = ["n" "x"];
# While `lua` is `true`, `action` is expected to be # While `lua` is `true`, `action` is expected to be
# a valid Lua expression. # a valid Lua expression.
lua = true; lua = true;