https://github.com/balinux/nvim-kanban-board
A simple Kanban board plugin for Neovim to manage tasks in a TODO.md file.
https://github.com/balinux/nvim-kanban-board
kanban lua nvim
Last synced: 3 months ago
JSON representation
A simple Kanban board plugin for Neovim to manage tasks in a TODO.md file.
- Host: GitHub
- URL: https://github.com/balinux/nvim-kanban-board
- Owner: balinux
- License: mit
- Created: 2024-12-18T02:35:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-18T04:37:11.000Z (over 1 year ago)
- Last Synced: 2025-02-11T12:23:40.974Z (over 1 year ago)
- Topics: kanban, lua, nvim
- Language: Lua
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nvim-kanban-board
A simple Kanban board plugin for Neovim to manage tasks in a TODO.md file.
## Features
- Manage tasks in TODO, InProgress, and Done columns.
- Save and load tasks from a `TODO.md` file.
- Dynamic filepath support for local project or Neovim configuration.
## Installation
You cean install this plugin using any Neovim plugin manager. For example:
### With [Packer](https://github.com/wbthomason/packer.nvim)
```lua
use {
'username/nvim-kanban-board',
config = function()
require('kanban')
end
}
```
### With [Lazy.vim](https://github.com/folke/lazy.nvim)
```lua
require('lazy').setup {
'username/nvim-kanban-board',
config = function()
require('kanban')
end
}
```
## Usage
### Open the Kanban Board
```bash
:KanbanOpen
```
### Add an Item
```bash
:KanbanAdd
```
example
```bash
:KanbanAdd TODO Implement feature
```
### Move an Item
move an item between columns
```bash
:KanbanMove
```
example
```bash
:KanbanMove TODO InProgress 1
```
### Save
Save current kanban board
```bash
:KanbanSave
```
### load
Load the kanban board from TODO.md file
```bash
:KanbanLoad
```