readme-kanban-board
Write a markdown based kanban board and have it converted to a nice image in your readme
Last updated 2 years ago by entozoon .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install readme-kanban-board 
SYNC missed versions from official npm registry.

Readme Kanban Board

Write a markdown based kanban board in your README.md and have it converted to an image and injected in.

Example

In your README.md, simply have a commented section like this, in the format:

<!---KANBAN
# To Do
- Eat healthy food
- Exercise regularly
- Learn sign language

# In Progress
- Drink too much

# Done
- Regret my decisions
- Age too quickly
KANBAN--->

Which generates:

created by readme-kanban-board

One-time Quick Usage

npx readme-kanban-board

Install

npm i --save-dev readme-kanban-board

Usage

Add it to package.json scripts, similar to:

"scripts": {
  "readme-kanban-board": "readme-kanban-board"
}

Then fire it up by running:

npm run readme-kanban-board

Yes that's all well and good, but what does it actually do?

  • Finds kanban code in your README.md file
  • Parses it up
  • Generates a kanban board of it with HTML/CSS
  • Creates a screenshot of said HTML
  • Saves the image to repo
  • Injects/updates an image link in your README.md

Current Tags

  • 1.5.0                                ...           latest (2 years ago)

19 Versions

  • 1.5.0                                ...           2 years ago
  • 1.4.2                                ...           2 years ago
  • 1.4.1                                ...           3 years ago
  • 1.4.0                                ...           3 years ago
  • 1.3.5                                ...           3 years ago
  • 1.3.4                                ...           3 years ago
  • 1.3.3                                ...           3 years ago
  • 1.3.2                                ...           3 years ago
  • 1.3.0                                ...           3 years ago
  • 1.2.1                                ...           3 years ago
  • 1.2.0                                ...           3 years ago
  • 1.1.0                                ...           3 years ago
  • 1.0.3                                ...           3 years ago
  • 1.0.2                                ...           3 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
  • 0.0.3                                ...           3 years ago
  • 0.0.2                                ...           3 years ago
  • 0.0.1                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (3)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |