leigh/outline.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Mention including widths in split_command

Browse Source 
And remove trailing spaces
This commit is contained in:
~hedy
2024-05-02 20:56:40 +08:00
parent 27a4c5c091
commit 1c8b164c4d
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -180,10 +180,12 @@ Pass a table to the setup call with your configuration options.
-- `position` will not be considered if `split_command` is non-nil. -- `position` will not be considered if `split_command` is non-nil.
-- This should be a valid vim command used for opening the split for the -- This should be a valid vim command used for opening the split for the
-- outline window. Eg, 'rightbelow vsplit'. -- outline window. Eg, 'rightbelow vsplit'.
-- Width can be included (with will override the width setting below):
-- Eg, `topleft 20vsp` to prevent a flash of windows when resizing.
split_command = nil, split_command = nil,
-- Percentage or integer of columns -- Percentage or integer of columns
width = 25, width = 25,
-- Whether width is relative to the total width of nvim -- Whether width is relative to the total width of nvim
-- When relative_width = true, this means take 25% of the total -- When relative_width = true, this means take 25% of the total
-- screen width for outline window. -- screen width for outline window.
@@ -319,7 +321,7 @@ Pass a table to the setup call with your configuration options.
-- These keymaps can be a string or a table for multiple keys. -- These keymaps can be a string or a table for multiple keys.
-- Set to `{}` to disable. (Using 'nil' will fallback to default keys) -- Set to `{}` to disable. (Using 'nil' will fallback to default keys)
keymaps = { keymaps = {
show_help = '?', show_help = '?',
close = {'<Esc>', 'q'}, close = {'<Esc>', 'q'},
-- Jump to symbol under cursor. -- Jump to symbol under cursor.