]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
Fixes identations and link docs. 175/head
authorluixal <luixal@gmail.com>
Tue, 23 Feb 2021 19:17:51 +0000 (20:17 +0100)
committerluixal <luixal@gmail.com>
Tue, 23 Feb 2021 19:17:51 +0000 (20:17 +0100)
docs/configuration.md
docs/tips-and-tricks.md

index 8bff54f7889633b42ba6b423e350c743902d7cef..5785e560f645d9269642bcc8380da403a52ec81b 100644 (file)
@@ -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
 {
index 63eeeaf327b2bbcedfe1b85a7dbd56a1b3a3d226..94167fbad4b8e6aaed078ab12a44ab012f059b9e 100644 (file)
@@ -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"
 ```