nvim-plugins/aerial.nvim
1
0
Fork 0
mirror of https://github.com/stevearc/aerial.nvim synced 2024-09-16 14:34:08 +02:00
Code Issues Projects Releases Packages Wiki Activity

Small documentation cleanups

Browse source
This commit is contained in:
Steven Arcangeli 2021-06-16 08:48:32 -07:00
parent d8d689cff7
commit b0e850c9cc
3 changed files with 5 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -1,5 +1,5 @@
# aerial.nvim
Show a table-of-contents pane next to your code for quick navigation
A code outline window for skimming and quick navigation
![Demo image](https://user-images.githubusercontent.com/506791/94113785-46d26180-fdfc-11ea-84e5-0d8e5a9b3e8d.gif)

16
doc/aerial.txt
View file

@ -3,17 +3,9 @@
===============================================================================
CONTENTS *aerial-contents*
1. Intro...........................................|aerial-intro|
2. Configure.......................................|aerial-configure|
3. Commands........................................|aerial-commands|
4. Options.........................................|aerial-options|
===============================================================================
INTRO *aerial-intro*
Aerial is a table-of-contents pane next to your code for quick navigation.
It's powered by the documentSymbols information from LSP, and uses the
built-in Neovim |lsp| client.
1. Configure.......................................|aerial-configure|
2. Commands........................................|aerial-commands|
3. Options.........................................|aerial-options|
===============================================================================
CONFIGURE *aerial-configure*
@ -47,7 +39,7 @@ This is a minimal configuration to get you started:
The aerial pane itself has some sane default bindings, however you can easily
override them. The easiest way to is to use a ftplugin. For example, you can
create a file .vim/ftplugin/aerial.vim:
create a file `.vim/ftplugin/aerial.vim`:
>
" These are the default bindings.
nnoremap <buffer> <CR> <cmd>lua require'aerial'.jump_to_loc()<CR>zvzz

1
doc/tags
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-intro aerial.txt /*aerial-intro*
aerial-options aerial.txt /*aerial-options*
aerial.close() aerial.txt /*aerial.close()*
aerial.focus() aerial.txt /*aerial.focus()*