Skip to content

ralphmodales/highlight.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

highlight.nvim

A Neovim plugin inspired by Kindle, allowing you to highlight words and attach notes with numbered markers.

Features

  • Highlight words with a Kindle-like yellow background
  • Add notes to highlights (optional)
  • Numbered markers link to notes
  • View all highlights/notes in a "Notebook" style list
  • Clear all annotations

Installation

Using lazy.nvim:

{
  "ralphmodales/highlight.nvim",
  config = function()
    require("highlight").setup()
  end
}

Usage

  • :KindleHighlight or <leader>kh - Highlight word and add note
  • :KindleNote or <leader>kn - Show note at cursor
  • :KindleNotebook or <leader>kl - List all highlights/notes
  • :KindleClear or <leader>kc - Clear everything

Configuration

require('highlight').setup({
  highlight = { bg = '#ffcc00', fg = '#000000' },
  keymaps = {
    highlight = '<leader>kh',
    show_note = '<leader>kn',
    notebook = '<leader>kl',
    clear = '<leader>kc',
  }
})

Contributing

Pull request welcome!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages