mirror of
https://github.com/stevearc/aerial.nvim
synced 2024-09-16 14:34:08 +02:00
doc: add lualine to readme
This commit is contained in:
parent
accb731242
commit
24825561e2
1 changed files with 37 additions and 1 deletions
38
README.md
38
README.md
|
@ -11,6 +11,10 @@ A code outline window for skimming and quick navigation
|
|||
* [Commands](#commands)
|
||||
* [Options](#options)
|
||||
* [Default keybindings](#default-keybindings)
|
||||
* [Third-party integrations](#third-party-integrations)
|
||||
* [Telescope](#telescope)
|
||||
* [Fzf](#fzf)
|
||||
* [Lualine](#lualine)
|
||||
* [Highlight](#highlight)
|
||||
* [FAQ](#faq)
|
||||
|
||||
|
@ -394,7 +398,7 @@ Key | Command
|
|||
`zM` | Collapse all nodes in the tree
|
||||
`zx`/`zX` | Sync code folding to the tree (useful if they get out of sync)
|
||||
|
||||
## Fuzzy Finding
|
||||
## Third-party integrations
|
||||
|
||||
### Telescope
|
||||
|
||||
|
@ -421,6 +425,38 @@ fuzzy finding with `:call aerial#fzf()`. To create a mapping:
|
|||
nmap <silent> <leader>ds <cmd>call aerial#fzf()<cr>
|
||||
```
|
||||
|
||||
### Lualine
|
||||
|
||||
There is a lualine component to display the symbols for your current cursor
|
||||
position
|
||||
|
||||
```lua
|
||||
require("lualine").setup({
|
||||
sections = {
|
||||
lualine_x = { "aerial" },
|
||||
|
||||
-- Or you can customize it
|
||||
lualine_y = { "aerial",
|
||||
-- The separator to be used to separate symbols in status line.
|
||||
sep = ' ) ',
|
||||
|
||||
-- The number of symbols to render top-down. In order to render only 'N' last
|
||||
-- symbols, negative numbers may be supplied. For instance, 'depth = -1' can
|
||||
-- be used in order to render only current symbol.
|
||||
depth = nil,
|
||||
|
||||
-- When 'dense' mode is on, icons are not rendered near their symbols. Only
|
||||
-- a single icon that represents the kind of current symbol is rendered at
|
||||
-- the beginning of status line.
|
||||
dense = false,
|
||||
|
||||
-- The separator to be used to separate symbols in dense mode.
|
||||
dense_sep = '.',
|
||||
},
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
## Highlight
|
||||
|
||||
There are highlight groups created for each `SymbolKind`. There will be one for
|
||||
|
|
Loading…
Reference in a new issue