notes.nvim

October 8, 2024 ยท View on GitHub

Simple Note Taking Plugin

  • No overwhelmingly extra features.
  • Uses Markdown because that's more than enough. (And why would you want to learn something just to take notes)
  • Configure root directory and start being productive.

Installation

Using lazy.nvim

{

  "dhananjaylatkar/notes.nvim",
  dependencies = {
    "nvim-telescope/telescope.nvim", -- for picker="telescope"
    "echasnovski/mini.pick", -- for picker="mini-pick"
  },
  opts = {
    -- USE EMPTY FOR DEFAULT OPTIONS
    -- DEFAULTS ARE LISTED BELOW
  },
}

Configuration

You must run require("notes").setup() to initialize the plugin.

notes.nvim comes with following defaults:

{
  -- notes root dir
  root = os.getenv("HOME") .. "/code/notes/",
  -- picker
  picker = "telescope", -- "telescope" or "mini-pick"
}

Commands

CommandAction
:NotesFindFind notes in root dir
:NotesGrepGrep notes in root dir
:NotesNewCreate new note in root dir