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-04 05:48:01 +00:00
parent 4da91c81d7
commit 049e80b49b
2 changed files with 44 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -237,6 +237,28 @@ require("aerial").setup({
-- This can be a filetype map (see :help aerial-filetype-map)
backends = { "treesitter", "lsp", "markdown" },
layout = {
-- These control the width of the aerial window.
-- They can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
-- min_width and max_width can be a list of mixed types.
-- max_width = {40, 0.2} means "the lesser of 40 columns or 20% of total"
max_width = { 40, 0.2 },
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
default_direction = "prefer_right",
-- Enum: edge, group, window
-- 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
@ -248,12 +270,6 @@ require("aerial").setup({
-- Set to false to remove the default keybindings for the aerial buffer
default_bindings = true,
-- 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
default_direction = "prefer_right",
-- Disable aerial on files with this many lines
disable_max_lines = 10000,
@ -354,14 +370,6 @@ require("aerial").setup({
-- 'auto' will manage folds if your previous foldmethod was 'manual'
manage_folds = false,
-- These control the width of the aerial window.
-- They can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
-- min_width and max_width can be a list of mixed types.
-- max_width = {40, 0.2} means "the lesser of 40 columns or 20% of total"
max_width = { 40, 0.2 },
width = nil,
min_width = 10,
-- Set default symbol icons to use patched font icons (see https://www.nerdfonts.com/)
-- "auto" will set it to true if nvim-web-devicons or lspkind-nvim is installed.
nerd_font = "auto",
@ -378,10 +386,6 @@ require("aerial").setup({
-- This can be a function (see :help aerial-open-automatic)
open_automatic = false,
-- Set to true to only open aerial at the far right/left of the editor
-- Default behavior opens aerial relative to current window
placement_editor_edge = false,
-- Run this command after jumping to a symbol (false will disable)
post_jump_cmd = "normal! zz",

40
doc/aerial.txt
View file

@ -110,6 +110,28 @@ Configure aerial by calling the setup() function.
-- This can be a filetype map (see :help aerial-filetype-map)
backends = { "treesitter", "lsp", "markdown" },
layout = {
-- These control the width of the aerial window.
-- They can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
-- min_width and max_width can be a list of mixed types.
-- max_width = {40, 0.2} means "the lesser of 40 columns or 20% of total"
max_width = { 40, 0.2 },
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
default_direction = "prefer_right",
-- Enum: edge, group, window
-- 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
@ -121,12 +143,6 @@ Configure aerial by calling the setup() function.
-- Set to false to remove the default keybindings for the aerial buffer
default_bindings = true,
-- 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
default_direction = "prefer_right",
-- Disable aerial on files with this many lines
disable_max_lines = 10000,
@ -227,14 +243,6 @@ Configure aerial by calling the setup() function.
-- 'auto' will manage folds if your previous foldmethod was 'manual'
manage_folds = false,
-- These control the width of the aerial window.
-- They can be integers or a float between 0 and 1 (e.g. 0.4 for 40%)
-- min_width and max_width can be a list of mixed types.
-- max_width = {40, 0.2} means "the lesser of 40 columns or 20% of total"
max_width = { 40, 0.2 },
width = nil,
min_width = 10,
-- Set default symbol icons to use patched font icons (see https://www.nerdfonts.com/)
-- "auto" will set it to true if nvim-web-devicons or lspkind-nvim is installed.
nerd_font = "auto",
@ -251,10 +259,6 @@ Configure aerial by calling the setup() function.
-- This can be a function (see :help aerial-open-automatic)
open_automatic = false,
-- Set to true to only open aerial at the far right/left of the editor
-- Default behavior opens aerial relative to current window
placement_editor_edge = false,
-- Run this command after jumping to a symbol (false will disable)
post_jump_cmd = "normal! zz",