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 Nov 13, 2022
1 parent a8b3117 commit b4ac173
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions doc/noice.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ Suggested setup:
long_message_to_split = true, -- long messages will be sent to a split
inc_rename = false, -- enables an input dialog for inc-rename.nvim
lsp_doc_border = false, -- add a border to hover docs and signature help
cmdline_output_to_split = false, -- send the output of a command you executed in the cmdline to a split
},
})
<
Expand Down Expand Up @@ -179,6 +178,13 @@ for configuration recipes.
-- Icons for completion item kinds (see defaults at noice.config.icons.kinds)
kind_icons = {}, -- set to `false` to disable icons
},
-- default options for require('noice').redirect
-- see the section on Command Redirection
---@type NoiceRouteConfig
redirect = {
view = "popup",
filter = { event = "msg_show" },
},
-- You can add any custom commands below that will be available with `:Noice command`
---@type table<string, NoiceCommand>
commands = {
Expand Down Expand Up @@ -318,7 +324,6 @@ for configuration recipes.
long_message_to_split = false, -- long messages will be sent to a split
inc_rename = false, -- enables an input dialog for inc-rename.nvim
lsp_doc_border = false, -- add a border to hover docs and signature help
cmdline_output_to_split = false, -- send the output of a command you executed in the cmdline to a split
},
throttle = 1000 / 30, -- how frequently does Noice need to check for ui updates? This has no effect when in blocking mode.
---@type NoiceConfigViews
Expand Down Expand Up @@ -735,6 +740,37 @@ You can also use `Lua` equivalents.
You can add custom commands with `config.commands`


COMMAND REDIRECTION ~

Sometimes it’s useful to redirect the messages generated by a command or
function to a different view. That can be easily achieved with command
redirection.

The redirect API can taken an optional `routes` parameter, which defaults to
`{config.redirect}`.

>
-- redirect ":hi"
require("noice").redirect("hi")
-- redirect some function
require("noice").redirect(function()
print("test")
end)
<


Adding the following keymap, will redirect the active cmdline when pressing
`<S-Enter>`. The cmdline stays open, so you can change the command and execute
it again. When exiting the cmdline, the popup window will be focused.

>
vim.keymap.set("c", "<S-Enter>", function()
require("noice").redirect(vim.fn.getcmdline())
end, { desc = "Redirect Cmdline" })
<


LSP HOVER DOC SCROLLING ~

>
Expand Down

0 comments on commit b4ac173

Please sign in to comment.