https://github.com/pablopunk/todo.nvim
Project-specific notes for neovim
https://github.com/pablopunk/todo.nvim
Last synced: 11 months ago
JSON representation
Project-specific notes for neovim
- Host: GitHub
- URL: https://github.com/pablopunk/todo.nvim
- Owner: pablopunk
- Created: 2023-08-25T12:04:11.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-29T17:29:12.000Z (over 2 years ago)
- Last Synced: 2025-03-29T17:41:20.024Z (about 1 year ago)
- Language: Lua
- Size: 1.72 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# todo.nvim
> Project-specific notes
This plugin opens a floating window to write quick notes/todo list for your project.
If you're not on a repo, it wil keep a global file for notes in your home folder.
## Features
- Toggle a floating window with `:TodoToggle`
- Project-aware
- Automatically create a `.git/.TODO.md` file in the nearest parent repo
- Automatically create a `~/.TODO.md` file if you're not in a repo
- Different ways of closing the window:
- Use `:TodoToggle`
- Use `esc`
- Use `q`
- Use ``
- Automatically save the file when you close the floating window
- Markdown syntax
## Installation
For example using `lazy.nvim`:
```lua
{
"pablopunk/todo.nvim",
config = true, -- initialize it. equivalent to require("todo").setup() in lazy.vim
}
```
## Usage
It will give you a new command `:TodoToggle` to open/close the `.TODO.md` file. You can map it to whatever you want. I map it to `t`:
```lua
{
"pablopunk/todo.nvim",
opts = { map = "t" } -- same as .setup({...})
}
```