Skip to content

Commit b3b8534

Browse files
docs: Add docs around disabling specific mappings
1 parent 215dd10 commit b3b8534

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

Diff for: DOCS.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ Nested key example:<br />
494494

495495
Lua expression example:<br />
496496
```lua
497-
{
497+
{
498498
j = {
499499
description = 'Journal',
500500
template = '* %(return vim.fn.getreg "w")',
@@ -601,6 +601,26 @@ require('orgmode').setup({
601601
})
602602
```
603603

604+
To disable a specific mapping, set it's value to `false`:
605+
606+
```lua
607+
require('orgmode').setup({
608+
org_agenda_files = {'~/Dropbox/org/*', '~/my-orgs/**/*'},
609+
org_default_notes_file = '~/Dropbox/org/refile.org',
610+
mappings = {
611+
global = {
612+
org_agenda = false,
613+
org_capture = 'gC'
614+
},
615+
agenda = {
616+
org_agenda_later = false
617+
}
618+
}
619+
})
620+
```
621+
622+
You can find the configuration file that holds all default mappings [here](./lua/orgmode/config/mappings/init.lua)
623+
604624
**NOTE**: All mappings are normal mode mappings (`nnoremap`)
605625

606626
### Global mappings

0 commit comments

Comments
 (0)