Skip to content

Commit d425ca9

Browse files
authored
feat: add disable_default_keymaps option (#6)
Add disable_default_keymaps config option (default: false) that allow users to completely disable default keybinds and set custom ones
1 parent 70551a3 commit d425ca9

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Vim's built-in marks are great, but they're global and get messy fast. Marksman
5757
search_in_ui = true,
5858
silent = false,
5959
minimal = false,
60+
disable_default_keymaps = false,
6061
},
6162
}
6263
```
@@ -77,6 +78,7 @@ require("marksman").setup({
7778
},
7879
auto_save = true,
7980
max_marks = 100,
81+
disable_default_keymaps = false,
8082
})
8183
```
8284

@@ -95,6 +97,18 @@ require("marksman").setup({
9597
})
9698
```
9799

100+
### Disable Default Keymaps
101+
102+
```lua
103+
require("marksman").setup({
104+
disable_default_keymaps = true,
105+
})
106+
107+
-- Set your own keymaps manually
108+
vim.keymap.set("n", "<leader>ma", require("marksman").add_mark)
109+
vim.keymap.set("n", "<leader>ms", require("marksman").show_marks)
110+
```
111+
98112
### Custom Highlights
99113

100114
```lua
@@ -297,6 +311,7 @@ storage.get_project_name() -- Get current project name
297311
| `search_in_ui` | boolean | `true` | Enable search in UI |
298312
| `minimal` | boolean | `false` | Set to true for clean UI (number, name, and filepath only)|
299313
| `silent` | boolean | `false` | Set to true to supress notifications|
314+
| `disable_default_keymaps` | boolean | `false` | Set to true to disable all default keymaps |
300315
| `highlights` | table | `{...}` | Custom highlight groups |
301316

302317
## How it works

lua/marksman/init.lua

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ local default_config = {
3232
search_in_ui = true,
3333
silent = false,
3434
minimal = false,
35+
disable_default_keymaps = false,
3536
}
3637

3738
local config = {}
@@ -304,7 +305,7 @@ function M.setup(opts)
304305
end
305306

306307
-- Set keymaps if not disabled
307-
if config.keymaps ~= false then
308+
if not config.disable_default_keymaps and config.keymaps ~= false then
308309
local keymaps = config.keymaps
309310

310311
if keymaps.add then

0 commit comments

Comments
 (0)