Neovim kanban plugin. Manage task as a kanban board in neovim. Task information is import and export by markdown file. Compatible with obsidian kanban.
- ripgrep
Using packer
use 'arakkkkk/kanban.nvim'
-- Optional
use 'nvim-telescope/telescope.nvim'and setup
require("kanban").setup({
markdown = {
description_folder = "./tasks/", -- Path to save the file corresponding to the task.
list_head = "## ",
}
})Using lazy.nvim
return {
"arakkkkk/kanban.nvim",
-- Optional
dependencies = {
"nvim-telescope/telescope.nvim",
},
config = function()
require("kanban").setup({
markdown = {
description_folder = "./tasks/", -- Path to save the file corresponding to the task.
list_head = "## ",
},
})
end,
}With the above settings, you can manage tasks as follows
.
└── kanban.md
└── tasks # Configured by setup option (description_folder)
├── task1.md # Memo for task1
├── task2.md # Memo for task2
├── task3.md # Memo for task3
└── task4.md # Memo for task4
Create first kanban project.
:KanbanCreate <file_path>
and open kanban to enter :KanbanOpen <file_path>.
You can add new tasks with a and move cards to focus with <C-h/j/k/l>.
You can also move a card with H/J/K/L.
See more keymap for information on how to create and move tasks.
In a task card, the first line of text is as the task title, the string beginning with @ is treated as the deadline, and the characters beginning with # are treated as tags.
All setup options are here.
- First line is Task title.
- Line beginning with
#are tag. - Line beginning with
@is due.
If you installed telescope.nvim, you can search kanban project files by KanbanOpen telescope command.
This command search markdown files by kanban-plugin: .+ which is same options to Obsidian kanban.
All keymap are here.
| Key | Action |
|---|---|
| <C-h/j/k/l> | Focus left/below/above/right task. |
| <S-h/j/k/l> | Move task to left/below/above/right. |
| gg | Focus top task in the list. |
| G | Focus bottom task in the list. |
| <leader>lr | Rename list. |
| <leader>la | Add list. |
| <leader>ld | Delete list. |
| <C-o> | Add task. |
| <C-t> | Complete task. |
| :w<CR> | Save kanban. |
| q | Quit. |
| <CR> | Add task description in another markdown file. |