Skip to content

Commit bfbe7b9

Browse files
committed
chore(keybinds): improve wording for wiki page
1 parent 909776f commit bfbe7b9

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

lua/neorg/modules/core/keybinds/module.lua

+8-2
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,18 @@ By default when you load the `core.keybinds` module all keybinds will be enabled
2323
### Remapping Keys
2424
2525
To understand how to effectively remap keys, one must understand how keybinds are set.
26-
Neorg binds keys to various `<Plug>` mappings bound to `<Plug>(neorg...`.
26+
Neorg binds actions to various `<Plug>` mappings that look like so: `<Plug>(neorg...`.
2727
28-
To remap a key, simply map it somewhere in your configuration:
28+
To remap a key, simply map an action somewhere in your configuration:
2929
3030
```lua
3131
vim.keymap.set("n", "my-key-here", "<Plug>(neorg.pivot.list.toggle)", {})
3232
```
3333
3434
Neorg will recognize that the key has been bound by you and not bind its own key.
3535
36+
#### Binding Keys for Norg Files Only
37+
3638
This approach has a downside - all of Neorg's keybinds are set on a per-buffer basis
3739
so that keybinds don't "overflow" into buffers you don't want them active in.
3840
@@ -54,6 +56,10 @@ files. There are two ways to combat this:
5456
5557
Notice that in both situations a `{ buffer = true }` was supplied to the function.
5658
This way, your remapped keys will never interfere with other files.
59+
60+
### Discovering Keys
61+
62+
A comprehensive list of all keybinds can be found on [this page!](https://github.com/nvim-neorg/neorg/wiki/Default-Keybinds)
5763
--]]
5864

5965
local neorg = require("neorg.core")

0 commit comments

Comments
 (0)