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

minor: added additional documentation for autoclose feature

Browse Source
This commit is contained in:
Andrew
2021-12-02 17:38:21 +11:00
parent f98bc4de86
commit 13540060f9
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -8,7 +8,7 @@ Supports all your favourite languages.**
### Prerequisites
- `neovim 0.5+`
- Properly configured Neovim LSP client
- Properly configured Neovim LSP client
### Installation
@@ -33,6 +33,7 @@ vim.g.symbols_outline = {
auto_preview = true,
position = 'right',
width = 25,
auto_close = false,
show_numbers = false,
show_relative_numbers = false,
show_symbol_details = true,
@@ -85,6 +86,7 @@ vim.g.symbols_outline = {
| show_guides | Whether to show outline guides | boolean | true |
| position | Where to open the split window | 'right' or 'left' | 'right' |
| width | How big the window is (relative to the current split) | int | 25 |
| auto_close | Whether to automatically close the window after selection | boolean | false |
| auto_preview | Show a preview of the code on hover | boolean | true |
| show_numbers | Shows numbers with the outline | boolean | false |
| show_relative_numbers | Shows relative numbers with the outline | boolean | false |
@@ -105,18 +107,19 @@ vim.g.symbols_outline = {
### Default keymaps
| Key | Action |
| ---------- | ------------------------------------------------------------------ |
| Escape | Close outline |
| Enter | Go to symbol location in code |
| o | Go to symbol location in code without losing focus |
| Ctrl+Space | Hover current symbol |
| K | Toggles the current symbol preview |
| r | Rename symbol |
| a | Code actions |
| ? | Show help message |
| Key | Action |
| ---------- | -------------------------------------------------- |
| Escape | Close outline |
| Enter | Go to symbol location in code |
| o | Go to symbol location in code without losing focus |
| Ctrl+Space | Hover current symbol |
| K | Toggles the current symbol preview |
| r | Rename symbol |
| a | Code actions |
| ? | Show help message |
### Highlights
| Highlight | Purpose |
| ----------------------- | -------------------------------------- |
| FocusedSymbol | Highlight of the focused symbol |