notes.nvim

A simple note-taking plugin for Neovim, inspired by denote. Notes are plain .md files with a date prefix and random ID. Includes marksman and ltex-ls-plus LSP integration.

For full documentation, see :help notes.nvim.

Installation

With vim.pack (Neovim 0.12+):

vim.pack.add({ "https://github.com/phrmendes/notes.nvim" })

Quick start

-- init.lua
require("notes").setup({
  path = vim.fs.joinpath(vim.env.HOME, "Documents", "notes"),
  picker = "mini", -- or "native" (default)
  journal = { title_format = "%Y-%m-%d" },
  lsp = {
    marksman = { enabled = true },
    ltex_plus = {
      enabled = true,
      languages = { default = "en-US", additionals = { "pt-BR" } },
    },
  },
})

-- Suggested keybindings
vim.keymap.set("n", "<leader>nn", function() require("notes").new() end, { desc = "Notes: new" })
vim.keymap.set("n", "<leader>ns", function() require("notes").search() end, { desc = "Notes: search" })
vim.keymap.set("n", "<leader>n/", function() require("notes").grep() end, { desc = "Notes: grep" })
vim.keymap.set("n", "<leader>nj", function() require("notes").journal() end, { desc = "Notes: journal" })

Preconfigured LSP servers

The plugin ships lsp/marksman.lua and lsp/ltex_plus.lua at the project root. Neovim 0.11+ auto-discovers them; setup() enables both automatically. Disable individually with lsp = { marksman = { enabled = false }, ltex_plus = { enabled = false } } (or lsp = false to disable all).

marksman

Markdown LSP — completion, hover, cross-file references, rename, and workspace symbol search (tags, headings). All standard LSP features — no plugin wrappers needed. Bind vim.lsp.buf.* yourself:

vim.keymap.set("n", "<leader>nR", vim.lsp.buf.rename, { desc = "Notes: rename (marksman)" })
vim.keymap.set("n", "<leader>nb", vim.lsp.buf.references, { desc = "Notes: backlinks (marksman)" })
vim.keymap.set("n", "<leader>nS", vim.lsp.buf.workspace_symbol, { desc = "Notes: search symbols/tags (marksman)" })

ltex-ls-plus

Grammar and spelling checker for .md, .tex, and .typst. Available as code actions (accept suggestion, add to dictionary, disable rule, hide false positive) and _ltex.* LSP commands. See :help notes.nvim for the full reference.

Usage

Command	Description
:Notes new	Create a new note
:Notes search	Search notes by filename
:Notes grep	Grep note contents
:Notes journal [date] [tags]	Open or create a journal entry
:checkhealth notes	Verify installation

Or from Lua:

require("notes").new()               -- create a note
require("notes").journal()           -- open today's journal entry
require("notes").search()            -- search by filename
require("notes").grep()              -- grep note contents
require("notes").set_picker("mini")  -- switch picker at runtime

Requirements

• Neovim 0.11+ (for lsp/<server>.lua runtime discovery)
• ripgrep (for grep)

Optional

• fd (for the mini picker backend)
• mini.pick — for the mini picker backend
• marksman — for markdown LSP features
• ltex-ls-plus — for grammar/spelling checks

Related

• denote — the Emacs package that inspired this plugin
• ltex_extra.nvim — richer ltex-ls-plus features (UI, statusline, scope management) on top of the basic integration shipped here

Development

This project uses devenv. Inside a devenv shell:

test     # run the test suite
doc      # regenerate doc/notes.txt

License

Apache-2.0 — Copyright (c) 2024 Pedro Mendes