diff --git a/Strategy-Options.md b/Strategy-Options.md index 087a7a9..f3fec6b 100644 --- a/Strategy-Options.md +++ b/Strategy-Options.md @@ -1,4 +1,4 @@ -# Strategy options +# Options You can set strategy options to further customize the dashboard. By default, all views are enabled which include lights, fans, covers, switches, climates and cameras. All chips are also @@ -19,7 +19,7 @@ The options available are: | `domains` | object (optional) | All supported domains | See [Supported domains](#supported-domains). | | `homeView` | object (optional) | unset | Options for the home view, see [Home View Options](#home-view-options) | -### Example +#### Example ```yaml strategy: @@ -32,7 +32,7 @@ strategy: icon_color: green views: [] ``` -## Area Object +# Area Object The area object includes all options from the template mushroom card and `extra_cards` which is a list of cards to show at the top of the area subview. @@ -60,7 +60,7 @@ at the top of the area subview. | `type` | string | `default` | Set to a type of area card. (Currently supported: `default` & `HaAreaCard` | *) `more-info` `toggle` `call-service` `navigate` `url` `none` -### Undisclosed Area +## Undisclosed Area The strategy has a special area, named `undisclosed`. This area is enabled by default and includes the entities that aren't linked to any Home Assistant area. @@ -68,7 +68,7 @@ This area is enabled by default and includes the entities that aren't linked to The area can be configured like any other area as described above. To exclude this area from the dashboard and views, set its property `hidden` to `true`. -### Setting options for all areas +## Setting options for all areas Use `_` as an identifier to set the options for all areas. @@ -116,7 +116,7 @@ strategy: views: [] ``` -## Card Options +# Card Options The `card_options` entry enables you to specify a card type for an entity or to hide the card from the dashboard. You can also provide a device ID and hide all entities linked to that device. @@ -139,7 +139,7 @@ strategy: views: [] ``` -## Pre-built views +# Pre-built views ![Light Views](https://github.com/AalianKhan/mushroom-strategy/blob/main/docs/light_view.png) @@ -157,7 +157,7 @@ By default, all pre-built views below are shown: | `climate` | object* | View to control climate devices such as thermostats. Seperated by each area. | | `camera` | object* | View to show all cameras using WebRTC cards. Seperated by each area. | -### View Options +## View Options For each of the pre-built views, the following options are available: @@ -185,7 +185,7 @@ strategy: views: [] ``` -## Domains +# Domains You can configure how the various domains are shown using the `domains` option @@ -231,7 +231,7 @@ The following domains are supported and enabled by default: * number * default (Miscellaneous) -## Home View Options +# Home View Options The `homeView` options will let you configure the Home View. @@ -259,7 +259,7 @@ strategy: views: [] ``` -## Chips +# Chips ![Chips](https://github.com/AalianKhan/mushroom-strategy/blob/main/docs/chips.png)