Put keybinding and highlight documentation into README

This commit is contained in:
Steven Arcangeli 2021-06-16 20:33:06 -07:00
parent e3985817fe
commit b083436b6d
3 changed files with 30 additions and 25 deletions

View file

@ -58,5 +58,35 @@ require'lspconfig'.vimls.setup{
A full list of commands and options can be found [in the
docs](https://github.com/stevearc/aerial.nvim/blob/master/doc/aerial.txt)
## Default Keybindings
The default keybindings in the aerial window are [in the
ftplugin](https://github.com/stevearc/aerial.nvim/blob/master/ftplugin/aerial.vim)
Key | Command
--- | -------
`<CR>` | Jump to the symbol under the cursor
`<C-v>` | Jump to the symbol in a vertical split
`<C-s>` | Jump to the symbol in a horizontal split
`<p>` | Scroll to the symbol (stay in aerial buffer)
`<C-j>` | Go down one line and scroll to that symbol
`<C-k>` | Go up one line and scroll to that symbol
`[[` | Jump to the previous symbol
`]]` | Jump to the next symbol
`q` | Close the aerial window
`o` | Toggle the tree
`O` | Toggle the tree recursively
## Highlight
There are highlight groups created for each `SymbolKind`. There will be one for
the name of the symbol (`Aerial<SymbolKind>`, and one for the icon
(`Aerial<SymbolKind>Icon`). For example:
`AerialClass` \
`AerialClassIcon` \
`AerialFunction` \
`AerialFunctionIcon`
The [LSP spec](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol) has the authoritative list of valid `SymbolKind`s.
Additionally, there is an `AerialLine` group that is used to indicate cursor position.

View file

@ -6,7 +6,6 @@ CONTENTS *aerial-contents
1. Configure.......................................|aerial-configure|
2. Commands........................................|aerial-commands|
3. Options.........................................|aerial-options|
4. Highlight.......................................|aerial-highlight|
===============================================================================
CONFIGURE *aerial-configure*
@ -204,28 +203,5 @@ aerial.set_filter_kind({kinds}) *aerial.set_filter_kind()
'Enum',
}
===============================================================================
HIGHLIGHT *aerial-highlight*
Aerial creates highlight groups for the names and icons that are displayed in
the aerial buffer. You can override the default colors by using
|:highlight-link| or |:highlight|. Highlight groups are created per SymbolKind
(See https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol
for a complete list of the possible SymbolKind values) in the following format:
Aerial{SymbolKind}
Aerial{SymbolKind}Icon
For example
AerialClass
AerialClassIcon
AerialFunction
AerialFunctionIcon
...
In addition, there is an `AerialLine` group that is used to indicate the
cursor position.
===============================================================================
vim:ft=help:et:ts=2:sw=2:sts=2:norl

View file

@ -3,7 +3,6 @@ aerial aerial.txt /*aerial*
aerial-commands aerial.txt /*aerial-commands*
aerial-configure aerial.txt /*aerial-configure*
aerial-contents aerial.txt /*aerial-contents*
aerial-highlight aerial.txt /*aerial-highlight*
aerial-options aerial.txt /*aerial-options*
aerial.close() aerial.txt /*aerial.close()*
aerial.focus() aerial.txt /*aerial.focus()*