X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=827226b9ccc3d8bcebba583c245afb7de91fa0bb;hb=refs%2Fpull%2F48%2Fhead;hp=f052fc9074939580702289034951413228ee13f8;hpb=d2bf5e5f62c2a8d94b27529424a96066ead3e5b1;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index f052fc9..827226b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Homer A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file. -**Check out the live demo [here](https://homer-demo.netlify.com/).** +**Check out the live demo [here](https://homer-demo.netlify.app).** It supports keyboard shortcuts: @@ -61,11 +61,11 @@ message: # links: [] # Allows for navbar (dark mode, layout, and search) without any links links: - name: "ansible" - icon: "fa-github" + icon: "fab fa-github" url: "https://github.com/xxxxx/ansible/" target: '_blank' # optionnal html a tag target attribute - name: "Wiki" - icon: "fa-book" + icon: "fas fa-book" url: "https://wiki.xxxxxx.com/" # Services @@ -73,7 +73,7 @@ links: # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed). services: - name: "DevOps" - icon: "fa-code-fork" + icon: "fa fa-code-fork" items: - name: "Jenkins" logo: "/assets/tools/jenkins.png" @@ -91,7 +91,7 @@ services: tagstyle: "is-success" url: "#" - name: "Monitoring" - icon: "fa-heartbeat" + icon: "fas fa-heartbeat" items: - name: "M/Monit" logo: "/assets/tools/monit.png" @@ -127,3 +127,14 @@ If you choose to fetch message information from an endpoint, the output format s `null` value or missing keys will be ignored and value from the `config.yml` will be used if available. Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). + +### Style Options + +Homer 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: + +- `is-info` (blue) +- `is-success` (green) +- `is-warning` (yellow) +- `is-danger` (red) + +You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.