Auto generate vim docs

This commit is contained in:
hedyhli
2023-11-15 03:21:54 +00:00
committed by github-actions[bot]
parent f356c29578
commit f5365560be

View File

@@ -1,4 +1,4 @@
*outline.txt* For NVIM v0.7.0 Last change: 2023 November 13 *outline.txt* For NVIM v0.7.0 Last change: 2023 November 15
============================================================================== ==============================================================================
Table of Contents *outline-table-of-contents* Table of Contents *outline-table-of-contents*
@@ -337,8 +337,7 @@ The order in which the sources for icons are checked is:
2. Icon source (only `lspkind` is supported for this option as of now) 2. Icon source (only `lspkind` is supported for this option as of now)
3. Icons table 3. Icons table
A fallback is always used if the previous candidate returned either an empty A fallback is always used if the previous candidate returned a falsey value.
string or a falsey value.
COMMANDS *outline-commands* COMMANDS *outline-commands*
@@ -498,8 +497,23 @@ TIPS *outline-tips*
1. Icon fetcher function 1. Icon fetcher function
2. Icon source 2. Icon source
3. Icons table 3. Icons table
A fallback is always used if the previous candidate returned either an empty A fallback is always used if the previous candidate returned falsey value.
string or a falsey value. You can hide an icon for a specific type by returning `""`.
Below is an example where icons are disabled for kind 'Package', and for other
icons use lspkind.
>lua
symbols = {
icon_fetcher = function(k)
if k == 'Package' then
return ""
end
return false
end,
icon_source = 'lspkind',
}
<
- You can customize the split command used for creating the outline window split - You can customize the split command used for creating the outline window split
using `outline_window.split_command`, such as `"topleft vsp"`. See |windows| using `outline_window.split_command`, such as `"topleft vsp"`. See |windows|
- Is the outline window too slow when first opening a file? This is usually due - Is the outline window too slow when first opening a file? This is usually due
@@ -530,7 +544,6 @@ Unfold all others except currently hovered item
AUTO-JUMP ~ AUTO-JUMP ~
Use outline window as a quick-jump window Use outline window as a quick-jump window
@@ -591,7 +604,6 @@ it using `outline_window.winhl`: please see |outline-highlights|.
BLEND CURSOR WITH CURSORLINE ~ BLEND CURSOR WITH CURSORLINE ~
'Single' cursorline 'Single' cursorline
@@ -606,7 +618,6 @@ BLEND CURSOR WITH CURSORLINE ~
This will be how the outline window looks like when focused: This will be how the outline window looks like when focused:
Some may find this unhelpful, but one may argue that elements in each row of Some may find this unhelpful, but one may argue that elements in each row of
the outline becomes more readable this way, hence this is an option. the outline becomes more readable this way, hence this is an option.
@@ -630,6 +641,31 @@ and `icons` as fallback.
DISABLE ICONS ~
Disable all icons:
>lua
symbols = {
icon_fetcher = function(_) return "" end,
}
<
Disable icons for specific kinds, and for others use lspkind:
>lua
symbols = {
icon_fetcher = function(k)
if k == 'String' then
return ""
end
return false
end,
icon_source = 'lspkind',
}
<
RELATED PLUGINS *outline-related-plugins* RELATED PLUGINS *outline-related-plugins*