Skip to content

Commit 69bafe6

Browse files
authored
docs: add mode for lazy keys (#230)
1 parent 46ec82f commit 69bafe6

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- markdownlint-disable MD013 MD034 MD033 -->
1+
<!-- markdownlint-disable MD001 MD013 MD034 MD033 -->
22

33
# gitlinker.nvim
44

@@ -80,9 +80,10 @@ require("lazy").setup({
8080
cmd = "GitLink",
8181
opts = {},
8282
keys = {
83-
{ "<leader>gy", "<cmd>GitLink<cr>", desc = "Yank git link" },
83+
{ "<leader>gy", "<cmd>GitLink<cr>", mode = { "n", "v" }, desc = "Yank git link" },
84+
{ "<leader>gY", "<cmd>GitLink!<cr>", mode = { "n", "v" }, desc = "Open git link" },
8485
},
85-
}
86+
},
8687
})
8788
```
8889

@@ -251,52 +252,52 @@ vim.keymap.set(
251252
{"n", 'v'},
252253
"<leader>gl",
253254
"<cmd>GitLink<cr>",
254-
{ silent = true, noremap = true, desc = "Copy git permlink to clipboard" }
255+
{ silent = true, noremap = true, desc = "Yank git permlink" }
255256
)
256257
vim.keymap.set(
257258
{"n", 'v'},
258259
"<leader>gL",
259260
"<cmd>GitLink!<cr>",
260-
{ silent = true, noremap = true, desc = "Open git permlink in browser" }
261+
{ silent = true, noremap = true, desc = "Open git permlink" }
261262
)
262263
-- blame
263264
vim.keymap.set(
264265
{"n", 'v'},
265266
"<leader>gb",
266267
"<cmd>GitLink blame<cr>",
267-
{ silent = true, noremap = true, desc = "Copy git blame link to clipboard" }
268+
{ silent = true, noremap = true, desc = "Yank git blame link" }
268269
)
269270
vim.keymap.set(
270271
{"n", 'v'},
271272
"<leader>gB",
272273
"<cmd>GitLink! blame<cr>",
273-
{ silent = true, noremap = true, desc = "Open git blame link in browser" }
274+
{ silent = true, noremap = true, desc = "Open git blame link" }
274275
)
275276
-- default branch
276277
vim.keymap.set(
277278
{"n", 'v'},
278279
"<leader>gd",
279280
"<cmd>GitLink default_branch<cr>",
280-
{ silent = true, noremap = true, desc = "Copy default branch link to clipboard" }
281+
{ silent = true, noremap = true, desc = "Copy default branch link" }
281282
)
282283
vim.keymap.set(
283284
{"n", 'v'},
284285
"<leader>gD",
285286
"<cmd>GitLink! default_branch<cr>",
286-
{ silent = true, noremap = true, desc = "Open default branch link in browser" }
287+
{ silent = true, noremap = true, desc = "Open default branch link" }
287288
)
288289
-- default branch
289290
vim.keymap.set(
290291
{"n", 'v'},
291292
"<leader>gc",
292293
"<cmd>GitLink current_branch<cr>",
293-
{ silent = true, noremap = true, desc = "Copy current branch link to clipboard" }
294+
{ silent = true, noremap = true, desc = "Copy current branch link" }
294295
)
295296
vim.keymap.set(
296297
{"n", 'v'},
297298
"<leader>gD",
298299
"<cmd>GitLink! current_branch<cr>",
299-
{ silent = true, noremap = true, desc = "Open current branch link in browser" }
300+
{ silent = true, noremap = true, desc = "Open current branch link" }
300301
)
301302
```
302303

@@ -506,7 +507,7 @@ The 2 branch components are:
506507
- `default_branch`
507508
- `current_branch`
508509

509-
Thus you can implement your router with below lua function:
510+
Recall to previous use case, e.g. customize the line numbers in form `?&line=1&lines-count=2`, you can implement the router with below function:
510511

511512
```lua
512513
--- @param s string

0 commit comments

Comments
 (0)