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

docs: Add highlights

Browse Source 
Closes #52
This commit is contained in:
simrat39
2021-08-20 19:04:57 -07:00
parent 2f3e4ef7eb
commit 117cc91beb
3 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -81,7 +81,7 @@ vim.g.symbols_outline = {
| Property | Description | Type | Default |
| ---------------------- | ------------------------------------------------------------------------------ | ------------------ | ------------------------ |
| highlight_hovered_item | Whether to highlight the currently hovered symbol (high cpu usage) | boolean | true |
| show_guides | Whether to show outline guides | boolean | true |
| 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_preview | Show a preview of the code on hover | boolean | true |
@@ -114,3 +114,9 @@ vim.g.symbols_outline = {
| a | Code actions |
| ? | Show help message |
### Highlights
| Highlight | Purpose |
| ------------- | ------------------------------------------------------- |
| FocusedSymbol | Highlight of the focused symbol |
| Pmenu | Highlight of the preview popup windows |
| Comment | Highlight of the table connectors and info virtual text |

11
doc/symbols-outline.txt
View File

@@ -9,6 +9,7 @@ CONTENTS *symbols-outline-contents*
4. Configuration.........................|symbols-outline-configuration|
5. Commands...................................|symbols-outline-commands|
6. Default keymaps.....................|symbols-outline-default_keymaps|
7. Highlights...............................|symbols-outline-highlights|
================================================================================
@@ -223,7 +224,6 @@ symbol_blacklist
| `:SymbolsOutlineOpen` | Open symbols outline |
| `:SymbolsOutlineClose` | Close symbols outline |
================================================================================
6. DEFAULT KEYMAPS *symbols-outline-default_keymaps*
@@ -238,5 +238,14 @@ symbol_blacklist
| a | Code actions |
| ? | Show help message |
================================================================================
7. HIGHLIGHTS *symbols-outline-highlights*
| Highlight | Purpose |
| ------------- | ------------------------------------------------------- |
| FocusedSymbol | Highlight of the focused symbol |
| Pmenu | Highlight of the preview popup windows |
| Comment | Highlight of the table connectors and info virtual text |
================================================================================
vim:tw=79:ts=8:ft=help:norl

9
doc/tags Normal file
View File

@@ -0,0 +1,9 @@
symbols-outline-commands symbols-outline.txt /*symbols-outline-commands*
symbols-outline-configuration symbols-outline.txt /*symbols-outline-configuration*
symbols-outline-contents symbols-outline.txt /*symbols-outline-contents*
symbols-outline-default_keymaps symbols-outline.txt /*symbols-outline-default_keymaps*
symbols-outline-highlights symbols-outline.txt /*symbols-outline-highlights*
symbols-outline-installation symbols-outline.txt /*symbols-outline-installation*
symbols-outline-introduction symbols-outline.txt /*symbols-outline-introduction*
symbols-outline-prerequisites symbols-outline.txt /*symbols-outline-prerequisites*
symbols-outline.txt symbols-outline.txt /*symbols-outline.txt*