phares3757/kanbn2md
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Created and Relations
Some checks failed
release-please / release-please (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Mike Phares
2023-06-30 13:14:19 -07:00
parent 71fb44592b
commit b65befe761
2 changed files with 42 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,8 +1,8 @@
# kanbn2md
[Kanbn](https://github.com/basementuniverse/kanbn) is a CLI Kanban board. It stores
[Kanbn](https://github.com/basementuniverse/kanbn) is a CLI Kanban board. It stores
the task information in markdown format and has a [vscode extension](https://github.com/basementuniverse/vscode-kanbn)
for viewing and editing the board from vscode. What is missing is a way to render the board as a markdown table.
for viewing and editing the board from vscode. What is missing is a way to render the board as a markdown table.
This simple program takes JSON output of `kanbn board -j` on stdin and renders a markdown table on stdout.
## Installation
@ -16,12 +16,16 @@ go install github.com/tjdavis3/kanbn2md
## Usage
```bash
gofmt -w main.go
go build
kanbn board -j | kanbn2md > board.md
kanbn board -j > .kanbn/board.json
kanbn board -j | L:\Git\kanbn2md\kanbn2md.exe >.kanbn/board.md
```
## Example
| Backlog | Todo | In Progress | Done |
| --- | --- | --- | --- |
| Backlog | Todo | In Progress | Done |
| ---------------- | ------------------ | ------------------ | --------- |
| Comment the code | Create github repo | Create a README.md | Build app |
| Add tests | Add error handling | | |
| Add tests | Add error handling | | |