Auto generate vim docs
This commit is contained in:
hedyhli
committed by
github-actions[bot]
github-actions[bot]
parent
505e99e870
commit
a7324dd3c9
@@ -217,29 +217,37 @@ Pass a table to the setup call above with your configuration options.
|
||||
|
||||
>lua
|
||||
local opts = {
|
||||
-- Whether to highlight the currently hovered symbol (high cpu usage)
|
||||
highlight_hovered_item = true,
|
||||
-- Whether to show outline guides
|
||||
show_guides = true,
|
||||
-- Automatically open preview of code on hover
|
||||
auto_preview = false,
|
||||
-- Where to open the split window: right/left
|
||||
position = 'right',
|
||||
-- Whether width is relative to existing windows
|
||||
relative_width = true,
|
||||
-- Percentage or integer of columns
|
||||
width = 25,
|
||||
|
||||
-- Behaviour changed in this fork:
|
||||
-- Auto close the outline window if goto_location is triggered and not for
|
||||
-- focus_location
|
||||
auto_close = false,
|
||||
|
||||
-- Vim options for the outline window
|
||||
show_numbers = false,
|
||||
show_relative_numbers = false,
|
||||
show_cursorline = true,
|
||||
|
||||
-- Show extra details with the symbols (lsp dependent)
|
||||
show_symbol_details = true,
|
||||
-- Highlight group for the preview background
|
||||
preview_bg_highlight = 'Pmenu',
|
||||
-- Depth past which nodes will be folded by default
|
||||
autofold_depth = nil,
|
||||
-- Automatically unfold hovered symbol
|
||||
auto_unfold_hover = true,
|
||||
fold_markers = { '', '' },
|
||||
-- Whether to wrap long lines, or let them flow off the window
|
||||
wrap = false,
|
||||
|
||||
-- Only in this fork:
|
||||
@@ -247,8 +255,12 @@ Pass a table to the setup call above with your configuration options.
|
||||
-- Set to false to remain focus on your previous buffer when opening
|
||||
-- symbols-outline.
|
||||
focus_on_open = true,
|
||||
-- Pseudo-transparency of the preview window
|
||||
winblend = 0
|
||||
|
||||
keymaps = { -- These keymaps can be a string or a table for multiple keys
|
||||
-- These keymaps can be a string or a table for multiple keys
|
||||
keymaps = {
|
||||
show_help = '?',
|
||||
close = {"<Esc>", "q"},
|
||||
-- Jump to symbol under cursor
|
||||
goto_location = "<Cr>",
|
||||
@@ -259,17 +271,23 @@ Pass a table to the setup call above with your configuration options.
|
||||
toggle_preview = "K",
|
||||
rename_symbol = "r",
|
||||
code_actions = "a",
|
||||
-- These fold actions are collapsing tree items, not code folding
|
||||
-- These fold actions are collapsing tree nodes, not code folding
|
||||
fold = "h",
|
||||
fold_toggle = '<tab>', -- Only in this fork
|
||||
fold_toggle_all = '<S-tab>', -- Only in this fork
|
||||
fold_toggle = '<Tab>', -- Only in this fork
|
||||
-- Toggle folds for all nodes.
|
||||
-- If at least one node is folded, this action will fold all nodes.
|
||||
-- If all nodes are folded, this action will unfold all nodes.
|
||||
fold_toggle_all = '<S-Tab>', -- Only in this fork
|
||||
unfold = "l",
|
||||
fold_all = "W",
|
||||
unfold_all = "E",
|
||||
fold_reset = "R",
|
||||
},
|
||||
|
||||
-- Lsp clients to ignore
|
||||
lsp_blacklist = {},
|
||||
-- Symbols to ignore.
|
||||
-- Possible values: lua/symbols-outline/symbols.lua
|
||||
symbol_blacklist = {},
|
||||
|
||||
symbols = {
|
||||
@@ -311,94 +329,24 @@ Pass a table to the setup call above with your configuration options.
|
||||
}
|
||||
<
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
Property Description Type Default
|
||||
------------------------ --------------------------------------- -------------- ------------
|
||||
highlight_hovered_item Whether to highlight the currently boolean true
|
||||
hovered symbol (high cpu usage)
|
||||
|
||||
show_guides Whether to show outline guides boolean true
|
||||
|
||||
position Where to open the split window ‘right’ or ‘right’
|
||||
‘left’
|
||||
|
||||
relative_width Whether width of window is set relative boolean true
|
||||
to existing windows
|
||||
|
||||
width Width of window (as a % or columns int 25
|
||||
based on relative_width)
|
||||
|
||||
auto_close Whether to automatically close the boolean false
|
||||
window after goto_location
|
||||
|
||||
auto_preview Show a preview of the code on hover boolean false
|
||||
|
||||
show_numbers Shows numbers with the outline boolean false
|
||||
|
||||
show_relative_numbers Shows relative numbers with the outline boolean false
|
||||
|
||||
show_symbol_details Shows extra details with the symbols boolean true
|
||||
(lsp dependent)
|
||||
|
||||
preview_bg_highlight Background color of the preview window string Pmenu
|
||||
|
||||
winblend Pseudo-transparency of the preview int 0
|
||||
window
|
||||
|
||||
keymaps Which keys do what table here
|
||||
(dictionary)
|
||||
|
||||
symbols Icon and highlight config for symbol table scroll up
|
||||
icons (dictionary)
|
||||
|
||||
lsp_blacklist Which lsp clients to ignore table (array) {}
|
||||
|
||||
symbol_blacklist Which symbols to ignore (possible table (array) {}
|
||||
values)
|
||||
|
||||
autofold_depth Depth past which nodes will be folded int nil
|
||||
by default
|
||||
|
||||
auto_unfold_hover Automatically unfold hovered symbol boolean true
|
||||
|
||||
fold_markers Markers to denote foldable symbol’s table (array) { ‘’, ‘’ }
|
||||
status
|
||||
|
||||
wrap Whether to wrap long lines, or let them boolean false
|
||||
flow off the window
|
||||
|
||||
focus_on_open Whether to focus cursor on the outline boolean true
|
||||
window when opening
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
COMMANDS *symbols-outline-symbols-outline.nvim-commands*
|
||||
|
||||
- **:SymbolsOutline[!]**
|
||||
|
||||
Toggle 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.
|
||||
|
||||
- **:SymbolsOutlineOpen[!]**
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -409,36 +357,21 @@ LUA API ~
|
||||
<
|
||||
|
||||
- setup(opts)
|
||||
- toggle_outline(opts)
|
||||
|
||||
- **toggle_outline(opts)**
|
||||
Toggle opening/closing of outline window.
|
||||
|
||||
If `opts.bang` is true, keep focus on previous window.
|
||||
|
||||
- open_outline(opts)
|
||||
|
||||
- **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()
|
||||
|
||||
- **is_open()**
|
||||
Return whether the outline window is open
|
||||
|
||||
|
||||
@@ -447,6 +380,7 @@ DEFAULT KEYMAPS *symbols-outline-symbols-outline.nvim-default-keymaps*
|
||||
Key Action
|
||||
------------ ----------------------------------------------------
|
||||
Escape Close outline
|
||||
? Show help message
|
||||
Enter Go to symbol location in code
|
||||
o Go to symbol location in code without losing focus
|
||||
Ctrl+Space Hover current symbol
|
||||
@@ -460,7 +394,6 @@ DEFAULT KEYMAPS *symbols-outline-symbols-outline.nvim-default-keymaps*
|
||||
W Fold all symbols
|
||||
E Unfold all symbols
|
||||
R Reset all folding
|
||||
? Show help message
|
||||
|
||||
HIGHLIGHTS *symbols-outline-symbols-outline.nvim-highlights*
|
||||
|
||||
|
||||
Reference in New Issue
Block a user