https://github.com/carloscalla/notepad.nvim
Neovim plugin for taking quick notes
https://github.com/carloscalla/notepad.nvim
Last synced: 3 months ago
JSON representation
Neovim plugin for taking quick notes
- Host: GitHub
- URL: https://github.com/carloscalla/notepad.nvim
- Owner: carloscalla
- License: mit
- Created: 2025-06-19T16:55:11.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-01-27T19:10:35.000Z (3 months ago)
- Last Synced: 2026-01-28T05:59:07.218Z (3 months ago)
- Language: Lua
- Size: 21.5 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim-sorted - carloscalla/notepad.nvim
- awesome-neovim - carloscalla/notepad.nvim - Quick note-taking in Markdown with both repo-specific and global notepad support. (Note Taking / Cursorline)
README
# notepad.nvim
Neovim plugin for taking quick notes
Repo-specific notepad (if in git).
Global notepad.
## Installation & Setup
Use your favorite package manager to install notepad.nvim, e.g:
### Lazy
```lua
{
"carloscalla/notepad.nvim",
opts = {}
}
```
Note: You need to call the `setup` function to initialize the plugin. Lazy.nvim does
this with `opts = {}` in the example above.
```lua
require("notepad").setup({
-- Your configuration here
})
```
### Default Configuration
```lua
require("notepad").setup({
position = "bottom", -- 'top', 'left', 'right', 'bottom'
split_size = nil, -- Size of the split (percentage or absolute size). nil uses default split behavior
})
```
### Setup examples
```lua
-- Top horizontal split
require('notepad').setup({ position = 'top', split_size = 15 })
-- Left vertical split (30% of screen width)
require('notepad').setup({ position = 'left', split_size = 0.3 })
-- Right vertical split (50 columns)
require('notepad').setup({ position = 'right', split_size = 50 })
-- Bottom horizontal split (default)
require('notepad').setup({ position = 'bottom', split_size = 0.25 })
```
## Usage Examples
Use the following commands:
```vim
:Notepad " Opens repo-specific notepad (if in git) or global notepad
:Notepad global " Opens global notepad
```
Or with Lua:
```lua
-- Opens repo-specific notepad (if in git) or global notepad
require("notepad").open()
-- Opens global notepad
require("notepad").open_global()
```
## Inspiration
- [vim-bujo](https://github.com/vuciv/vim-bujo)