mirror of
https://github.com/DigiLive/mushroom-strategy.git
synced 2025-08-03 11:34:27 +02:00
Fix Markdown formatting issues
This commit is contained in:
1
.github/PULL_REQUEST_TEMPLATE/translation.md
vendored
1
.github/PULL_REQUEST_TEMPLATE/translation.md
vendored
@@ -26,6 +26,7 @@ Please specify the language you are adding or modifying:
|
|||||||
## Motivation and Context
|
## Motivation and Context
|
||||||
|
|
||||||
Explain why this translation (addition, fix, or update) is needed.
|
Explain why this translation (addition, fix, or update) is needed.
|
||||||
|
|
||||||
- For fixes, please describe the original error.
|
- For fixes, please describe the original error.
|
||||||
- For updates, briefly explain the context of the new strings.
|
- For updates, briefly explain the context of the new strings.
|
||||||
|
|
||||||
|
@@ -60,8 +60,8 @@ Want to get your hands dirty with the code? Awesome! We appreciate all code cont
|
|||||||
cd mushroom-strategy
|
cd mushroom-strategy
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Create a New Branch:** Create a new branch for your feature or bug fix. Use a descriptive name (e.g.,
|
3. **Create a New Branch:** Create a new branch for your feature or bug fix.
|
||||||
`feature/my-awesome-feature`, `bugfix/fix-admonition-rendering`).
|
Use a descriptive name (e.g., `feature/my-awesome-feature`, `bugfix/fix-admonition-rendering`).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git checkout -b feature/my-new-feature
|
git checkout -b feature/my-new-feature
|
||||||
|
15
docs/faq.md
15
docs/faq.md
@@ -1,3 +1,5 @@
|
|||||||
|
# Frequently Asked Questions
|
||||||
|
|
||||||
??? question "How do I add a device or entity to an area?"
|
??? question "How do I add a device or entity to an area?"
|
||||||
|
|
||||||
You can add devices to an area by going to `Settings` found at the bottom of the sidebar.
|
You can add devices to an area by going to `Settings` found at the bottom of the sidebar.
|
||||||
@@ -11,7 +13,8 @@
|
|||||||
!!! warning
|
!!! warning
|
||||||
If you created an entity manually (in your `configuration.yaml`), you may need to create a `unique_id` before
|
If you created an entity manually (in your `configuration.yaml`), you may need to create a `unique_id` before
|
||||||
you can set an area to it.
|
you can set an area to it.
|
||||||
See Home Assistant's [documentation][uniqueIdUrl] for more info about unique ids.
|
See Home Assistant's [documentation](https://www.home-assistant.io/faq/unique_id){: target="_blank"} for more
|
||||||
|
info about unique ids.
|
||||||
|
|
||||||
??? question "How do I hide entities from the Strategy?"
|
??? question "How do I hide entities from the Strategy?"
|
||||||
|
|
||||||
@@ -24,8 +27,8 @@
|
|||||||
|
|
||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
If you don't want to hide the entity from all dashboards, you can use [Card Options][cardOptionsUrl] to hide
|
If you don't want to hide the entity from all dashboards, you can use [Card Options](options/card-options.md)
|
||||||
specific entities and devices.
|
to hide specific entities and devices.
|
||||||
|
|
||||||
??? question "How do I get the id of entities, devices and areas?"
|
??? question "How do I get the id of entities, devices and areas?"
|
||||||
|
|
||||||
@@ -48,9 +51,3 @@
|
|||||||
1. Select `Settings` at the bottom of the sidebar.
|
1. Select `Settings` at the bottom of the sidebar.
|
||||||
2. Select `Areas`.
|
2. Select `Areas`.
|
||||||
3. Select :material-pencil: of the area you want to get the id of.
|
3. Select :material-pencil: of the area you want to get the id of.
|
||||||
|
|
||||||
<!-- references -->
|
|
||||||
|
|
||||||
[uniqueIdUrl]: https://www.home-assistant.io/faq/unique_id
|
|
||||||
|
|
||||||
[cardOptionsUrl]: options/card-options.md
|
|
||||||
|
@@ -2,9 +2,10 @@
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Mushroom dashboard strategy and dependencies are available in [HACS][hacsUrl] (Home Assistant Community Store).
|
Mushroom dashboard strategy and dependencies are available in [HACS][hacsUrl]{: target="_blank"} (Home Assistant
|
||||||
|
Community Store).
|
||||||
Install HACS if you don't have it already.
|
Install HACS if you don't have it already.
|
||||||
For assistance, you can follow the [installation guide][hacsInstallationGuideUrl].
|
For assistance, you can follow the [installation guide][hacsInstallationGuideUrl]{: target="_blank"}.
|
||||||
|
|
||||||
Once you have HACS installed, you can install custom integration and plug-ins.
|
Once you have HACS installed, you can install custom integration and plug-ins.
|
||||||
This guide offers you badges to open your Home Assistant on the correct page.
|
This guide offers you badges to open your Home Assistant on the correct page.
|
||||||
@@ -19,15 +20,16 @@ You need to install the following HACS integrations before you can use this stra
|
|||||||
Click the badges below and follow the installation instructions.
|
Click the badges below and follow the installation instructions.
|
||||||
They will open the HACS repository at your Home Assistant instance directly.
|
They will open the HACS repository at your Home Assistant instance directly.
|
||||||
|
|
||||||
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMushroomUrl] to install [Mushroom][mushroomUrl].
|
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMushroomUrl]{: target="_blank"} to install
|
||||||
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMiniGraphUrl] to
|
[Mushroom][mushroomUrl]{: target="_blank"}.
|
||||||
install [Mini graph card][miniGraphUrl].
|
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMiniGraphUrl]{: target="_blank"} to
|
||||||
|
install [Mini graph card][miniGraphUrl]{: target="_blank"}.
|
||||||
|
|
||||||
## Dashboard Installation
|
## Dashboard Installation
|
||||||
|
|
||||||
If you meet all the prerequisites, click the badge below to install the strategy.
|
If you meet all the prerequisites, click the badge below to install the strategy.
|
||||||
|
|
||||||
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsStrategyUrl]
|
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsStrategyUrl]{: target="_blank"}
|
||||||
|
|
||||||
## Local Installation
|
## Local Installation
|
||||||
|
|
||||||
|
@@ -46,4 +46,3 @@ engage with the community!
|
|||||||
to ❤️ [sponsor the project](https://github.com/sponsors/DigiLive) to support its continued development! Your support
|
to ❤️ [sponsor the project](https://github.com/sponsors/DigiLive) to support its continued development! Your support
|
||||||
helps us grow and improve.
|
helps us grow and improve.
|
||||||
|
|
||||||
// TODO: add contribution and pre-release
|
|
||||||
|
@@ -14,8 +14,8 @@ Each configuration is identified by an area id and can have the following option
|
|||||||
Also, all options from the Template mushroom card and/or Home Assistant Area card are supported.
|
Also, all options from the Template mushroom card and/or Home Assistant Area card are supported.
|
||||||
Please follow the links below to see the additional options per card type.
|
Please follow the links below to see the additional options per card type.
|
||||||
|
|
||||||
* [Mushroom Template Card][templateDocUrl].
|
* [Mushroom Template Card][templateDocUrl]{: target="_blank"}.
|
||||||
* [Home Assistant Area Card][areaDocUrl].
|
* [Home Assistant Area Card][areaDocUrl]{: target="_blank"}.
|
||||||
|
|
||||||
## Extra Cards
|
## Extra Cards
|
||||||
|
|
||||||
|
@@ -18,6 +18,7 @@ In the different views, the cards belonging to a specific domain will be horizon
|
|||||||
The number of cards per row can be configured with this option.
|
The number of cards per row can be configured with this option.
|
||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
|
|
||||||
* Domain `default` represents any other domain than supported by this strategy.
|
* Domain `default` represents any other domain than supported by this strategy.
|
||||||
* The `showControls` option will default to false for domain which can't be controlled.
|
* The `showControls` option will default to false for domain which can't be controlled.
|
||||||
* The `hide_config_entities` and `hide_diagnostic_entities` options are only available as an "All domains" option.
|
* The `hide_config_entities` and `hide_diagnostic_entities` options are only available as an "All domains" option.
|
||||||
|
@@ -85,6 +85,8 @@ You can define a custom entity to use by setting an entity id.
|
|||||||
!!! note
|
!!! note
|
||||||
To hide the weather chip, you should hide or disable the entity itself.
|
To hide the weather chip, you should hide or disable the entity itself.
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
strategy:
|
strategy:
|
||||||
type: custom:mushroom-strategy
|
type: custom:mushroom-strategy
|
||||||
@@ -100,7 +102,7 @@ strategy:
|
|||||||
## Extra Chips
|
## Extra Chips
|
||||||
|
|
||||||
To add custom chips, you can configure them in `extra_chips`.
|
To add custom chips, you can configure them in `extra_chips`.
|
||||||
See [Mushroom Chips][chipDocUrl] for all available chips.
|
See [Mushroom Chips][chipDocUrl]{: target="_blank"} for all available chips.
|
||||||
|
|
||||||
!!! tip
|
!!! tip
|
||||||
You can build your chips in a temporary card in another dashboard and copy the `chips` group from the YAML of that
|
You can build your chips in a temporary card in another dashboard and copy the `chips` group from the YAML of that
|
||||||
|
@@ -43,5 +43,3 @@ strategy:
|
|||||||
icon: mdi:sofa
|
icon: mdi:sofa
|
||||||
icon_color: green
|
icon_color: green
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@@ -51,7 +51,7 @@ views: []
|
|||||||
## Extra Views
|
## Extra Views
|
||||||
|
|
||||||
The `extra_views` group enables you to specify the configuration of additional views.
|
The `extra_views` group enables you to specify the configuration of additional views.
|
||||||
Each view can have the options as described in the [Home Assistant documentation][viewDocUrl].
|
Each view can have the options as described in the [Home Assistant documentation][viewDocUrl]{: target="_blank"}.
|
||||||
|
|
||||||
!!! tip
|
!!! tip
|
||||||
You can build your view in a temporary dashboard and copy the `views` group from the YAML of that dashboard into
|
You can build your view in a temporary dashboard and copy the `views` group from the YAML of that dashboard into
|
||||||
@@ -77,4 +77,3 @@ strategy:
|
|||||||
<!-- references -->
|
<!-- references -->
|
||||||
|
|
||||||
[viewDocUrl]: https://www.home-assistant.io/dashboards/views/#views
|
[viewDocUrl]: https://www.home-assistant.io/dashboards/views/#views
|
||||||
|
|
||||||
|
16
docs/stylesheets/extra.css
Normal file
16
docs/stylesheets/extra.css
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
a[target="_blank"]::after {
|
||||||
|
background-image: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3h-7zM19 19H5V5h7V3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2v-7h-2v7z"/></svg>');
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
background-size: cover;
|
||||||
|
content: "";
|
||||||
|
display: inline-block;
|
||||||
|
height: 0.8em;
|
||||||
|
margin-left: 0.3em;
|
||||||
|
opacity: 0.7;
|
||||||
|
vertical-align: middle;
|
||||||
|
width: 0.8em;
|
||||||
|
}
|
||||||
|
|
||||||
|
[data-md-color-scheme="slate"] a[target="_blank"]::after {
|
||||||
|
filter: invert(100%);
|
||||||
|
}
|
@@ -37,6 +37,9 @@ theme:
|
|||||||
- content.action.edit
|
- content.action.edit
|
||||||
- content.footnote.tooltips
|
- content.footnote.tooltips
|
||||||
|
|
||||||
|
extra_css:
|
||||||
|
- stylesheets/extra.css
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Getting Started:
|
- Getting Started:
|
||||||
|
Reference in New Issue
Block a user