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

Update readme

Browse Source
This commit is contained in:
hedy
2023-11-03 10:18:46 +08:00
parent 860ea87d22
commit ceb9a4841d
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -121,7 +121,6 @@ Key:
(#235 by eyalz800) (#235 by eyalz800)
- ✅ auto_jump config param - ✅ auto_jump config param
(#229 by stickperson) (#229 by stickperson)
**Renamed to `auto_goto` for consistency** **Renamed to `auto_goto` for consistency**
@@ -338,7 +337,8 @@ local opts = {
-- Whether to highlight the currently hovered symbol (high cpu usage) -- Whether to highlight the currently hovered symbol (high cpu usage)
highlight_hovered_item = true, highlight_hovered_item = true,
-- Options for outline guides -- Options for outline guides.
-- Only in this fork
guides = { guides = {
enabled = true, enabled = true,
markers = { markers = {
@@ -353,6 +353,7 @@ local opts = {
-- Automatically open hover_symbol when opening toggle_preview (see keymaps). -- Automatically open hover_symbol when opening toggle_preview (see keymaps).
-- If you disable this you can still open hover_symbol using your keymap -- If you disable this you can still open hover_symbol using your keymap
-- below. -- below.
-- Only in this fork
open_hover_on_preview = true, open_hover_on_preview = true,
-- Border option for floating preview window. -- Border option for floating preview window.
-- Options include: single/double/rounded/solid/shadow or an array of border -- Options include: single/double/rounded/solid/shadow or an array of border
@@ -363,13 +364,14 @@ local opts = {
-- Auto close the outline window if goto_location is triggered and not for -- Auto close the outline window if goto_location is triggered and not for
-- peek_location -- peek_location
auto_close = false, auto_close = false,
-- Automatically go to location in code when navigating outline window -- Automatically go to location in code when navigating outline window.
-- Only in this fork
auto_goto = false, auto_goto = false,
-- Vim options for the outline window -- Vim options for the outline window
show_numbers = false, show_numbers = false,
show_relative_numbers = false, show_relative_numbers = false,
show_cursorline = true, show_cursorline = true, -- Only in this fork
-- Show extra details with the symbols (lsp dependent) -- Show extra details with the symbols (lsp dependent)
show_symbol_details = true, show_symbol_details = true,
-- Highlight group for the preview background -- Highlight group for the preview background