Auto generate vim docs

This commit is contained in:
hedyhli
2023-11-18 04:17:13 +00:00
committed by github-actions[bot]
parent 58e92199f3
commit a3bc76d2b7

View File

@@ -1,4 +1,4 @@
*outline.txt* For NVIM v0.7.0 Last change: 2023 November 17 *outline.txt* For NVIM v0.7.0 Last change: 2023 November 18
============================================================================== ==============================================================================
Table of Contents *outline-table-of-contents* Table of Contents *outline-table-of-contents*
@@ -139,6 +139,9 @@ Show defaults ~
-- boolean or integer for milliseconds duration to apply a temporary highlight -- boolean or integer for milliseconds duration to apply a temporary highlight
-- when jumping. false to disable. -- when jumping. false to disable.
jump_highlight_duration = 300, jump_highlight_duration = 300,
-- Whether to center the cursor line vertically in the screen when
-- jumping/focusing. Runs zz.
center_on_jump = true,
-- Vim options for the outline window -- Vim options for the outline window
show_numbers = false, show_numbers = false,
@@ -235,41 +238,41 @@ Show defaults ~
-- Set to `{}` to disable. (Using 'nil' will fallback to default keys) -- Set to `{}` to disable. (Using 'nil' will fallback to default keys)
keymaps = { keymaps = {
show_help = '?', show_help = '?',
close = {"<Esc>", "q"}, close = {'<Esc>', 'q'},
-- Jump to symbol under cursor. -- Jump to symbol under cursor.
-- It can auto close the outline window when triggered, see -- It can auto close the outline window when triggered, see
-- 'auto_close' option above. -- 'auto_close' option above.
goto_location = "<Cr>", goto_location = '<Cr>',
-- Jump to symbol under cursor but keep focus on outline window. -- Jump to symbol under cursor but keep focus on outline window.
peek_location = "o", peek_location = 'o',
-- Visit location in code and close outline immediately -- Visit location in code and close outline immediately
goto_and_close = "<S-Cr>", goto_and_close = '<S-Cr>',
-- Change cursor position of outline window to match current location in code. -- Change cursor position of outline window to match current location in code.
-- "Opposite" of goto/peek_location. -- 'Opposite' of goto/peek_location.
restore_location = "<C-g>", restore_location = '<C-g>',
-- Open LSP/provider-dependent symbol hover information -- Open LSP/provider-dependent symbol hover information
hover_symbol = "<C-space>", hover_symbol = '<C-space>',
-- Preview location code of the symbol under cursor -- Preview location code of the symbol under cursor
toggle_preview = "K", toggle_preview = 'K',
-- Symbol actions -- Symbol actions
rename_symbol = "r", rename_symbol = 'r',
code_actions = "a", code_actions = 'a',
-- These fold actions are collapsing tree nodes, not code folding -- These fold actions are collapsing tree nodes, not code folding
fold = "h", fold = 'h',
unfold = "l", unfold = 'l',
fold_toggle = "<Tab>", fold_toggle = '<Tab>',
-- Toggle folds for all nodes. -- Toggle folds for all nodes.
-- If at least one node is folded, this action will fold 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. -- If all nodes are folded, this action will unfold all nodes.
fold_toggle_all = "<S-Tab>", fold_toggle_all = '<S-Tab>',
fold_all = "W", fold_all = 'W',
unfold_all = "E", unfold_all = 'E',
fold_reset = "R", fold_reset = 'R',
-- Move down/up by one line and peek_location immediately. -- Move down/up by one line and peek_location immediately.
-- You can also use outline_window.auto_jump=true to do this for any -- You can also use outline_window.auto_jump=true to do this for any
-- j/k/<down>/<up>. -- j/k/<down>/<up>.
down_and_jump = "<C-j>", down_and_jump = '<C-j>',
up_and_jump = "<C-k>", up_and_jump = '<C-k>',
}, },
providers = { providers = {
@@ -306,34 +309,34 @@ Show defaults ~
-- the custom mapping of icons specified below. The icons table is also -- the custom mapping of icons specified below. The icons table is also
-- needed for specifying hl group. -- needed for specifying hl group.
icons = { icons = {
File = { icon = "󰈔", hl = "@text.uri" }, File = { icon = '󰈔', hl = '@text.uri' },
Module = { icon = "󰆧", hl = "@namespace" }, Module = { icon = '󰆧', hl = '@namespace' },
Namespace = { icon = "󰅪", hl = "@namespace" }, Namespace = { icon = '󰅪', hl = '@namespace' },
Package = { icon = "󰏗", hl = "@namespace" }, Package = { icon = '󰏗', hl = '@namespace' },
Class = { icon = "𝓒", hl = "@type" }, Class = { icon = '𝓒', hl = '@type' },
Method = { icon = "ƒ", hl = "@method" }, Method = { icon = 'ƒ', hl = '@method' },
Property = { icon = "", hl = "@method" }, Property = { icon = '', hl = '@method' },
Field = { icon = "󰆨", hl = "@field" }, Field = { icon = '󰆨', hl = '@field' },
Constructor = { icon = "", hl = "@constructor" }, Constructor = { icon = '', hl = '@constructor' },
Enum = { icon = "", hl = "@type" }, Enum = { icon = '', hl = '@type' },
Interface = { icon = "󰜰", hl = "@type" }, Interface = { icon = '󰜰', hl = '@type' },
Function = { icon = "", hl = "@function" }, Function = { icon = '', hl = '@function' },
Variable = { icon = "", hl = "@constant" }, Variable = { icon = '', hl = '@constant' },
Constant = { icon = "", hl = "@constant" }, Constant = { icon = '', hl = '@constant' },
String = { icon = "𝓐", hl = "@string" }, String = { icon = '𝓐', hl = '@string' },
Number = { icon = "#", hl = "@number" }, Number = { icon = '#', hl = '@number' },
Boolean = { icon = "⊨", hl = "@boolean" }, Boolean = { icon = '⊨', hl = '@boolean' },
Array = { icon = "󰅪", hl = "@constant" }, Array = { icon = '󰅪', hl = '@constant' },
Object = { icon = "⦿", hl = "@type" }, Object = { icon = '⦿', hl = '@type' },
Key = { icon = "🔐", hl = "@type" }, Key = { icon = '🔐', hl = '@type' },
Null = { icon = "NULL", hl = "@type" }, Null = { icon = 'NULL', hl = '@type' },
EnumMember = { icon = "", hl = "@field" }, EnumMember = { icon = '', hl = '@field' },
Struct = { icon = "𝓢", hl = "@type" }, Struct = { icon = '𝓢', hl = '@type' },
Event = { icon = "🗲", hl = "@type" }, Event = { icon = '🗲', hl = '@type' },
Operator = { icon = "+", hl = "@operator" }, Operator = { icon = '+', hl = '@operator' },
TypeParameter = { icon = "𝙏", hl = "@parameter" }, TypeParameter = { icon = '𝙏', hl = '@parameter' },
Component = { icon = "󰅴", hl = "@function" }, Component = { icon = '󰅴', hl = '@function' },
Fragment = { icon = "󰅴", hl = "@constant" }, Fragment = { icon = '󰅴', hl = '@constant' },
TypeAlias = { icon = ' ', hl = '@type' }, TypeAlias = { icon = ' ', hl = '@type' },
Parameter = { icon = ' ', hl = '@parameter' }, Parameter = { icon = ' ', hl = '@parameter' },
StaticMethod = { icon = ' ', hl = '@function' }, StaticMethod = { icon = ' ', hl = '@function' },
@@ -368,7 +371,7 @@ For other file types, include all but string
>lua >lua
symbols.filter = { symbols.filter = {
['*'] = { 'String', exclude=true }, default = { 'String', exclude=true },
python = { 'Function', 'Class' }, python = { 'Function', 'Class' },
} }
< <
@@ -748,6 +751,7 @@ Disable icons for specific kinds, and for others use lspkind:
RELATED PLUGINS *outline-related-plugins* RELATED PLUGINS *outline-related-plugins*
- Aerial.nvim
- nvim-navic - nvim-navic
- nvim-navbuddy - nvim-navbuddy
- dropdown.nvim - dropdown.nvim