Skip to content

Commit 2cf0deb

Browse files
committed
Fix Markdown formatting issues
1 parent 2331e33 commit 2cf0deb

File tree

12 files changed

+80
-62
lines changed

12 files changed

+80
-62
lines changed

.github/PULL_REQUEST_TEMPLATE/translation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Please specify the language you are adding or modifying:
2626
## Motivation and Context
2727

2828
Explain why this translation (addition, fix, or update) is needed.
29+
2930
- For fixes, please describe the original error.
3031
- For updates, briefly explain the context of the new strings.
3132

docs/contributing.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -55,50 +55,50 @@ Want to get your hands dirty with the code? Awesome! We appreciate all code cont
5555
account.
5656
2. **Clone Your Fork:** Clone your forked repository to your local machine.
5757

58-
```bash
59-
git clone https://github.com/YOUR_USERNAME/mushroom-strategy.git
60-
cd mushroom-strategy
61-
```
58+
```bash
59+
git clone https://github.com/YOUR_USERNAME/mushroom-strategy.git
60+
cd mushroom-strategy
61+
```
6262

63-
3. **Create a New Branch:** Create a new branch for your feature or bug fix. Use a descriptive name (e.g.,
64-
`feature/my-awesome-feature`, `bugfix/fix-admonition-rendering`).
63+
3. **Create a New Branch:** Create a new branch for your feature or bug fix.
64+
Use a descriptive name (e.g., `feature/my-awesome-feature`, `bugfix/fix-admonition-rendering`).
6565

66-
```bash
67-
git checkout -b feature/my-new-feature
68-
```
66+
```bash
67+
git checkout -b feature/my-new-feature
68+
```
6969

7070
4. **Set up Development Environment:**
7171

72-
* Ensure you have Node.js and npm installed.
73-
* Install project dependencies: `npm install`
74-
* You can build the strategy with `npm run build` (for production) or `npm run build-dev` (for development/testing).
75-
* Copy the built files to your Home Assistant's `www/community/mushroom-strategy` folder for testing.
72+
* Ensure you have Node.js and npm installed.
73+
* Install project dependencies: `npm install`
74+
* You can build the strategy with `npm run build` (for production) or `npm run build-dev` (for development/testing).
75+
* Copy the built files to your Home Assistant's `www/community/mushroom-strategy` folder for testing.
7676

7777
5. **Make Your Changes:** Implement your bug fix or new feature.
7878
6. **Test Your Changes:** Thoroughly test your changes to ensure they work as expected and don't introduce new issues.
7979
7. **Commit Your Changes:**
8080

81-
* We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for clear commit history.
82-
* Example: `feat: add new card option` or `fix: correct card rendering issue`
81+
* We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for clear commit history.
82+
* Example: `feat: add new card option` or `fix: correct card rendering issue`
8383

84-
```bash
85-
git add .
86-
git commit -m "feat: add super cool new feature"
87-
```
84+
```bash
85+
git add .
86+
git commit -m "feat: add super cool new feature"
87+
```
8888

8989
8. **Push to Your Fork:**
9090

91-
```bash
92-
git push origin feature/my-new-feature
93-
```
91+
```bash
92+
git push origin feature/my-new-feature
93+
```
9494

9595
9. **Create a Pull Request (PR):**
9696

97-
* Go to your forked repository on GitHub.
98-
* You should see a prompt to create a pull request from your new branch to the `main` branch of
99-
`DigiLive/mushroom-strategy`.
100-
* Provide a clear title and description for your PR, referencing any related issues.
101-
* Be prepared to discuss your changes and address any feedback during the review process.
97+
* Go to your forked repository on GitHub.
98+
* You should see a prompt to create a pull request from your new branch to the `main` branch of
99+
`DigiLive/mushroom-strategy`.
100+
* Provide a clear title and description for your PR, referencing any related issues.
101+
* Be prepared to discuss your changes and address any feedback during the review process.
102102

103103
---
104104

