Auto generate vim docs
This commit is contained in:
hedyhli
committed by
github-actions[bot]
github-actions[bot]
parent
699bc85cc5
commit
20e63c01e0
101
doc/outline.txt
101
doc/outline.txt
@@ -1,4 +1,4 @@
|
||||
*outline.txt* For NVIM v0.7.0 Last change: 2023 November 19
|
||||
*outline.txt* For NVIM v0.7.0 Last change: 2023 November 21
|
||||
|
||||
==============================================================================
|
||||
Table of Contents *outline-table-of-contents*
|
||||
@@ -173,10 +173,8 @@ Show defaults ~
|
||||
focus_on_open = true,
|
||||
-- Winhighlight option for outline window.
|
||||
-- See :help 'winhl'
|
||||
-- To change background color to "CustomHl" for example, append "Normal:CustomHl".
|
||||
-- Note that if you're adding highlight changes, you should append to this
|
||||
-- default value, otherwise details/lineno will not have highlights.
|
||||
winhl = "OutlineDetails:Comment,OutlineLineno:LineNr",
|
||||
-- To change background color to "CustomHl" for example, use "Normal:CustomHl".
|
||||
winhl = '',
|
||||
},
|
||||
|
||||
outline_items = {
|
||||
@@ -255,7 +253,7 @@ Show defaults ~
|
||||
-- See :help nvim_open_win() and search for "border" option.
|
||||
border = 'single',
|
||||
-- winhl options for the preview window, see ':h winhl'
|
||||
winhl = '',
|
||||
winhl = 'NormalFloat:',
|
||||
-- Pseudo-transparency of the preview window, see ':h winblend'
|
||||
winblend = 0
|
||||
},
|
||||
@@ -334,38 +332,38 @@ 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' },
|
||||
TypeAlias = { icon = ' ', hl = '@type' },
|
||||
Parameter = { icon = ' ', hl = '@parameter' },
|
||||
StaticMethod = { icon = ' ', hl = '@function' },
|
||||
Macro = { icon = ' ', hl = '@macro' },
|
||||
File = { icon = '', hl = 'Identifier' },
|
||||
Module = { icon = '', hl = 'Include' },
|
||||
Namespace = { icon = '', hl = 'Include' },
|
||||
Package = { icon = '', hl = 'Include' },
|
||||
Class = { icon = '𝓒', hl = 'Type' },
|
||||
Method = { icon = 'ƒ', hl = 'Function' },
|
||||
Property = { icon = '', hl = 'Identifier' },
|
||||
Field = { icon = '', hl = 'Identifier' },
|
||||
Constructor = { icon = '', hl = 'Special' },
|
||||
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 = 'Identifier' },
|
||||
Struct = { icon = '𝓢', hl = 'Structure' },
|
||||
Event = { icon = '🗲', hl = 'Type' },
|
||||
Operator = { icon = '+', hl = 'Identifier' },
|
||||
TypeParameter = { icon = '𝙏', hl = 'Identifier' },
|
||||
Component = { icon = '', hl = 'Function' },
|
||||
Fragment = { icon = '', hl = 'Constant' },
|
||||
TypeAlias = { icon = ' ', hl = 'Type' },
|
||||
Parameter = { icon = ' ', hl = 'Identifier' },
|
||||
StaticMethod = { icon = ' ', hl = 'Function' },
|
||||
Macro = { icon = ' ', hl = 'Function' },
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -511,7 +509,7 @@ Default:
|
||||
|
||||
>lua
|
||||
outline_window = {
|
||||
winhl = "OutlineDetails:Comment,OutlineLineno:LineNr",
|
||||
winhl = '',
|
||||
},
|
||||
<
|
||||
|
||||
@@ -530,9 +528,20 @@ Possible highlight groups for the outline window:
|
||||
|
||||
OutlineLineno The Lineno column virtual text
|
||||
-----------------------------------------------------------------------
|
||||
You can customize any other highlight groups using `winhl` too, this option is
|
||||
You can customize any other highlight groups using `winhl`, this option is
|
||||
passed directly to the `winhl` vim option unprocessed.
|
||||
|
||||
If any of the above highlights have not already been set before outline.setup
|
||||
is called (say by a theme), the following links are used:
|
||||
|
||||
Highlight Link
|
||||
------------------- ---------
|
||||
OutlineGuides Comment
|
||||
OutlineFoldMarker Normal
|
||||
OutlineDetails Comment
|
||||
OutlineLineno LineNr
|
||||
For `OutlineCurrent`, foreground is set to String and background CursorLine.
|
||||
|
||||
To customize colors of the symbol icons, use the `symbols.icons` table. See
|
||||
|outline-config|.
|
||||
|
||||
@@ -541,20 +550,20 @@ PREVIEW WINDOW ~
|
||||
|
||||
>lua
|
||||
preview_window = {
|
||||
winhl = "",
|
||||
winhl = 'NormalFloat:',
|
||||
},
|
||||
<
|
||||
|
||||
|
||||
OTHER HIGHLIGHT GROUPS ~
|
||||
|
||||
---------------------------------------------------------------------------
|
||||
------------------------------------------------------------------------------
|
||||
Highlight Description
|
||||
---------------------- ----------------------------------------------------
|
||||
OutlineJumpHighlight Used for indicating cursor position when
|
||||
jumping/focusing
|
||||
---------------------- -------------------------------------------------------
|
||||
OutlineJumpHighlight Indicating cursor position when jumping/focusing,
|
||||
defaults to Visual
|
||||
|
||||
---------------------------------------------------------------------------
|
||||
------------------------------------------------------------------------------
|
||||
You can also use `outline_window.jump_highlight_duration` to customize in
|
||||
milliseconds, how long the highlight is applied for.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user