README.md 1.74 KB
Newer Older
Fabio Pesari's avatar
Fabio Pesari committed
1 2 3 4 5
# kanbanale - Simple static HTML kanban board generator

kanbanale is a static site generator for simple kanban boards.
It outputs a static HTML board, no JS, from a text-based YAML definition.

Fabio Pesari's avatar
Fabio Pesari committed
6
I wrote it because I was looking for an easy way to visualize
Fabio Pesari's avatar
Fabio Pesari committed
7 8
task priorities, without running server-side or JavaScript code.

Fabio Pesari's avatar
Fabio Pesari committed
9 10 11 12 13 14 15 16 17
## Installation

You can install kanbanale like any Rubygem:

```
gem build kanbanale.gemspec
gem install kanbanale*.gemspec --user
```

Fabio Pesari's avatar
Fabio Pesari committed
18 19 20 21
## Usage

In order to use kanbanale, you need to know YAML.

Fabio Pesari's avatar
Fabio Pesari committed
22
First, generate a sample YAML file by running
Fabio Pesari's avatar
Fabio Pesari committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36
`kanbanale init kanbanale.yaml`.

Fit the schema of the generated YAML file to your needs, then run
`kanbanale create kanbanale.yaml website/` to generate a directory called
`website` (or whatever you call it) which contains the whole static website.

Load it to a web server, instant cheapo kanban board.

To update it (so that your modifications to the CSS file are not affected),
run `kanbanale update kanbanale.yaml website/`

### Customization

This program doesn't try to do any fancy declarative customization because
Fabio Pesari's avatar
Fabio Pesari committed
37 38
it's the same thing as writing CSS, so in order to customize looks,
you have to modify `static/css/kanbanale.css`.
Fabio Pesari's avatar
Fabio Pesari committed
39 40 41 42

kanbanale takes the names for CSS div ids from their names in the
YAML file, so that `My ideas` becomes `#my-ideas`.

Fabio Pesari's avatar
Fabio Pesari committed
43
By default, it already provides a style for the most common type of
Fabio Pesari's avatar
Fabio Pesari committed
44 45 46 47 48 49 50
kanban board, so most people who use it won't have to touch CSS at all.

Thanks to Daniel Eden for Toast, by the way, as it provides the lightweight
grid on which kanbanale is based.

## License

Fabio Pesari's avatar
Fabio Pesari committed
51 52
Everything in this repository is released under the
GNU Affero General Public License, version 3 or any later version, unless
Fabio Pesari's avatar
Fabio Pesari committed
53
otherwise specified (and even in that case, it's all free software).