Auto generate vim docs

This commit is contained in:
hedyhli
2023-11-01 06:40:16 +00:00
committed by github-actions[bot]
parent d2f0a4af6a
commit 15e49f5c6c

View File

@@ -160,7 +160,25 @@ Lazy:
{ desc = "SymbolsOutline" })
require("symbols-outline").setup {
-- Your setup opts here (optional)
-- Your setup opts here (leave empty to use defaults)
}
end,
},
<
Lazy with lazy-loading:
>lua
{
"simrat39/symbols-outline.nvim",
cmd = { "SymbolsOutline", "SymbolsOutlineOpen", "SymbolsOutlineClose" },
keys = { "<leader>tt" },
config = function()
-- Example mapping to toggle symbols-outline
vim.keymap.set("n", "<leader>tt", "<cmd>SymbolsOutline<CR>",
{ desc = "SymbolsOutline" })
require("symbols-outline").setup {
-- Your setup opts here (leave empty to use defaults)
}
end,
},
@@ -169,13 +187,13 @@ Lazy:
SETUP *symbols-outline-symbols-outline.nvim-setup*
Put the setup call in your init.lua or any lua file that is sourced.
Call the setup function with your configuration options.
**NOTE**: A call to `.setup()` is _required_ for this plugin to work!
(simrat39/symbols-outline.nvim#213)
Note that a call to `.setup()` is _required_ for this plugin to work
(simrat39/symbols-outline.nvim#213).
>lua
require("symbols-outline").setup()
require("symbols-outline").setup({})
<
@@ -327,7 +345,7 @@ COMMANDS *symbols-outline-symbols-outline.nvim-commands*
LUA ~
>
>lua
require'symbols-outline'.toggle_outline()
require'symbols-outline'.open_outline()
require'symbols-outline'.close_outline()