outline

KO | EN

gitlite — search

#javascript #python #react #go #golang #rust #docker #awesome #kubernetes #vue #security #ios #openai #open-source

(★ 12)

Nvim buffer & winbar plugin

outline Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Outline ( Another Nvim Buffer Management with Winbar )

Outline is a simple(not so simple) Nvim buffer management plugin written in Lua.
 ![](https://github.com/Djancyp/outline/blob/main/images/outline.gif)
# What you will get with this plugin.

- Uses Nvim winbar to show buffer name and file change indicator.
// image 
- Buffer management ui.
  - Buffer switch.
  - Buffer status.
  - Buffer close.
  - Buffer Preview.
  - Buffer bind shortcut key.

- ![Buffer main](https://raw.githubusercontent.com/Djancyp/outline/main/images/outline-main.png)
- ![Status line](https://raw.githubusercontent.com/Djancyp/outline/main/images/winbar.png)
- ![Previw](https://raw.githubusercontent.com/Djancyp/outline/main/images/preview.png)
- ![Key binding](https://raw.githubusercontent.com/Djancyp/outline/main/images/bind.png)

## requirements
- Neovim Nightly ≥ v0.8 - Winbar support
- A patched [nerd font](https://www.nerdfonts.com/) for the buffer icons
- [nvim-web-devicons](https://github.com/kyazdani42/nvim-web-devicons) for filetype icons (recommended)
## Install

```lua
use {"Djancyp/outline"}

require('outline').setup()
```

## Usage

```lua
// Toggle  Buffer tab
:BSOpen
// Recommended key binding shift+c
<S-c>
```
## Keys
```
| Key            | Action                          |
| -------------- | ------------------------------- |
| q,ESC,Ctrl-c   | exit outline window             |
| j or <Tab>     | navigate down                   |
| k or <S-Tab>   | navigate up                     |
| D              | close buffer                    |
| `<CR>`         | jump to buffer                  |
| s              | open buffer in horizontal split |
| v              | open buffer in vertical split   |
| <S-P>          | open preview for buffer         |
| <S-B>          | bind buffer to a key            |
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate. 
## License
[MIT](https://choosealicense.com/licenses/mit/)

outline

outline Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

outline

outline Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README