Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nacro90/numb.nvim
Peek lines just when you intend
https://github.com/nacro90/numb.nvim
Last synced: 14 days ago
JSON representation
Peek lines just when you intend
- Host: GitHub
- URL: https://github.com/nacro90/numb.nvim
- Owner: nacro90
- License: mit
- Created: 2021-04-05T14:50:50.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T08:35:30.000Z (about 1 year ago)
- Last Synced: 2024-07-31T20:51:36.057Z (3 months ago)
- Language: Lua
- Size: 34.2 KB
- Stars: 600
- Watchers: 3
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - nacro90/numb.nvim - Peek lines in a non-obtrusive way. (Editing Support / Scrollbar)
README
# numb.nvim
numb.nvim is a Neovim plugin that peeks lines of the buffer in non-obtrusive
way.
## Features
Peeking the buffer while entering command `:{number}`
The colorscheme is [vim-substrata](https://github.com/arzg/vim-substrata)
## Installation
### Packer
```lua
use 'nacro90/numb.nvim'
```
### Paq
```lua
paq 'nacro90/numb.nvim'
```
### Plug
```viml
Plug 'nacro90/numb.nvim'
```
## Usage
Setup with default options:
```lua
require('numb').setup()
```
If you are using a init.vim instead of init.lua, you will need to load the plugin like this:
```Vimscript
:lua require('numb').setup()
```
Disable the plugin globally:
```lua
require('numb').disable()
```
After you disable the plugin, you can re-enable it by calling the `setup` again.
### Options
You can customize the behaviour with following:
```lua
require('numb').setup{
show_numbers = true, -- Enable 'number' for the window while peeking
show_cursorline = true, -- Enable 'cursorline' for the window while peeking
hide_relativenumbers = true, -- Enable turning off 'relativenumber' for the window while peeking
number_only = false, -- Peek only when the command is only a number instead of when it starts with a number
centered_peeking = true, -- Peeked line will be centered relative to window
}
```
After running `setup`, you are good to go. You can try with entering a number to
the vim command line like `:3`.
When you disable numb, your options are kept in the module level. So after you
disable it, if you call `setup()` with no overrides, numb will be enabled with
your customized options (or default ones if you don't have any). You can
override the options again with calling `setup{...}` as mentioned above.