Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 9, 2023
1 parent fd3176d commit 8fb15fe
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions doc/trouble.nvim.txt
@@ -1,4 +1,4 @@
*trouble.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 October 08
*trouble.nvim.txt* For Neovim >= 0.8.0 Last change: 2023 October 09

==============================================================================
Table of Contents *trouble.nvim-table-of-contents*
Expand Down Expand Up @@ -192,12 +192,12 @@ Example keybindings:

>lua
-- Lua
vim.keymap.set("n", "<leader>xx", function() require("trouble").open() end)
vim.keymap.set("n", "<leader>xw", function() require("trouble").open("workspace_diagnostics") end)
vim.keymap.set("n", "<leader>xd", function() require("trouble").open("document_diagnostics") end)
vim.keymap.set("n", "<leader>xq", function() require("trouble").open("quickfix") end)
vim.keymap.set("n", "<leader>xl", function() require("trouble").open("loclist") end)
vim.keymap.set("n", "gR", function() require("trouble").open("lsp_references") end)
vim.keymap.set("n", "<leader>xx", function() require("trouble").toggle() end)
vim.keymap.set("n", "<leader>xw", function() require("trouble").toggle("workspace_diagnostics") end)
vim.keymap.set("n", "<leader>xd", function() require("trouble").toggle("document_diagnostics") end)
vim.keymap.set("n", "<leader>xq", function() require("trouble").toggle("quickfix") end)
vim.keymap.set("n", "<leader>xl", function() require("trouble").toggle("loclist") end)
vim.keymap.set("n", "gR", function() require("trouble").toggle("lsp_references") end)
<


Expand All @@ -206,6 +206,15 @@ API ~
You can use the following functions in your keybindings:

>lua
-- toggle trouble with optional mode
require("trouble").toggle(mode?)

-- open trouble with optional mode
require("trouble").open(mode?)

-- close trouble
require("trouble").close()

-- jump to the next item, skipping the groups
require("trouble").next({skip_groups = true, jump = true});

Expand Down

0 comments on commit 8fb15fe

Please sign in to comment.