From 0d4d242ca5eaa39cda6f7e4994bbfb00dea113dc Mon Sep 17 00:00:00 2001 From: charburgx Date: Wed, 17 Aug 2022 17:04:58 -0500 Subject: [PATCH] docs(README): document folding --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 66e8e69..14cad04 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,9 @@ local opts = { show_relative_numbers = false, show_symbol_details = true, preview_bg_highlight = 'Pmenu', + autofold_depth = nil, + auto_unfold_hover = true, + fold_markers = { '', '' }, keymaps = { -- These keymaps can be a string or a table for multiple keys close = {"", "q"}, goto_location = "", @@ -51,6 +54,11 @@ local opts = { toggle_preview = "K", rename_symbol = "r", code_actions = "a", + fold = "h", + unfold = "l", + fold_all = "W", + unfold_all = "E", + fold_reset = "R", }, lsp_blacklist = {}, symbol_blacklist = {}, @@ -103,6 +111,9 @@ local opts = { | symbols | Icon and highlight config for symbol icons | table (dictionary) | scroll up | | lsp_blacklist | Which lsp clients to ignore | table (array) | {} | | symbol_blacklist | Which symbols to ignore ([possible values](./lua/symbols-outline/symbols.lua)) | table (array) | {} | +| autofold_depth | Depth past which nodes will be folded by default | int | nil | +| auto_unfold_hover | Automatically unfold hovered symbol | boolean | true | +| fold_markers | Markers to denote foldable symbol's status | table (array) | { '', '' } | ## Commands @@ -123,6 +134,11 @@ local opts = { | K | Toggles the current symbol preview | | r | Rename symbol | | a | Code actions | +| h | Unfold symbol | +| l | Fold symbol | +| W | Fold all symbols | +| E | Unfold all symbols | +| R | Reset all folding | | ? | Show help message | ## Highlights