diff --git a/doc/outline.txt b/doc/outline.txt index e2d927f..8ad741d 100644 --- a/doc/outline.txt +++ b/doc/outline.txt @@ -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* @@ -139,6 +139,9 @@ Show defaults ~ -- boolean or integer for milliseconds duration to apply a temporary highlight -- when jumping. false to disable. 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 show_numbers = false, @@ -235,41 +238,41 @@ Show defaults ~ -- Set to `{}` to disable. (Using 'nil' will fallback to default keys) keymaps = { show_help = '?', - close = {"", "q"}, + close = {'', 'q'}, -- Jump to symbol under cursor. -- It can auto close the outline window when triggered, see -- 'auto_close' option above. - goto_location = "", + goto_location = '', -- 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 - goto_and_close = "", + goto_and_close = '', -- Change cursor position of outline window to match current location in code. - -- "Opposite" of goto/peek_location. - restore_location = "", + -- 'Opposite' of goto/peek_location. + restore_location = '', -- Open LSP/provider-dependent symbol hover information - hover_symbol = "", + hover_symbol = '', -- Preview location code of the symbol under cursor - toggle_preview = "K", + toggle_preview = 'K', -- Symbol actions - rename_symbol = "r", - code_actions = "a", + rename_symbol = 'r', + code_actions = 'a', -- These fold actions are collapsing tree nodes, not code folding - fold = "h", - unfold = "l", - fold_toggle = "", + fold = 'h', + unfold = 'l', + fold_toggle = '', -- 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 = "", - fold_all = "W", - unfold_all = "E", - fold_reset = "R", + fold_toggle_all = '', + fold_all = 'W', + unfold_all = 'E', + fold_reset = 'R', -- Move down/up by one line and peek_location immediately. -- You can also use outline_window.auto_jump=true to do this for any -- j/k//. - down_and_jump = "", - up_and_jump = "", + down_and_jump = '', + up_and_jump = '', }, providers = { @@ -306,34 +309,34 @@ Show defaults ~ -- the custom mapping of icons specified below. The icons table is also -- needed for specifying hl group. icons = { - File = { icon = "󰈔", hl = "@text.uri" }, - Module = { icon = "󰆧", hl = "@namespace" }, - Namespace = { icon = "ó°…Ș", hl = "@namespace" }, - Package = { icon = "󰏗", hl = "@namespace" }, - Class = { icon = "𝓒", hl = "@type" }, - Method = { icon = "ƒ", hl = "@method" }, - Property = { icon = "", hl = "@method" }, - Field = { icon = "󰆹", hl = "@field" }, - Constructor = { icon = "", hl = "@constructor" }, - Enum = { icon = "ℰ", hl = "@type" }, - Interface = { icon = "󰜰", hl = "@type" }, - Function = { icon = "", hl = "@function" }, - Variable = { icon = "", hl = "@constant" }, - Constant = { icon = "", hl = "@constant" }, - String = { icon = "𝓐", hl = "@string" }, - Number = { icon = "#", hl = "@number" }, - Boolean = { icon = "⊹", hl = "@boolean" }, - Array = { icon = "ó°…Ș", hl = "@constant" }, - Object = { icon = "⊿", hl = "@type" }, - Key = { icon = "🔐", hl = "@type" }, - Null = { icon = "NULL", hl = "@type" }, - EnumMember = { icon = "", hl = "@field" }, - Struct = { icon = "𝓱", hl = "@type" }, - Event = { icon = "đŸ—Č", hl = "@type" }, - Operator = { icon = "+", hl = "@operator" }, - TypeParameter = { icon = "𝙏", hl = "@parameter" }, - Component = { icon = "󰅮", hl = "@function" }, - Fragment = { icon = "󰅮", hl = "@constant" }, + File = { icon = '󰈔', hl = '@text.uri' }, + Module = { icon = '󰆧', hl = '@namespace' }, + Namespace = { icon = 'ó°…Ș', hl = '@namespace' }, + Package = { icon = '󰏗', hl = '@namespace' }, + Class = { icon = '𝓒', hl = '@type' }, + Method = { icon = 'ƒ', hl = '@method' }, + Property = { icon = '', hl = '@method' }, + Field = { icon = '󰆹', hl = '@field' }, + Constructor = { icon = '', hl = '@constructor' }, + Enum = { icon = 'ℰ', hl = '@type' }, + Interface = { icon = '󰜰', hl = '@type' }, + Function = { icon = '', hl = '@function' }, + Variable = { icon = '', hl = '@constant' }, + Constant = { icon = '', hl = '@constant' }, + String = { icon = '𝓐', hl = '@string' }, + Number = { icon = '#', hl = '@number' }, + Boolean = { icon = '⊹', hl = '@boolean' }, + Array = { icon = 'ó°…Ș', hl = '@constant' }, + Object = { icon = '⊿', hl = '@type' }, + Key = { icon = '🔐', hl = '@type' }, + Null = { icon = 'NULL', hl = '@type' }, + EnumMember = { icon = '', hl = '@field' }, + Struct = { icon = '𝓱', hl = '@type' }, + Event = { icon = 'đŸ—Č', hl = '@type' }, + Operator = { icon = '+', hl = '@operator' }, + TypeParameter = { icon = '𝙏', hl = '@parameter' }, + Component = { icon = '󰅮', hl = '@function' }, + Fragment = { icon = '󰅮', hl = '@constant' }, TypeAlias = { icon = ' ', hl = '@type' }, Parameter = { icon = 'îȘ’ ', hl = '@parameter' }, StaticMethod = { icon = 'îȘŒ ', hl = '@function' }, @@ -368,7 +371,7 @@ For other file types, include all but string >lua symbols.filter = { - ['*'] = { 'String', exclude=true }, + default = { 'String', exclude=true }, python = { 'Function', 'Class' }, } < @@ -748,6 +751,7 @@ Disable icons for specific kinds, and for others use lspkind: RELATED PLUGINS *outline-related-plugins* +- Aerial.nvim - nvim-navic - nvim-navbuddy - dropdown.nvim