diff --git a/doc/outline.txt b/doc/outline.txt index 2dd6890..5b0eb04 100644 --- a/doc/outline.txt +++ b/doc/outline.txt @@ -223,8 +223,14 @@ Show defaults ~ symbol_folding = { -- Depth past which nodes will be folded by default autofold_depth = nil, - -- Automatically unfold currently hovered symbol - auto_unfold_hover = true, + -- When to auto unfold nodes + auto_unfold_nodes = { + -- Auto unfold currently hovered symbol + hovered = true, + -- Auto fold when the root level only has this many nodes. + -- Set true for 1 node, false for 0. + only = true, + }, markers = { '', '' }, }, @@ -653,15 +659,43 @@ unless specified otherwise. UNFOLD OTHERS ~ -Unfold all others except currently hovered item +Unfold all others except currently hovered item. >lua symbol_folding = { autofold_depth = 1, - auto_unfold_hover = true, + auto_unfold_nodes = { + hovered = true, + }, + }, +< + + + +AUTO-UNFOLD WHEN THERE’S ONLY TWO (OR ANY NUMBER OF) ROOT NODES ~ + +>lua + symbol_folding = { + auto_unfold_nodes = { + only = 2, + }, }, < +`auto_unfold_nodes.only = 2`: + + +https://github.com/hedyhli/outline.nvim/assets/50042066/035fadac-ecee-4427-9ee1-795dac215cea + +`auto_unfold_nodes.only = 1`: + + +https://github.com/hedyhli/outline.nvim/assets/50042066/3a123b7e-ccf6-4278-9a8c-41d2e1865d83 + +In words "auto unfold nodes when there is only 2 nodes shown in the outline." + +For `auto_unfold_nodes.only = true`: "auto unfold nodes when the root node is +the only node left visible in the outline." AUTO-JUMP ~ @@ -686,8 +720,6 @@ location directly and not use the preview window: }, < -This feature was added by @stickperson in an upstream PR 🙌 - https://github.com/hedyhli/outline.nvim/assets/50042066/3d06e342-97ac-400c-8598-97a9235de66c @@ -726,7 +758,12 @@ it using `outline_window.winhl`: please see |outline-highlights|. BLEND CURSOR WITH CURSORLINE ~ -'Single' cursorline +Hide the cursor within cursorline. This setting changes the cursor color to be +that of `Cursorline` when focus is in outline window. As of now `guicursor` is +a global option, so outline.nvim has to set and reset responsibly hence this +feature may be unstable. You can inspect +`require('outline').state.original_cursor` and set `guicursor` accordingly, +though you should almost never need to do this. >lua outline_window = { @@ -741,9 +778,6 @@ 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 the outline becomes more readable this way, hence this is an option. -This feature is newly added in this fork, and is currently experimental (may be -unstable). - CUSTOM ICONS ~ @@ -819,11 +853,6 @@ RELATED PLUGINS *outline-related-plugins* - lspsaga - navigator.lua -============================================================================== -1. Links *outline-links* - -1. *@stickperson*: - Generated by panvimdoc vim:tw=78:ts=8:noet:ft=help:norl: