DigiLive/mushroom-strategy
1
0
Fork 1
mirror of https://github.com/DigiLive/mushroom-strategy.git synced 2025-08-02 19:14:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix Markdown formatting issues

Browse Source
This commit is contained in:
DigiLive
2025-05-26 17:36:13 +02:00
parent 2331e33847
commit 2cf0debbf5
12 changed files with 80 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/PULL_REQUEST_TEMPLATE/translation.md vendored
View File

@@ -26,6 +26,7 @@ Please specify the language you are adding or modifying:
## Motivation and Context
Explain why this translation (addition, fix, or update) is needed.
- For fixes, please describe the original error.
- For updates, briefly explain the context of the new strings.

4
docs/contributing.md
View File

@@ -60,8 +60,8 @@ Want to get your hands dirty with the code? Awesome! We appreciate all code cont
cd mushroom-strategy
```
3. **Create a New Branch:** Create a new branch for your feature or bug fix. Use a descriptive name (e.g.,
`feature/my-awesome-feature`, `bugfix/fix-admonition-rendering`).
3. **Create a New Branch:** Create a new branch for your feature or bug fix.
Use a descriptive name (e.g., `feature/my-awesome-feature`, `bugfix/fix-admonition-rendering`).
```bash
git checkout -b feature/my-new-feature

15
docs/faq.md
View File

@@ -1,3 +1,5 @@
# Frequently Asked Questions
??? 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.
@@ -11,7 +13,8 @@
!!! warning
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.
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?"
@@ -24,8 +27,8 @@
!!! note
If you don't want to hide the entity from all dashboards, you can use [Card Options][cardOptionsUrl] to hide
specific entities and devices.
If you don't want to hide the entity from all dashboards, you can use [Card Options](options/card-options.md)
to hide specific entities and devices.
??? 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.
2. Select `Areas`.
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

14
docs/getting-started/installation.md
View File

@@ -2,9 +2,10 @@
## 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.
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.
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.
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]][hacsMiniGraphUrl] to
install [Mini graph card][miniGraphUrl].
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMushroomUrl]{: target="_blank"} to install
[Mushroom][mushroomUrl]{: target="_blank"}.
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMiniGraphUrl]{: target="_blank"} to
install [Mini graph card][miniGraphUrl]{: target="_blank"}.
## Dashboard Installation
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

1
docs/index.md
View File

@@ -46,4 +46,3 @@ engage with the community!
to ❤️ [sponsor the project](https://github.com/sponsors/DigiLive) to support its continued development! Your support
helps us grow and improve.
// TODO: add contribution and pre-release

4
docs/options/area-options.md
View File

@@ -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.
Please follow the links below to see the additional options per card type.
* [Mushroom Template Card][templateDocUrl].
* [Home Assistant Area Card][areaDocUrl].
* [Mushroom Template Card][templateDocUrl]{: target="_blank"}.
* [Home Assistant Area Card][areaDocUrl]{: target="_blank"}.
## Extra Cards

1
docs/options/domain-options.md
View File

@@ -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.
!!! note
* 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 `hide_config_entities` and `hide_diagnostic_entities` options are only available as an "All domains" option.

4
docs/options/home-view-options.md
View File

@@ -85,6 +85,8 @@ You can define a custom entity to use by setting an entity id.
!!! note
To hide the weather chip, you should hide or disable the entity itself.
### Example
```yaml
strategy:
type: custom:mushroom-strategy
@@ -100,7 +102,7 @@ strategy:
## 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
You can build your chips in a temporary card in another dashboard and copy the `chips` group from the YAML of that

2
docs/options/index.md
View File

@@ -43,5 +43,3 @@ strategy:
icon: mdi:sofa
icon_color: green
```

3
docs/options/view-options.md
View File

@@ -51,7 +51,7 @@ views: []
## Extra 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
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 -->
[viewDocUrl]: https://www.home-assistant.io/dashboards/views/#views

16
docs/stylesheets/extra.css Normal file
View 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%);
}

3
mkdocs.yml
View File

@@ -37,6 +37,9 @@ theme:
- content.action.edit
- content.footnote.tooltips
extra_css:
- stylesheets/extra.css
nav:
- Home: index.md
- Getting Started: