Skip to content

fix: Update mappings README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dimtion merged 1 commit into from
Nov 23, 2025
Merged

fix: Update mappings README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,26 +164,22 @@ To make marks more effective in vim, GutterMarks comes with a few actions that
can be used by creating key mappings:

```lua
-- Delete the mark under the cursor
vim.keymap.set("m;", require("guttermarks.actions").delete_mark)
vim.keymap.set("n", "m;", require("guttermarks.actions").delete_mark, { desc = "Delete mark under cursor" })

-- Navigate to next/previous mark in current buffer
vim.keymap.set("]m", require("guttermarks.actions").next_buf_mark)
vim.keymap.set("[m", require("guttermarks.actions").prev_buf_mark)
vim.keymap.set("n", "]m", require("guttermarks.actions").next_buf_mark, { desc = "Next mark in current buffer" })
vim.keymap.set("n", "[m", require("guttermarks.actions").prev_buf_mark, { desc = "Previous mark in current buffer" })

-- Send marks to quickfix (and open it)
vim.keymap.set("<leader>mq", function()
vim.keymap.set("n", "<leader>mq", function()
require("guttermarks.actions").marks_to_quickfix()
vim.cmd("copen")
end)
end, { desc = "Send marks to quickfix (and open it)" })

-- Send marks to quickfix (include special marks)
vim.keymap.set("<leader>mQ", function()
vim.keymap.set("n", "<leader>mQ", function()
require("guttermarks.actions").marks_to_quickfix({
special_mark = true,
})
vim.cmd("copen")
end)
end, { desc = "Send marks to quickfix (include special marks)" })
```

## Vim Marks cheat-sheet
Expand Down