Skip to content

README.md

Latest commit

 

History

History
67 lines (50 loc) · 2 KB

README.md

File metadata and controls

67 lines (50 loc) · 2 KB

📝 nvim-quicknotes

Quicknotes plugin for Neovim.

Screenshot

Create a Quicknote in a floating window, and save it on your computer to be picked up later. The Quicknote supports Markdown format.

If, like me, you are someone that always needs to note down stuff when working on a project, then this plugin may be for you!

Installation

Lazy

{
  "davmacario/nvim-quicknotes",
  -- >>> The following are optionals, to enable lazy loading
  keys = { "<leader>qn" },
  cmd = { "Quicknotes", "QuicknotesClear", "QuicknotesCleanup" }, -- Lazy-load the plugin
  -- <<<

  config = function()
    require("nvim-quicknotes").setup()

    -- Custom keymap
    vim.keymap.set("n", "<leader>qn", vim.cmd.Quicknotes, { desc = "Open quicknotes" })
  end,
}

Configuration

The following are the default configuration settings for the plugin:

require("nvim-quicknotes").setup({
  -- Local directory where all the quicknotes will be stored
  quicknotes_dir = utils.path_join({ os.getenv("HOME"), ".local/state/nvim/quicknotes/" }),
  -- Window configuration
  window = {
    -- width and height represent the relative size of the floating window
    width = 0.5,
    height = 0.6,
    relative = "editor",
    style = "minimal",
    -- Specify border style
    border = "rounded",
    -- Title
    title = "📝 Quicknotes",
    title_color = "#FABD2F",
})

The notes are stored in quicknotes_dir. For a quicknote opened in /path/to/project, the quicknote name will be path%to%project%quicknotes.md.

Usage

  • :Quicknotes: open quicknote for current project (create it if absent). Press q in normal mode to save the note and close the floating window.
  • :QuicknotesClear: delete the quicknote associated with current directory.
  • :QuicknotesCleanup: cleanup the quicknotes directory - delete the quicknotes associated with directories that are not anymore on the current system or any file not following the naming scheme inside quicknotes_dir.

License

MIT