hover-notes.nvim

Custom hover notes with categories support

https://github.com/user-attachments/assets/1dcc8dcc-ea98-4857-8f0b-9035460d3ce9

Description

The main goal of this plugin is to add the ability to attach notes to words and view them in a floating window

The same note is displayed for every occurrence of this word, not only in specific line/file/buffer

Features:

• Notes can be grouped by categories with the same formatting
• A default category is maintained for each workspace individually
• A category can be set for a workspace, a buffer, or an individual file
• Retrieves the closest matching word (up to a difference of half the word's length)
• Highlight with support for big files & big dictionaries
• Quiz mode to test your knowledge

Installation

Install the plugin with your favourite package manager:

{
  "lolpie244/hover-notes.nvim",
}

require('packer').startup(function()
    use {
      "lolpie244/hover-notes.nvim",
    }
end)

Configuration

require("hover-notes").setup({
	notesDir = vim.fn.stdpath("data") .. "/hover-notes", -- the root directory where all notes are stored
	defaultCategory = { -- the default note category
		name = "Default",
		format = "{text}",
	},
	ui = { -- style of the float window
		float = {
			style = "minimal",
			border = "rounded",
		},
	},
    highlight = {
		enable = true,
		-- if length of words in dictionary is longer than subsstr_match_size_limit - use exact word match instead of substring
		subsstr_match_size_limit = 1000,
		style = { underline = true, sp = vim.api.nvim_get_hl(0, { name = "String", link = false }).fg, bold = true, default = true },
	},

})

Commands

*All commands that target a word (HNShow, HNEdit...) will automatically prioritize:

1. Word provided as an argument: :HNShow lorem
2. A visual selection
3. The word under cursor

TODO

• Add Quiz mode
• Add confirmation on removal
• Visual highlight of the words with notes