notes.nvim

notes.nvim is a neovim plugin that allows you to create notes in markdown format.

Installation

lazy.nvim

You can install notes.nvim using lazy.nvim by adding the following to your init.lua file:

return {
  "Theacebutler/notes.nvim",
  config = function()
    require("notes").setup({
      -- the path to the directory where your notes are stored
      base_path = "~/.notes.nvim/notes",
    })
  end,
}

Usage

keybindings

By default, the keybindings are:

    keymaps = {
     open = "<leader>nt",
     close = "q",
     delete = "dd",
     add = "a",
    },

You can change the keybindings by passing a keymaps table to the setup function in option in your init.lua file.

Opening notes

To open a note, you can use the command :NotesOpen or set your own keybinding in your init.lua file.

By default, the notes are stored in ~/.notes.nvim/notes. You can change this path by setting the base_path option in your init.lua file.

Creating notes

To create a new note, you can use the command :NotesOpen or the keybinding <leader>nt.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License.