From 9542de6eb25bfa20b376920b607db864c9e20a7a Mon Sep 17 00:00:00 2001 From: luixal Date: Tue, 23 Feb 2021 20:17:51 +0100 Subject: [PATCH] Fixes identations and link docs. --- docs/configuration.md | 4 ++-- docs/tips-and-tricks.md | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 8bff54f..5785e56 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -69,7 +69,7 @@ message: # mapping: # allows to map fields from the remote format to the one expected by Homer # title: 'id' # use value from field 'id' as title # 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: # 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 ``` -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 { diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md index 63eeeaf..94167fb 100644 --- a/docs/tips-and-tricks.md +++ b/docs/tips-and-tricks.md @@ -145,9 +145,9 @@ Now, you can do that using the `mapping` field in your `message` configuration. ```yml message: url: https://api.chucknorris.io/jokes/random - mapping: - title: 'id' - content: 'value' + mapping: + title: 'id' + 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: @@ -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 message: url: https://api.chucknorris.io/jokes/random - mapping: - content: 'value' + mapping: + content: 'value' 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 message: url: https://api.chucknorris.io/jokes/random - mapping: - content: 'value' + mapping: + content: 'value' title: "Chuck Norris Facts!" content: "Message could not be loaded" ``` -- 2.41.0