diff --git a/custom_cards/custom_card_device_tracker/README.md b/custom_cards/custom_card_device_tracker/README.md index 34459197b..622440000 100644 --- a/custom_cards/custom_card_device_tracker/README.md +++ b/custom_cards/custom_card_device_tracker/README.md @@ -7,7 +7,7 @@ hide: ## Description -![example-image](../../docs/assets/img/ulm_cards/custom_card_device_tracker.png){ width="500" } +![example-image](../../docs/assets/img/custom_card_device_tracker.png){ width="500" } The `custom_card_device_tracker` displays presence state of a device according to the provided entity. It allow to display the state of two tracker for this device diff --git a/custom_cards/custom_card_heat_pump/README.md b/custom_cards/custom_card_heat_pump/README.md index ad2b5543a..b5d0fac26 100644 --- a/custom_cards/custom_card_heat_pump/README.md +++ b/custom_cards/custom_card_heat_pump/README.md @@ -24,9 +24,9 @@ Initial release ## Images -![Heat_pump](Heat_pump.PNG) +![Heat_pump](../../docs/assets/img/Heat_pump.PNG) -![Heat_pump_gif](heat_pump.gif) +![Heat_pump_gif](../../docs/assets/img/heat_pump.gif) ## Usage diff --git a/docs/assets/img/Heat_pump.PNG b/docs/assets/img/Heat_pump.PNG new file mode 100644 index 000000000..72395f644 Binary files /dev/null and b/docs/assets/img/Heat_pump.PNG differ diff --git a/docs/assets/img/heat_pump.gif b/docs/assets/img/heat_pump.gif new file mode 100644 index 000000000..dc8e233dc Binary files /dev/null and b/docs/assets/img/heat_pump.gif differ diff --git a/docs/assets/img/setup/hacs_integration_config.png b/docs/assets/img/setup/hacs_integration_config.png index 9b5145ad2..d055cf178 100644 Binary files a/docs/assets/img/setup/hacs_integration_config.png and b/docs/assets/img/setup/hacs_integration_config.png differ diff --git a/docs/setup/custom_cards.md b/docs/setup/custom_cards.md index d47d1cac7..688aa4079 100644 --- a/docs/setup/custom_cards.md +++ b/docs/setup/custom_cards.md @@ -11,6 +11,8 @@ This 'theme' and his community do offer support for multiple great Custom-cards. !!! tip " 🚀 New Custom Card Selection Feature! 🚀" Since the release of `v1.1.0` support has been build in to select custom/community cards that are available in the `main` branch on our Github Repository in the `custom_cards` folder. This Removes the need for copying over files from the Github Repo and put them in the `/config/ui_lovelace_minimlist/custom_cards` folder. + You can select the custom cards you want to use in your integration options (see [installation](installation.md)). This requires a GitHub account. Alternatively + you can copy the custom cards you want to use as outlined below. ### Custom Cards diff --git a/docs/setup/installation.md b/docs/setup/installation.md index 74e48e2e3..013212988 100644 --- a/docs/setup/installation.md +++ b/docs/setup/installation.md @@ -20,17 +20,20 @@ Now you can configure the Integration, you can do this also after it's installed ![hacs_integration_config](../assets/img/setup/hacs_integration_config.png) -- Language: Will set the language for the Integration. -- Side panel enabled: If you want to add an Entry in the Side Panel for the auto generated Dashboard. (Still under heavy development!) -- Side panel title: Will set the title for the Lovelace Dashboard in the Sidebar. -- Side panel icon: Which icon to put in front of the Title. -- Theme: Choose a theme of your choice (Note: Both themes will be installed anyway and can be customized later if needed.) +- *Language*: Will set the language for the Integration. +- *Enable creation of a Dashboard entry in the Side panel*: If you want to add an Entry in the Side Panel for the auto generated Dashboard. (Still under heavy development!) +- *Side panel title*: Will set the title for the Lovelace Dashboard in the Sidebar. +- *Side panel icon*: Which icon to put in front of the Title. +- *Enable adaptive Dashboard with popup splitview*: Creates an entry for the [adaptive dashboard](adaptive_dash.md) +- *Adaptive panel title*: Will set the title for the adaptive dashboard in the Sidebar. +- *Adaptive panel icon*: Which icon to put in front of the adaptive dashboard sidebar entry. +- *Theme*: Choose a theme of your choice (Note: Both themes will be installed anyway and can be customized later if needed.) !!! note "" Currently, it may happen that themes are not automatically selected correctly for you in all cases automatically. Please make sure that the minimalist theme is correctly selected in your Home Assistant settings (click on your profile picture in Home Assistant, bottom left). -- Theme path: Make sure this is set to the same path as is configured in your `configuration.yaml` (default: `themes/`) +- *Theme path*: Make sure this is set to the same path as is configured in your `configuration.yaml` (default: `themes/`) !!! note "" @@ -43,7 +46,7 @@ Now you can configure the Integration, you can do this also after it's installed You will also need to change your user theme to the chosen theme or else no visual modifications will work. -- Include Custom Cards: This will make sure almost all dependency cards are included and configured for you. +- *Include Custom Cards*: This will make sure almost all dependency cards are included and configured for you. !!! danger "" @@ -60,6 +63,8 @@ Now you can configure the Integration, you can do this also after it's installed | [`auto-entities`](https://github.com/thomasloven/lovelace-auto-entities)| | [`simple-weather-card`](https://github.com/kalkih/simple-weather-card) | +- *Select Community Cards you want to enable*: Selected [custom cards](custom_cards.md) will be downloaded automatically to enable usage. Requires a GitHub account. Restart or reload your configuration after toggling this setting. If needed, a notification will appear, indicating that GitHub needs to be set up. You will be prompted to go to your integrations and to reconfigure this integration. Selecting "reconfigure" on your Lovelace Minimalist UI integration, the GitHub-Login-flow will start. You might need to restart HomeAssistant, when your selected community cards change. + Hit submit and in the Sidebar a new Dashboard entry should appear. A new file for the dashboard configuration, with a small example, where you can generate your own layout should have been created under that location: diff --git a/docs/usage/custom_cards/custom_card_device_tracker.md b/docs/usage/custom_cards/custom_card_device_tracker.md index d7eede76f..fa37076ad 100644 --- a/docs/usage/custom_cards/custom_card_device_tracker.md +++ b/docs/usage/custom_cards/custom_card_device_tracker.md @@ -7,7 +7,7 @@ hide: ## Description -![example-image](../../assets/img/ulm_cards/custom_card_device_tracker.png){ width="500" } +![example-image](../../assets/img/custom_card_device_tracker.png){ width="500" } The `custom_card_device_tracker` displays presence state of a device according to the provided entity. It allow to display the state of two tracker for this device diff --git a/docs/usage/custom_cards/custom_card_heat_pump.md b/docs/usage/custom_cards/custom_card_heat_pump.md index ad2b5543a..8aaf00082 100644 --- a/docs/usage/custom_cards/custom_card_heat_pump.md +++ b/docs/usage/custom_cards/custom_card_heat_pump.md @@ -24,9 +24,9 @@ Initial release ## Images -![Heat_pump](Heat_pump.PNG) +![Heat_pump](../../assets/img/Heat_pump.PNG) -![Heat_pump_gif](heat_pump.gif) +![Heat_pump_gif](../../assets/img/heat_pump.gif) ## Usage