mirror of
https://github.com/zoriya/virtcolumn.nvim.git
synced 2026-08-16 02:44:44 +00:00
update repo info and readme
This commit is contained in:
@@ -1,47 +1,32 @@
|
||||
# virt-column.nvim
|
||||
# virtcolumn.nvim
|
||||
|
||||
Display a character as the colorcolumn.
|
||||
**Display a character as the colorcolumn.**
|
||||
|
||||
<img width="900" src="https://user-images.githubusercontent.com/12900252/143544703-d94d6e9e-75f8-407d-976e-0fd5b341d751.png" alt="Screenshot" />
|
||||

|
||||
|
||||
This plugin is based on [lukas-reineke/virt-column.nvim](https://github.com/lukas-reineke/virt-column.nvim),
|
||||
then why not submit pr, but a new repository, because the content of the modification of this plugin
|
||||
and the original use of the way completely incompatible, and can even be considered two completely different plugins
|
||||
|
||||
## Install
|
||||
|
||||
Use your favourite plugin manager to install.
|
||||
Same as other normal plugins, use your favourite plugin manager to install.
|
||||
|
||||
#### Example with Packer
|
||||
## Configuration
|
||||
|
||||
[wbthomason/packer.nvim](https://github.com/wbthomason/packer.nvim)
|
||||
This plugin is aiming for zero configuration, you just need to install and make
|
||||
sure this plugin loaded and it will automatically handle `colorcolumn`
|
||||
|
||||
### char
|
||||
|
||||
```lua
|
||||
-- init.lua
|
||||
require("packer").startup(
|
||||
function()
|
||||
use "lukas-reineke/virt-column.nvim"
|
||||
end
|
||||
)
|
||||
vim.g.virtcolumn_char = '▕' -- by default
|
||||
```
|
||||
|
||||
#### Example with Plug
|
||||
### highlight
|
||||
|
||||
[junegunn/vim-plug](https://github.com/junegunn/vim-plug)
|
||||
**`VirtColumn`**
|
||||
|
||||
```vim
|
||||
" init.vim
|
||||
call plug#begin('~/.vim/plugged')
|
||||
Plug 'lukas-reineke/virt-column.nvim'
|
||||
call plug#end()
|
||||
```
|
||||
Highlight of virtual column character.
|
||||
|
||||
## Setup
|
||||
|
||||
To configure virt-column.nvim you need to run the setup function.
|
||||
|
||||
```lua
|
||||
require("virt-column").setup()
|
||||
```
|
||||
|
||||
Please see `:help virt-column.txt`for more details and all possible values.
|
||||
|
||||
## Thanks
|
||||
|
||||
Thank you @francium for the idea.
|
||||
Use `ColorColumn`s background color by default, otherwise link to `NonText`
|
||||
|
||||
Reference in New Issue
Block a user