From fd12de9ebd7a75ca2f31e8b28bd2c5ac10c46e21 Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 21:22:35 +0100 Subject: Improvements --- docs/configuration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md index a43d7f1..6c6a444 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -7,7 +7,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml` # Homepage configuration # See https://fontawesome.com/icons for icons options -# Optional: Use external configuration file. +# Optional: Use external configuration file. # Using this will ignore remaining config in this file # externalConfig: https://example.com/server-luci/config.yaml @@ -118,6 +118,8 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` +View the (Custom Services)[customservices.md] file for details about all available custom services (like PiHole). + If you choose to fetch message information from an endpoint, the output format should be: ```json -- cgit v1.2.3 From dfb0b14626ccf42784d5e4c270ea0e2253db724c Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 21:25:07 +0100 Subject: Fixed some typo's. --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md index 6c6a444..174da4f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -118,7 +118,7 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` -View the (Custom Services)[customservices.md] file for details about all available custom services (like PiHole). +View the [Custom Services](customservices.md) file for details about all available custom services (like PiHole). If you choose to fetch message information from an endpoint, the output format should be: -- cgit v1.2.3 From 9e0ef05efe00ffd98ff6c7314a67e8a05505dcc4 Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 21:27:19 +0100 Subject: Removed URL and made fixed. --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md index 174da4f..c88069e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -118,7 +118,7 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` -View the [Custom Services](customservices.md) file for details about all available custom services (like PiHole). +View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. If you choose to fetch message information from an endpoint, the output format should be: -- cgit v1.2.3 From c3878bca0bbaa2dd076ef83bf46a051139d67426 Mon Sep 17 00:00:00 2001 From: Andreas Waschinski <25221082+waschinski@users.noreply.github.com> Date: Tue, 13 Jul 2021 19:16:15 +0200 Subject: Adding Mealie service --- docs/configuration.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md index a472b41..dfe3761 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -167,3 +167,20 @@ In order to easily generate all required icon preset for the PWA to work, a tool ```bash npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} ``` + +### Supported services + +Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item. + +- PiHole +- AdGuardHome +- PaperlessNG +- Mealie + +### Additional configuration + +#### Paperless +For Paperless you need an API-Key which you have to store at the item in the field `apikey`. + +#### Mealie +First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized. If you want the planned meal for today to be shown instead (and _only_ if one is planned of course) you will also have to set an API key in the field `apikey`. You can create such a key in your Mealie installation. -- cgit v1.2.3 From 4386cd094b4e7869a7fa5aad3a9df9cd1d282021 Mon Sep 17 00:00:00 2001 From: Andreas Waschinski <25221082+waschinski@users.noreply.github.com> Date: Wed, 28 Jul 2021 16:12:19 +0200 Subject: Updating configuration --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md index dfe3761..f160ae0 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -183,4 +183,4 @@ Currently the following services are supported for showing quick infos on the ca For Paperless you need an API-Key which you have to store at the item in the field `apikey`. #### Mealie -First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized. If you want the planned meal for today to be shown instead (and _only_ if one is planned of course) you will also have to set an API key in the field `apikey`. You can create such a key in your Mealie installation. +First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation. -- cgit v1.2.3 From 1d3287dcca801a000dbdb40ef20fd26a97ebb2e3 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Sat, 25 Sep 2021 12:12:22 +0200 Subject: Apply linters --- docs/configuration.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'docs/configuration.md') diff --git a/docs/configuration.md b/docs/configuration.md index 68711ec..d90981a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,4 +1,4 @@ -## Configuration +# Configuration Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format. @@ -136,7 +136,6 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` - View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. 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)): @@ -152,7 +151,7 @@ If you choose to fetch message information from an endpoint, the output format s `null` value or missing keys will be ignored and value from the `config.yml` will be used if available. Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). -### Style Options +## Style Options Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors: @@ -163,7 +162,7 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. -### PWA Icons +## PWA Icons In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used: @@ -171,7 +170,7 @@ In order to easily generate all required icon preset for the PWA to work, a tool npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} ``` -### Supported services +## Supported services Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item. @@ -180,10 +179,12 @@ Currently the following services are supported for showing quick infos on the ca - PaperlessNG - Mealie -### Additional configuration +## Additional configuration + +### Paperless -#### Paperless For Paperless you need an API-Key which you have to store at the item in the field `apikey`. -#### Mealie +### Mealie + First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation. -- cgit v1.2.3