Files
outline.nvim/README.md
2021-04-20 16:47:25 -07:00

39 lines
768 B
Markdown

# symbols-outline.nvim
<b> A tree like view for symbols in Neovim using the Language Server Protocol. Supports all your favourite languages.</b>
![demo](https://github.com/simrat39/rust-tools-demos/raw/master/symbols-demo.gif)
# Prerequisites
- `neovim 0.5+` (nightly)
# Installation
using `vim-plug`
```vim
Plug 'simrat39/symbols-outline.nvim'
```
# Setup
```lua
local opts = {
-- whether to highlight the currently hovered symbol
-- disable if your cpu usage is higher than you want it
-- or you just hate the highlight
-- default: true
highlight_hovered_item = true,
}
require('symbols-outline').setup(opts)
```
## Commands
```vim
SymbolsOutline
```
## Keymaps
```vim
Escape --> Close Outline
Enter --> GoTo Symbol location in code
```