Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ https://user-images.githubusercontent.com/42740055/163586272-17560f83-9195-4cb4-

Install with your favorite plugin manager.

## Usage
## Default settings

```lua
require('nvim-cursorline').setup {
Expand All @@ -31,6 +31,39 @@ require('nvim-cursorline').setup {
}
```

## Options for block highlighting

```lua
require('nvim-cursorline').setup {
cursorline = {
enable = false,
},
cursorword = {
enable = true,
min_length = 1,
hl = {
underline = false,
fg = "#c0caf5",
bg = "#565f89",
sp = nil,
blend = 0,
bold = false,
standout = false,
underline = false,
undercurl = false,
underdouble = false,
underdotted = false,
underdashed = false,
strikethrough = false,
italic = false,
reverse = false,
nocombine = false,
},
}
}
```
Most of the cursorword options are shown above. See a complete list of properties that can be set for `val` in the Neovim documentation: https://neovim.io/doc/user/api.html#nvim_set_hl().

## Acknowledgments

Thanks goes to these people/projects for inspiration:
Expand Down