Auto generate vim docs

This commit is contained in:
hedyhli
2023-11-01 10:39:42 +00:00
committed by github-actions[bot]
parent ab77b5ed11
commit 3008909d3c

View File

@@ -1,4 +1,4 @@
*symbols-outline.txt* For NVIM v0.8.0 Last change: 2023 November 01 *symbols-outline.txt* For NVIM v0.7.0 Last change: 2023 November 01
============================================================================== ==============================================================================
Table of Contents *symbols-outline-table-of-contents* Table of Contents *symbols-outline-table-of-contents*
@@ -223,13 +223,17 @@ Pass a table to the setup call above with your configuration options.
position = 'right', position = 'right',
relative_width = true, relative_width = true,
width = 25, width = 25,
-- Behaviour changed in this fork: -- Behaviour changed in this fork:
-- Auto close the outline window if goto_location is triggered and not for -- Auto close the outline window if goto_location is triggered and not for
-- focus_location -- focus_location
auto_close = false, auto_close = false,
-- Vim options for the outline window
show_numbers = false, show_numbers = false,
show_relative_numbers = false, show_relative_numbers = false,
show_cursorline = true, show_cursorline = true,
show_symbol_details = true, show_symbol_details = true,
-- Highlight group for the preview background -- Highlight group for the preview background
preview_bg_highlight = 'Pmenu', preview_bg_highlight = 'Pmenu',
@@ -237,11 +241,13 @@ Pass a table to the setup call above with your configuration options.
auto_unfold_hover = true, auto_unfold_hover = true,
fold_markers = { '', '' }, fold_markers = { '', '' },
wrap = false, wrap = false,
-- Only in this fork: -- Only in this fork:
-- Whether to focus on the outline window when it is opened. -- Whether to focus on the outline window when it is opened.
-- Set to false to remain focus on your previous buffer when opening -- Set to false to remain focus on your previous buffer when opening
-- symbols-outline. -- symbols-outline.
focus_on_open = true, focus_on_open = true,
keymaps = { -- These keymaps can be a string or a table for multiple keys keymaps = { -- These keymaps can be a string or a table for multiple keys
close = {"<Esc>", "q"}, close = {"<Esc>", "q"},
-- Jump to symbol under cursor -- Jump to symbol under cursor
@@ -262,8 +268,10 @@ Pass a table to the setup call above with your configuration options.
unfold_all = "E", unfold_all = "E",
fold_reset = "R", fold_reset = "R",
}, },
lsp_blacklist = {}, lsp_blacklist = {},
symbol_blacklist = {}, symbol_blacklist = {},
symbols = { symbols = {
-- Changed in this fork -- Changed in this fork
File = { icon = "󰈔", hl = "@text.uri" }, File = { icon = "󰈔", hl = "@text.uri" },
@@ -365,14 +373,34 @@ Pass a table to the setup call above with your configuration options.
COMMANDS *symbols-outline-symbols-outline.nvim-commands* COMMANDS *symbols-outline-symbols-outline.nvim-commands*
Command Description - **:SymbolsOutline[!]**
----------------------------- ---------------------------------
:SymbolsOutline Toggle symbols outline Toggle symbols outline. With bang (`!`) the cursor focus stays in your original
:SymbolsOutlineOpen Open symbols outline window after opening the outline window. Set `focus_on_win = true` to always
:SymbolsOutlineClose Close symbols outline use this behaviour.
:SymbolsOutlineFocus Toggle focus on symbols outline
:SymbolsOutlineFocusOutline Focus on symbols outline - **:SymbolsOutlineOpen[!]**
:SymbolsOutlineFocusCode Focus on source window
Open symbols outline. With bang (`!`) the cursor focus stays in your original
window after opening the outline window. Set `focus_on_win = true` to always
use this behaviour.
- **:SymbolsOutlineClose**
Close symbols outline
- **:SymbolsOutlineFocus**
Toggle focus on symbols outline
- **:SymbolsOutlineFocusOutline**
Focus on symbols outline
- **:SymbolsOutlineFocusCode**
Focus on source window
LUA API ~ LUA API ~
@@ -381,13 +409,38 @@ LUA API ~
< <
- setup(opts) - setup(opts)
- toggle_outline() - toggle_outline(opts)
- open_outline()
Toggle opening/closing of outline window.
If `opts.bang` is true, keep focus on previous window.
- open_outline(opts)
Open the outline window.
If `opts.bang` is true, keep focus on previous window.
- close_outline() - close_outline()
Close the outline window
- focus_toggle() - focus_toggle()
Toggle cursor focus between code and outline window
- focus_outline() - focus_outline()
Focus cursor on the outline window.
- focus_code() - focus_code()
Focus cursor on the window which the outline is derived from.
- is_open()
Return whether the outline window is open
DEFAULT KEYMAPS *symbols-outline-symbols-outline.nvim-default-keymaps* DEFAULT KEYMAPS *symbols-outline-symbols-outline.nvim-default-keymaps*
@@ -401,8 +454,8 @@ DEFAULT KEYMAPS *symbols-outline-symbols-outline.nvim-default-keymaps*
r Rename symbol r Rename symbol
a Code actions a Code actions
h fold symbol h fold symbol
tab toggle fold under cursor Tab toggle fold under cursor
shift+tab toggle all folds Shift+Tab toggle all folds
l Unfold symbol l Unfold symbol
W Fold all symbols W Fold all symbols
E Unfold all symbols E Unfold all symbols