https://github.com/yamatsum/nvim-cursorline

A plugin for neovim that highlights cursor words and lines
https://github.com/yamatsum/nvim-cursorline

lua neovim

Last synced: 4 months ago
JSON representation

A plugin for neovim that highlights cursor words and lines

• Host: GitHub
• URL: https://github.com/yamatsum/nvim-cursorline
• Owner: yamatsum
• License: mit
• Created: 2020-12-06T12:42:18.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-18T16:11:04.000Z (8 months ago)
• Last Synced: 2024-07-31T20:49:51.178Z (7 months ago)
• Topics: lua, neovim
• Language: Lua
• Homepage:
• Size: 23.4 KB
• Stars: 400
• Watchers: 3
• Forks: 26
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - yamatsum/nvim-cursorline - A plugin that highlights cursor words and lines. (Bars and Lines / Cursorline)

README

        
# nvim-cursorline

Highlight words and lines on the cursor for Neovim

- Underlines the word under the cursor.

https://user-images.githubusercontent.com/42740055/163586251-15c7c709-86bd-4c17-a298-07681bada220.mp4

- Show / hide cursorline in connection with cursor moving.

https://user-images.githubusercontent.com/42740055/163586272-17560f83-9195-4cb4-8c1c-557cfaf775ea.mp4

## Installation

Install with your favorite plugin manager.

## Usage

```lua

require('nvim-cursorline').setup {

  cursorline = {

    enable = true,

    timeout = 1000,

    number = false,

  },

  cursorword = {

    enable = true,

    min_length = 3,

    hl = { underline = true },

  }

}

```

## Acknowledgments

Thanks goes to these people/projects for inspiration:

- [delphinus/vim-auto-cursorline](https://github.com/delphinus/vim-auto-cursorline)

- [itchyny/vim-cursorword](https://github.com/itchyny/vim-cursorword)

## License

This software is released under the MIT License, see LICENSE.