github
/
homer
mirror of https://github.com/bastienwirtz/homer
1
0
Fork 0
Code Issues Releases Wiki Activity

Fixes identations and link docs.

pull/175/head
luixal 2021-02-23 20:17:51 +01:00
parent b6782c92b5
commit 9542de6eb2
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/configuration.md
View File

@ -69,7 +69,7 @@ message:
# mapping: # allows to map fields from the remote format to the one expected by Homer # mapping: # allows to map fields from the remote format to the one expected by Homer
# title: 'id' # use value from field 'id' as title # title: 'id' # use value from field 'id' as title
# content: 'value' # value from field 'value' as content # content: 'value' # value from field 'value' as content
# refreshInterval: 10000 # time interval to refresh message # refreshInterval: 10000 # Optional: time interval to refresh message
# #
# Real example using chucknorris.io for showing Chuck Norris facts as messages: # Real example using chucknorris.io for showing Chuck Norris facts as messages:
# url: https://api.chucknorris.io/jokes/random # url: https://api.chucknorris.io/jokes/random
@ -129,7 +129,7 @@ services:
# background: red # optional color for card to set color directly without custom stylesheet # background: red # optional color for card to set color directly without custom stylesheet
``` ```
If you choose to fetch message information from an endpoint, the output format should be: If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
```json ```json
{ {

14
docs/tips-and-tricks.md
View File

@ -145,9 +145,9 @@ Now, you can do that using the `mapping` field in your `message` configuration.
```yml ```yml
message: message:
url: https://api.chucknorris.io/jokes/random url: https://api.chucknorris.io/jokes/random
mapping: mapping:
title: 'id' title: 'id'
content: 'value' content: 'value'
``` ```
As you would see, using the ID as a title doesn't seem nice, that's why when a field is empty it would keep the default values, like this: As you would see, using the ID as a title doesn't seem nice, that's why when a field is empty it would keep the default values, like this:
@ -155,8 +155,8 @@ As you would see, using the ID as a title doesn't seem nice, that's why when a f
```yml ```yml
message: message:
url: https://api.chucknorris.io/jokes/random url: https://api.chucknorris.io/jokes/random
mapping: mapping:
content: 'value' content: 'value'
title: "Chuck Norris Facts!" title: "Chuck Norris Facts!"
``` ```
@ -165,8 +165,8 @@ and even an error message in case the `url` didn't respond or threw an error:
```yml ```yml
message: message:
url: https://api.chucknorris.io/jokes/random url: https://api.chucknorris.io/jokes/random
mapping: mapping:
content: 'value' content: 'value'
title: "Chuck Norris Facts!" title: "Chuck Norris Facts!"
content: "Message could not be loaded" content: "Message could not be loaded"
``` ```