Skip to content

FredSkar/noteit.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“” noteit.nvim

noteit.nvim is a small Neovim plugin to add and keep track of virtual notes in a project. Do you always read a chunk of code and then forget 5 minutes later what it did? noteit can be used to add small notes pinned in the code to help you remember stuff. It just adds a small visuall mark on the line where the note was added so it doesn't get in the way of the code itself. This are just an early beta, so bugs are included.

πŸ”” Features

  • Add notes to your code with a simple command.
  • Notes are handled per "project"
  • Jump to notes
  • View all notes in a project

πŸ“¦ Installation

With lazy.nvim:

return {
  "FredSkar/noteit.nvim",
  config = function()
    require("noteit").setup({
      symbol = "πŸ”–",
      highlight = "Todo",
    })
  end,
}

πŸ”§ Configuration

  • symbol - The symbol to use for the note mark.
  • highlight - The highlight group to use for the note mark (from Neovim group names). Use Ignore to disable highlighting.
  • notes_file - The file to store the notes in. Defaults to a noteit folder under Neovim's data directory.

πŸ“œ Usage

  • :NoteAdd - Add a note to the current line.
  • :NoteRemove - Remove the note from the current line.
  • :NoteShow - Show the note for the current line.
  • :NoteList - List all notes in the current project.

About

A small Neovim plugin to add and keep track of virtual notes in a project.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages