Awesome
todo.nvim
It helps you manage your to-do list while working in neovim. For Mac OS users, you can load your to-do list to Reminder, see Extension
<p align="center"> <img src="https://user-images.githubusercontent.com/47852787/176720169-eabd0f50-afab-4ff7-82a6-ea18b0b80af8.gif" width="80%" height="80%"> </p>Requirements
- Neovim 0.7 or higher.
Installation
Using packer
use { 'ackeraa/todo.nvim' }
Setup
This plugin must be explicitly enabled by using require("todo").setup{}
.
Pass the file_path
to specify the where do you want to save of the to-do list.
require("todo").setup {
opts = {
file_path = "path/to/save/todo.txt"
},
}
Usage
Use the command :Todo
to start.
There are four types of commands can be used in the floating window:
commands | Action |
---|---|
add {priority} {to-do} | Add a new to-do |
delete {priority} | Delete a to-do |
done {priority} | Mark a to-do as done |
edit {priority} {new-to-do}/{new-priority} | Edit a to-do's priority or contents |
Examples:
add do one thing
: Add the first to-do({priority}
defaults to 1)add 2 do another thing
: Add the second to-doedit 1 2
: Change the first to-do's priority to 2, the previous second to-do's priority becomes 1edit 2 do the new one thing
: Change second to-do's contentsdelete 2
: Delete the second to-dodone 1
: Mark the first to-do as done
See doc for more details.
Extension
Mac OS users can load the to-do list to Reminder as follows:
- Create a list called "Todo" in your Reminder.
- Set
upload_to_reminder = true
require("todo").setup {
opts = {
file_path = "path/to/save/todo.txt",
upload_to_reminder = true,
},
}
Hint: Anything you change in your Reminder will not affect your to-do list file.
TODO
- Just finished the job, but the implementation is not elegant.
- Improve the code structure