@@ -123,10 +123,10 @@ Examples: fr, fr-CA, zh-Hans.
123123
Each language has its own `locale.json` file (e.g., `en.json`, `nl.json`, `pt-BR.json`).
124124
3. **Create or Update:**
125125

126-
* **To create a new language:** Copy an existing `.json` file (e.g., `en.json`), rename it to your language
127-
code (e.g., `de.json` for German), and translate the property values.
128-
* **To update an existing language:** Open the `.json` file for your language and update any missing or
129-
outdated translations.
126+
* **To create a new language:** Copy an existing `.json` file (e.g., `en.json`), rename it to your language
127+
code (e.g., `de.json` for German), and translate the property values.
128+
* **To update an existing language:** Open the `.json` file for your language and update any missing or
129+
outdated translations.
130130

131131
4. **Submit a Pull Request:** Once your translations are complete, submit a pull request with your changes. Clearly
132132
state which language you are contributing to or updating.
@@ -154,8 +154,8 @@ Examples: fr, fr-CA, zh-Hans.
154154
155155
/** Registry of currently supported languages */
156156
const languages: Record<string, unknown> = {
157-
en,
158-
'pt-BR': pt_br,
157+
en,
158+
'pt-BR': pt_br,
159159
};
160160
```
161161

docs/faq.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Frequently Asked Questions
2+
13
??? question "How do I add a device or entity to an area?"
24

35
You can add devices to an area by going to `Settings` found at the bottom of the sidebar.
@@ -8,10 +10,11 @@
810
4. Select :material-pencil: or :material-cog: in the top right corner.
911
5. Choose an area in the area field.
1012

11-
!!! warning
13+
!!! warning
1214
If you created an entity manually (in your `configuration.yaml`), you may need to create a `unique_id` before
1315
you can set an area to it.
14-
See Home Assistant's [documentation][uniqueIdUrl] for more info about unique ids.
16+
See Home Assistant's [documentation](https://www.home-assistant.io/faq/unique_id){: target="_blank"} for more
17+
info about unique ids.
1518

1619
??? question "How do I hide entities from the Strategy?"
1720

@@ -24,8 +27,8 @@
2427

2528

2629
!!! note
27-
If you don't want to hide the entity from all dashboards, you can use [Card Options][cardOptionsUrl] to hide
28-
specific entities and devices.
30+
If you don't want to hide the entity from all dashboards, you can use [Card Options](options/card-options.md)
31+
to hide specific entities and devices.
2932

3033
??? question "How do I get the id of entities, devices and areas?"
3134

@@ -48,9 +51,3 @@
4851
1. Select `Settings` at the bottom of the sidebar.
4952
2. Select `Areas`.
5053
3. Select :material-pencil: of the area you want to get the id of.
51-
52-
<!-- references -->
53-
54-
[uniqueIdUrl]: https://www.home-assistant.io/faq/unique_id
55-
56-
[cardOptionsUrl]: options/card-options.md

docs/getting-started/installation.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
## Prerequisites
44

5-
Mushroom dashboard strategy and dependencies are available in [HACS][hacsUrl] (Home Assistant Community Store).
5+
Mushroom dashboard strategy and dependencies are available in [HACS][hacsUrl]{: target="_blank"} (Home Assistant
6+
Community Store).
67
Install HACS if you don't have it already.
7-
For assistance, you can follow the [installation guide][hacsInstallationGuideUrl].
8+
For assistance, you can follow the [installation guide][hacsInstallationGuideUrl]{: target="_blank"}.
89

910
Once you have HACS installed, you can install custom integration and plug-ins.
1011
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
1920
Click the badges below and follow the installation instructions.
2021
They will open the HACS repository at your Home Assistant instance directly.
2122

22-
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMushroomUrl] to install [Mushroom][mushroomUrl].
23-
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMiniGraphUrl] to
24-
install [Mini graph card][miniGraphUrl].
23+
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMushroomUrl]{: target="_blank"} to install
24+
[Mushroom][mushroomUrl]{: target="_blank"}.
25+
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMiniGraphUrl]{: target="_blank"} to
26+
install [Mini graph card][miniGraphUrl]{: target="_blank"}.
2527

2628
## Dashboard Installation
2729

2830
If you meet all the prerequisites, click the badge below to install the strategy.
2931

30-
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsStrategyUrl]
32+
[![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsStrategyUrl]{: target="_blank"}
3133

3234
## Local Installation
3335

@@ -38,15 +40,15 @@ If you require testing a custom build for debug purposes, follow these steps:
3840
2. Copy the build file(s) to folder `<your-hass-directory>/www/community/mushroom-strategy`.
3941
3. If file `mushroom-strategy.js.gz` exists in that folder, rename or delete it.
4042

41-
!!! note
43+
!!! note
4244
Refresh the cache of the client you use to access Home Assistant.
4345

4446
## Updating
4547

4648
By default, Home Assistant will notify you when an update of the strategy is available.
4749
You can update the strategy by going to `Settings` found at the bottom of the sidebar.
4850

49-
!!! tip
51+
!!! tip
5052
You can enable notifications of pre-releases.
5153

5254
* Go to `Settings` > `Devices & services` > `Entities`.

docs/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,3 @@ engage with the community!
4646
to ❤️ [sponsor the project](https://github.com/sponsors/DigiLive) to support its continued development! Your support
4747
helps us grow and improve.
4848

49-
// TODO: add contribution and pre-release

docs/options/area-options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Each configuration is identified by an area id and can have the following option
1414
Also, all options from the Template mushroom card and/or Home Assistant Area card are supported.
1515
Please follow the links below to see the additional options per card type.
1616

17-
* [Mushroom Template Card][templateDocUrl].
18-
* [Home Assistant Area Card][areaDocUrl].
17+
* [Mushroom Template Card][templateDocUrl]{: target="_blank"}.
18+
* [Home Assistant Area Card][areaDocUrl]{: target="_blank"}.
1919

2020
## Extra Cards
2121

docs/options/domain-options.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ In the different views, the cards belonging to a specific domain will be horizon
1818
The number of cards per row can be configured with this option.
1919

2020
!!! note
21-
* Domain `default` represents any other domain than supported by this strategy.
22-
* The `showControls` option will default to false for domain which can't be controlled.
23-
* The `hide_config_entities` and `hide_diagnostic_entities` options are only available as an "All domains" option.
21+
22+
* Domain `default` represents any other domain than supported by this strategy.
23+
* The `showControls` option will default to false for domain which can't be controlled.
24+
* The `hide_config_entities` and `hide_diagnostic_entities` options are only available as an "All domains" option.
2425

2526
---
2627

docs/options/home-view-options.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ You can define a custom entity to use by setting an entity id.
8585
!!! note
8686
To hide the weather chip, you should hide or disable the entity itself.
8787

88+
### Example
89+
8890
```yaml
8991
strategy:
9092
type: custom:mushroom-strategy
@@ -100,7 +102,7 @@ strategy:
100102
## Extra Chips
101103

102104
To add custom chips, you can configure them in `extra_chips`.
103-
See [Mushroom Chips][chipDocUrl] for all available chips.
105+
See [Mushroom Chips][chipDocUrl]{: target="_blank"} for all available chips.
104106

105107
!!! tip
106108
You can build your chips in a temporary card in another dashboard and copy the `chips` group from the YAML of that

docs/options/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,3 @@ strategy:
4343
icon: mdi:sofa
4444
icon_color: green
4545
```
46-
47-

docs/options/view-options.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ views: []
5151
## Extra Views
5252
5353
The `extra_views` group enables you to specify the configuration of additional views.
54-
Each view can have the options as described in the [Home Assistant documentation][viewDocUrl].
54+
Each view can have the options as described in the [Home Assistant documentation][viewDocUrl]{: target="_blank"}.
5555

5656
!!! tip
5757
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:
7777
<!-- references -->
7878

7979
[viewDocUrl]: https://www.home-assistant.io/dashboards/views/#views
80-

0 commit comments

Comments
 (0)