nvim-plugins/aerial.nvim
1
0
Fork 0
mirror of https://github.com/stevearc/aerial.nvim synced 2024-09-16 14:34:08 +02:00
Code Issues Projects Releases Packages Wiki Activity

[docgen] Update README.md

Browse source 
skip-checks: true
This commit is contained in:
Github Actions 2022-08-27 17:28:10 +00:00
parent 8e1d57562d
commit 1676b4e535
2 changed files with 28 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -247,26 +247,29 @@ require("aerial").setup({
width = nil,
min_width = 10,
-- Enum: prefer_right, prefer_left, right, left, float
-- Determines the default direction to open the aerial window. The 'prefer'
-- options will open the window in the other direction *if* there is a
-- different buffer in the way of the preferred direction
-- Enum: prefer_right, prefer_left, right, left, float
default_direction = "prefer_right",
-- Enum: edge, group, window
-- Determines where the aerial window will be opened
-- edge - open aerial at the far right/left of the editor
-- group - open aerial to the right/left of the group of windows containing the current buffer
-- window - open aerial to the right/left of the current window
placement = "window",
},
-- Enum: persist, close, auto, global
-- persist - aerial window will stay open until closed
-- close - aerial window will close when original file is no longer visible
-- auto - aerial window will stay open as long as there is a visible
-- buffer to attach to
-- global - same as 'persist', and will always show symbols for the current buffer
close_behavior = "auto",
-- Determines how the aerial window decides which buffer to display symbols for
-- window - aerial window will display symbols for the buffer in the window from which it was opened
-- global - aerial window will display symbols for the current window
attach_mode = "window",
-- List of enum values that configure when to auto-close the aerial window
-- unfocus - close aerial when you leave the original source window
-- switch_buffer - close aerial when you change buffers in the source window
-- unsupported - close aerial when attaching to a buffer that has no symbol source
close_automatic_events = {},
-- Set to false to remove the default keybindings for the aerial buffer
default_bindings = true,
@ -291,7 +294,6 @@ require("aerial").setup({
"Struct",
},
-- Enum: split_width, full_width, last, none
-- Determines line highlighting mode when multiple splits are visible.
-- split_width Each open window will have its cursor location marked in the
-- aerial buffer. Each line will only be partially highlighted
@ -322,7 +324,7 @@ require("aerial").setup({
icons = {},
-- Control which windows and buffers aerial should ignore.
-- If close_behavior is "global", focusing an ignored window/buffer will
-- If attach_mode is "global", focusing an ignored window/buffer will
-- not cause the aerial window to update.
-- If open_automatic is true, focusing an ignored window/buffer will not
-- cause an aerial window to open.
@ -416,7 +418,7 @@ require("aerial").setup({
-- Controls border appearance. Passed to nvim_open_win
border = "rounded",
-- Enum: cursor, editor, win
-- Determines location of floating window
-- cursor - Opens float on top of the cursor
-- editor - Opens float centered in the editor
-- win - Opens float centered in the window

26
doc/aerial.txt
View file

@ -119,26 +119,29 @@ Configure aerial by calling the setup() function.
width = nil,
min_width = 10,
-- Enum: prefer_right, prefer_left, right, left, float
-- Determines the default direction to open the aerial window. The 'prefer'
-- options will open the window in the other direction *if* there is a
-- different buffer in the way of the preferred direction
-- Enum: prefer_right, prefer_left, right, left, float
default_direction = "prefer_right",
-- Enum: edge, group, window
-- Determines where the aerial window will be opened
-- edge - open aerial at the far right/left of the editor
-- group - open aerial to the right/left of the group of windows containing the current buffer
-- window - open aerial to the right/left of the current window
placement = "window",
},
-- Enum: persist, close, auto, global
-- persist - aerial window will stay open until closed
-- close - aerial window will close when original file is no longer visible
-- auto - aerial window will stay open as long as there is a visible
-- buffer to attach to
-- global - same as 'persist', and will always show symbols for the current buffer
close_behavior = "auto",
-- Determines how the aerial window decides which buffer to display symbols for
-- window - aerial window will display symbols for the buffer in the window from which it was opened
-- global - aerial window will display symbols for the current window
attach_mode = "window",
-- List of enum values that configure when to auto-close the aerial window
-- unfocus - close aerial when you leave the original source window
-- switch_buffer - close aerial when you change buffers in the source window
-- unsupported - close aerial when attaching to a buffer that has no symbol source
close_automatic_events = {},
-- Set to false to remove the default keybindings for the aerial buffer
default_bindings = true,
@ -163,7 +166,6 @@ Configure aerial by calling the setup() function.
"Struct",
},
-- Enum: split_width, full_width, last, none
-- Determines line highlighting mode when multiple splits are visible.
-- split_width Each open window will have its cursor location marked in the
-- aerial buffer. Each line will only be partially highlighted
@ -194,7 +196,7 @@ Configure aerial by calling the setup() function.
icons = {},
-- Control which windows and buffers aerial should ignore.
-- If close_behavior is "global", focusing an ignored window/buffer will
-- If attach_mode is "global", focusing an ignored window/buffer will
-- not cause the aerial window to update.
-- If open_automatic is true, focusing an ignored window/buffer will not
-- cause an aerial window to open.
@ -288,7 +290,7 @@ Configure aerial by calling the setup() function.
-- Controls border appearance. Passed to nvim_open_win
border = "rounded",
-- Enum: cursor, editor, win
-- Determines location of floating window
-- cursor - Opens float on top of the cursor
-- editor - Opens float centered in the editor
-- win - Opens float centered in the window