Note Taker

A minimal note-taking plugin for Neovim. Aimed to be easy and fast to use.

Warning

This plugin is in its early stages of development, it can have bugs and features missing/incomplete

Requirements

• Neovim 0.10 or newer
• nui.nvim

Installation

• Using vim.pack:

Warning

You need nvim 0.12 or above to use vim.pack

vim.pack.add{
  "https://github.com/MunifTanjim/nui.nvim"
  "https://github.com/SCSDC-co/note-taker.nvim"
}

• Using lazy.nvim:

{
  "SCSDC-co/note-taker.nvim",
  dependencies = { "MunifTanjim/nui.nvim" },
  opts = {}
}

• Using packer.nvim:

use {
  "SCSDC-co/note-taker.nvim",
  requires = { "MunifTanjim/nui.nvim", opt = true },
}

• Using vim-plug:

Plug "MunifTanjim/nui.nvim"
Plug "SCSDC-co/note-taker.nvim"

Configuration

This is the default configuration:

require("note-taker").setup({
  path = vim.fn.stdpath("data") .. "/note-taker/",
  confirm_linkage = true,
})

confirm_linkage defaults to true. Set it to false to link existing files or create missing files immediately after validating the path.

Usage

Command	Action
:Note new	Create a note by entering its title, description, and path.
:Note list	Browse saved notes. Press a to create another note.
:Note remove	Select and remove a saved note.

Inside menus, use j/k or the arrow keys to move, Enter to select, and q or Esc to close.

When creating a note, the plugin can link an existing file or create a new empty file. The parent directory must already exist.

License

GNU GPL v3. See LICENSE.