aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2020-05-25 11:42:05 -0700
committerGitHub <noreply@github.com>2020-05-25 11:42:05 -0700
commitab7ac44c191e3b7dea696e76b74097e23f73b18c (patch)
treed3c6ce20c9766ab694a7c06b235ddff9aee91da6 /README.md
parent554fc76d750ef6a3516a2f1141ba575fb2563a19 (diff)
parentfcf5f412a55b37033006c0c1866bc4693ca8bd57 (diff)
downloadhomer-ab7ac44c191e3b7dea696e76b74097e23f73b18c.tar.gz
homer-ab7ac44c191e3b7dea696e76b74097e23f73b18c.tar.zst
homer-ab7ac44c191e3b7dea696e76b74097e23f73b18c.zip
Merge pull request #48 from issmirnov/patch-1
Add "Style Options" section for bulma CSS
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index faa7660..f03152b 100644
--- a/README.md
+++ b/README.md
@@ -126,3 +126,14 @@ If you choose to fetch message information from an endpoint, the output format s
126 126
127`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 127`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
128Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). 128Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
129
130### Style Options
131
132Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
133
134- `is-info` (blue)
135- `is-success` (green)
136- `is-warning` (yellow)
137- `is-danger` (red)
138
139You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.