mirror of
https://github.com/boolean-maybe/tiki
synced 2026-04-21 13:37:20 +00:00
update plugin config docs
This commit is contained in:
parent
a5b7fb9bb6
commit
6df1ae4a99
2 changed files with 109 additions and 13 deletions
|
|
@ -3,6 +3,7 @@
|
|||
## Configuration files
|
||||
|
||||
- `config-dir/config.yaml` main configuration file
|
||||
- `config-dir/workflow.yaml` plugins/view configuration
|
||||
- `config-dir/new.md` new tiki template - will be used when a new tiki is created
|
||||
|
||||
## Configuration directories
|
||||
|
|
@ -74,4 +75,87 @@ appearance:
|
|||
# Options: 16, 256, 16777216 (truecolor)
|
||||
# Gradients disabled if terminal has fewer colors
|
||||
# Default: 256 (works well on most terminals)
|
||||
```
|
||||
|
||||
### workflow.yaml
|
||||
|
||||
For detailed instructions on how to configure plugins see [Customization](plugin.md)
|
||||
|
||||
Example `workflow.yaml` with available settings:
|
||||
|
||||
```yaml
|
||||
views:
|
||||
- name: Kanban
|
||||
foreground: "#87ceeb"
|
||||
background: "#25496a"
|
||||
key: "F1"
|
||||
lanes:
|
||||
- name: Ready
|
||||
filter: status = 'ready' and type != 'epic'
|
||||
action: status = 'ready'
|
||||
- name: In Progress
|
||||
filter: status = 'in_progress' and type != 'epic'
|
||||
action: status = 'in_progress'
|
||||
- name: Review
|
||||
filter: status = 'review' and type != 'epic'
|
||||
action: status = 'review'
|
||||
- name: Done
|
||||
filter: status = 'done' and type != 'epic'
|
||||
action: status = 'done'
|
||||
sort: Priority, CreatedAt
|
||||
- name: Backlog
|
||||
foreground: "#5fff87"
|
||||
background: "#0b3d2e"
|
||||
key: "F3"
|
||||
lanes:
|
||||
- name: Backlog
|
||||
columns: 4
|
||||
filter: status = 'backlog' and type != 'epic'
|
||||
actions:
|
||||
- key: "b"
|
||||
label: "Add to board"
|
||||
action: status = 'ready'
|
||||
sort: Priority, ID
|
||||
- name: Recent
|
||||
foreground: "#f4d6a6"
|
||||
background: "#5a3d1b"
|
||||
key: Ctrl-R
|
||||
lanes:
|
||||
- name: Recent
|
||||
columns: 4
|
||||
filter: NOW - UpdatedAt < 24hours
|
||||
sort: UpdatedAt DESC
|
||||
- name: Roadmap
|
||||
foreground: "#e2e8f0"
|
||||
background: "#2a5f5a"
|
||||
key: "F4"
|
||||
lanes:
|
||||
- name: Now
|
||||
columns: 1
|
||||
filter: type = 'epic' AND status = 'ready'
|
||||
action: status = 'ready'
|
||||
- name: Next
|
||||
columns: 1
|
||||
filter: type = 'epic' AND status = 'backlog' AND priority = 1
|
||||
action: status = 'backlog', priority = 1
|
||||
- name: Later
|
||||
columns: 2
|
||||
filter: type = 'epic' AND status = 'backlog' AND priority > 1
|
||||
action: status = 'backlog', priority = 2
|
||||
sort: Priority, Points DESC
|
||||
view: expanded
|
||||
- name: Help
|
||||
type: doki
|
||||
fetcher: internal
|
||||
text: "Help"
|
||||
foreground: "#bcbcbc"
|
||||
background: "#003399"
|
||||
key: "?"
|
||||
- name: Docs
|
||||
type: doki
|
||||
fetcher: file
|
||||
url: "index.md"
|
||||
foreground: "#ff9966"
|
||||
background: "#2b3a42"
|
||||
key: "F2"
|
||||
```
|
||||
|
|
@ -20,25 +20,37 @@ how Backlog is defined:
|
|||
```
|
||||
that translates to - show all tikis in the status `backlog`, sort by priority and then by ID arranged visually in 4 columns in a single lane.
|
||||
The `actions` section defines a keyboard shortcut `b` that moves the selected tiki to the board by setting its status to `ready`
|
||||
You define the name, caption colors, hotkey, tiki filter and sorting. Save this into a yaml file and add this line:
|
||||
You define the name, caption colors, hotkey, tiki filter and sorting. Save this into a `workflow.yaml` file in the config directory:
|
||||
|
||||
```text
|
||||
plugins:
|
||||
- file: my-plugin.yaml
|
||||
```yaml
|
||||
views:
|
||||
- name: Backlog
|
||||
foreground: "#5fff87"
|
||||
background: "#0b3d2e"
|
||||
key: "F3"
|
||||
lanes:
|
||||
- name: Backlog
|
||||
columns: 4
|
||||
filter: status = 'backlog' and type != 'epic'
|
||||
actions:
|
||||
- key: "b"
|
||||
label: "Add to board"
|
||||
action: status = 'ready'
|
||||
sort: Priority, ID
|
||||
```
|
||||
|
||||
to the `config.yaml` file in the config directory
|
||||
|
||||
Likewise the documentation is just a plugin:
|
||||
|
||||
```text
|
||||
name: Documentation
|
||||
type: doki
|
||||
fetcher: file
|
||||
url: "index.md"
|
||||
foreground: "#ff9966"
|
||||
background: "#993300"
|
||||
key: "F1"
|
||||
```yaml
|
||||
views:
|
||||
- name: Docs
|
||||
type: doki
|
||||
fetcher: file
|
||||
url: "index.md"
|
||||
foreground: "#ff9966"
|
||||
background: "#2b3a42"
|
||||
key: "F2"
|
||||
```
|
||||
|
||||
that translates to - show `index.md` file located under `.doc/doki`
|
||||
|
|
|
|||
Loading…
Reference in a new issue