todo.nvim is a project wide todo list within Neovim.
This section will show how to install todo.nvim within using Lazy as a
package manager.
Using lazy.nvim
-- init.lua:
{
'jed-richards/todo.nvim'
}
-- plugins/todo.lua:
return {
'jed-richards/todo.nvim'
}After installation, todo.nvim will be setup and ready to be used.
| Mappings | Action |
|---|---|
<leader>td |
Toggle todo window |
<C-a> |
Add item (within todo window) |
<C-x> |
Remove item under cursor (within todo window) |
<cr> |
Toggle/mark item under cursor (within todo window) |
q |
Close/quit todo window (within todo window) |
h |
Toggle todo help window (within todo window) |
todo.nvim uses the user's CWD as the base of the "project". Therefore, the
user will start nvim within the directory that will be their "base" or
"root". todo.nvim will create a directory under the CWD as .todo/. This will
store the user's TODOs.