]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
Add some additional description for the tagstyle in README and config 5/head
authorpdevq <45507854+pdevq@users.noreply.github.com>
Sun, 10 Nov 2019 15:05:49 +0000 (10:05 -0500)
committerpdevq <45507854+pdevq@users.noreply.github.com>
Sun, 10 Nov 2019 15:05:49 +0000 (10:05 -0500)
 - This also updates the FontAwesome URL in the config

README.md
config.yml

index 9b9e7058d245af19cf34d77a2ca7c0a6eb8288de..62bbd779a19f85cd217ae3e25c645eebbb2ab7e5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ links:
 
 # Services
 # First level array represent a group.
-# Leave only a "items" key if not using group (group name & icon are optional, section separation will not be displayed).
+# 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"
@@ -58,6 +58,7 @@ services:
         logo: "/assets/tools/rabbitmq.png"
         subtitle: "Manage & monitor RabbitMQ server"
         tag: "haproxy"
+        # Optional tagstyle
         tagstyle: "is-success"
         url: "#"
   - name: "Monitoring"
index 6570a5afb7516ca24780cf420d411f48771c291f..8060119ada58cff2316e08fef80d4b2cb5dfeae2 100644 (file)
@@ -1,6 +1,6 @@
 ---
 # Homepage configuration
-# See https://fontawesome.com/v4.7.0/icons/ for icons options
+# See https://fontawesome.com/icons for icons options
 
 title: "Simple homepage"
 subtitle: "Homer"
@@ -25,7 +25,7 @@ links:
 
 # Services
 # First level array represent a group.
-# Leave only a "items" key if not using group (group name & icon are optional, section separation will not be displayed).
+# 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: "fas fa-code-branch"
@@ -39,6 +39,8 @@ services:
         logo: "/assets/tools/rabbitmq.png"
         subtitle: "Manage & monitor RabbitMQ server"
         tag: "haproxy"
+        # Optional tagstyle
+        # Same styling options as the optional message.
         tagstyle: "is-success"
         url: "#"
   - name: "Monitoring"