Notebox.Nvim

📥 notebox

**Notebox** is a plugin for Neovim designed to help you manage your Markdown-based notes. It is intentionally **lightweight**, adhering to the **Unix** philosophy, and focuses on streamlining the **creation and retrieval of notes**.

_Additional note-taking features, such as highlighting and LSP support, are accessible through other plugins; see the [companions] section for more information._

✨ Key features

• Key: Value

⚡ Requirements

• [Neovim]
• [plenary.nvim]
• [telescope.nvim]

📦 Installation

[lazy.nvim]

{
  'sQVe/notebox.nvim',
  dependencies = { 'nvim-lua/plenary.nvim' },
  opts = {
    -- Input configuration here.
    -- Refer to the configuration section below for options.
  }
},

[packer.nvim]

use({
  'sQVe/notebox.nvim',
  requires = { 'nvim-lua/plenary.nvim' },
  config = function()
    require('notebox').setup({
      -- Input configuration here.
      -- Refer to the configuration section below for options.
    })
  end,
})

🔌 Configuration

The following code block shows the available options and their defaults:

{
  generate_note_id = nil,
  get_open_options = nil,
  root_directory = vim.fn.expand('$HOME') .. '/notebox',
  subdirectories = {
    dailies = 'dailies',
    new_notes = 'inbox',
    templates = 'templates',
  },
}

`generate_note_id`

A callback function that generates the id of a note. The builtin handler for this provides the following ids:

Type	Format	Example
Daily	%Y%m%d-%A	20230131-wednesday
Note	%Y%m%d- + title	20230131-my-note-title

Parameters

• type