aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md9
-rw-r--r--docs/development.md (renamed from docs/developement.md)0
2 files changed, 6 insertions, 3 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index edcf1ed..4bd4677 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -13,7 +13,8 @@ Title, icons, links, colors, and services can be configured in the `config.yml`
13 13
14title: "App dashboard" 14title: "App dashboard"
15subtitle: "Homer" 15subtitle: "Homer"
16logo: "assets/homer.png" 16# documentTitle: "Welcome" # Customize the browser tab text
17logo: "assets/logo.png"
17# Alternatively a fa icon can be provided: 18# Alternatively a fa icon can be provided:
18# icon: "fas fa-skull-crossbones" 19# icon: "fas fa-skull-crossbones"
19 20
@@ -67,6 +68,7 @@ message:
67 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below. 68 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
68 style: "is-warning" 69 style: "is-warning"
69 title: "Optional message!" 70 title: "Optional message!"
71 icon: "fa fa-exclamation-triangle"
70 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit." 72 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
71 73
72# Optional navbar 74# Optional navbar
@@ -85,7 +87,7 @@ links:
85# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed). 87# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
86services: 88services:
87 - name: "Application" 89 - name: "Application"
88 icon: "fa fa-code-fork" 90 icon: "fas fa-code-branch"
89 items: 91 items:
90 - name: "Awesome app" 92 - name: "Awesome app"
91 logo: "assets/tools/sample.png" 93 logo: "assets/tools/sample.png"
@@ -110,7 +112,8 @@ services:
110 subtitle: "Another example" 112 subtitle: "Another example"
111 tag: "other" 113 tag: "other"
112 url: "https://www.reddit.com/r/selfhosted/" 114 url: "https://www.reddit.com/r/selfhosted/"
113 target: "_blank" # optionnal html a tag target attribute 115 target: "_blank" # optional html a tag target attribute
116 # class: "green" # optional custom CSS class for card, useful with custom stylesheet
114``` 117```
115 118
116If you choose to fetch message information from an endpoint, the output format should be: 119If you choose to fetch message information from an endpoint, the output format should be:
diff --git a/docs/developement.md b/docs/development.md
index 6ea1cba..6ea1cba 100644
--- a/docs/developement.md
+++ b/docs/development.md