Reformat documentation for consistency

DigiLive · DigiLive · commit 0cbf97b4b635 · 2026-03-28T11:09:46.000+01:00
Updated various documentation files to ensure consistent use of line
breaks and formatting.
This improves readability and maintains a uniform style across all
documents.
diff --git a/docs/contributing/code.md b/docs/contributing/code.md
@@ -9,7 +9,7 @@ Want to get your hands dirty with the code? Awesome! We appreciate all code cont
 3. **Test Your Changes:** Thoroughly test your changes to ensure they work as expected and don't introduce new issues.
 
      - You can build the strategy with `npm run build` (for production) or `npm run build-dev` (for development/testing).
-     - Copy the built files to your Home Assistant's `www/community/mushroom-strategy` directory for testing.  
+     - Copy the built files to your Home Assistant's `www/community/mushroom-strategy` directory for testing.<br>
        **Remember to clear the cache of your Home Assistant client** to see the changes.
 
     !!! info
diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md
@@ -19,7 +19,7 @@ The entire documentation lives in the `docs/` folder of this repository.
     ```
 
     This will usually launch a local server, at `http://127.0.0.1:8000`.
-    The server will automatically reload in your browser as you make and save changes to the documentation files.  
+    The server will automatically reload in your browser as you make and save changes to the documentation files.<br>
     To stop the server, press **Ctrl + C** in the terminal.
 
     !!! note
@@ -49,7 +49,7 @@ The entire documentation lives in the `docs/` folder of this repository.
 
 7. **Format and Lint Your Changes:**
 
-    To keep the documentation clean and consistent, run the linter before committing.  
+    To keep the documentation clean and consistent, run the linter before committing.<br>
     This checks for broken links, formatting issues, and common Markdown errors.
 
     ```bash
@@ -64,23 +64,19 @@ The entire documentation lives in the `docs/` folder of this repository.
 
 10. **Open a Pull Request (PR).**
 
----
-
 ## How Versioning Works
 
 Our documentation uses `mike` to manage multiple versions of the documentation:
 
 - **The main version**: Every time a Pull Request is merged into the main branch, the documentation at /main/ is
-  updated.  
+  updated.<br>
   This represents the "development" or "upcoming" version.
 
 - **The latest version**: This points to the most recent official release.
 
 - **Tagged versions**: When we create a new GitHub Release, a permanent, numbered version (e.g., v1.2.0) is created and
   archived in the version selector.
 
----
-
 ## Documentation Style and Quality
 
 To maintain consistency and quality:
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
@@ -8,10 +8,8 @@ Please take a moment to review this guide before making a contribution.
 ## 📜 Code of Conduct
 
 To ensure a welcoming and inclusive environment, all contributors are expected to adhere to
-our [Code of Conduct](https://github.com/DigiLive/mushroom-strategy/blob/main/CODE_OF_CONDUCT.md). Please read it
-carefully.
-
----
+our [Code of Conduct](https://github.com/DigiLive/mushroom-strategy/blob/main/CODE_OF_CONDUCT.md).<br>
+Please read it carefully.
 
 ## 🐞 Reporting Bugs
 
@@ -31,8 +29,6 @@ Found a bug? That's not ideal, but your report helps us squash it!
    - Screenshots or animated GIFs (if applicable).
    - Your Home Assistant version and Mushroom Strategy version.
 
----
-
 ## ✨ Suggesting Features
 
 Have a great idea for a new feature or enhancement? We'd love to hear it!
@@ -45,8 +41,6 @@ Have a great idea for a new feature or enhancement? We'd love to hear it!
 3. **Describe your idea:** Clearly explain the feature, why you think it's useful, and any potential use cases by
    following the instructions and template.
 
----
-
 ## 🙏 Get Support
 
 If you have questions about contributing or need help with your setup, please open a
diff --git a/docs/contributing/translations.md b/docs/contributing/translations.md
@@ -2,7 +2,7 @@
 
 Help us make Mushroom Strategy accessible to more users around the world by contributing and improving translations!
 
-Language tags have to follow [BCP 47](https://tools.ietf.org/html/bcp47).  
+Language tags have to follow [BCP 47](https://tools.ietf.org/html/bcp47).<br>
 A list of most language tags can be found here:
 [IANA subtag registry](http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
 Examples: fr, fr-CA, zh-Hans.
@@ -20,7 +20,7 @@ Examples: fr, fr-CA, zh-Hans.
 4. **Test Your Changes:** Thoroughly test your changes to ensure they work as expected and don't introduce new issues.
 
      - You can build the strategy with `npm run build` (for production) or `npm run build-dev` (for development/testing).
-     - Copy the built files to your Home Assistant's `www/community/mushroom-strategy` directory for testing.  
+     - Copy the built files to your Home Assistant's `www/community/mushroom-strategy` directory for testing.<br>
        **Remember to clear the cache of your Home Assistant client** to see the changes.
 
     !!! info
@@ -42,8 +42,6 @@ Examples: fr, fr-CA, zh-Hans.
 
 8. **Open a Pull Request (PR).**
 
----
-
 !!! info
 
     **Integrating a new Translation:**
@@ -57,9 +55,9 @@ Examples: fr, fr-CA, zh-Hans.
     If you are adding a country-specific locale (e.g., `es-ES` for Spanish (Spain) or `en-GB` for English 
     (United Kingdom)), you should create a file like `en-GB.json` in the `translations` folder. In 
     `src/utilities/localize.ts`, you'll import it similarly and add it to the `languages` map using the full locale 
-    code.  
+    code.<br>
     Please ensure you follow existing patterns for `language-country` codes, which typically use a hyphen (`-`) + a 
-    UPPER-cased country code in the file name and an underscore (`_`) + a lower-cased country code in the import key.  
+    UPPER-cased country code in the file name and an underscore (`_`) + a lower-cased country code in the import key.<br>
 
     !!! example
         ```typescript
diff --git a/docs/contributing/workflow.md b/docs/contributing/workflow.md
@@ -2,22 +2,20 @@
 
 This guide outlines a common workflow for contributing to our project.
 
----
-
 1. **Fork the Repository**
-   Start by forking **our repository** (the upstream project) to your own GitHub account.  
+   Start by forking **our repository** (the upstream project) to your own GitHub account.<br>
    This creates a personal copy where you can make your changes without affecting the original project directly.
 
 2. **Clone Your Fork**
    Clone your forked repository from your GitHub account to your local machine.
 
 3. **Set Up Your Local Development Environment**
-   Before making changes, ensure your local environment is ready.  
+   Before making changes, ensure your local environment is ready.<br>
    See [Getting Started](getting-started.md).
 
 4. **Make Your Changes**
    Work in a new branch for better organization and easier pull requests and Implement your bug fix, new feature, or
-   documentation update.  
+   documentation update.<br>
    See chapters [Code](code.md), [Documentation](documentation.md), and [Translations](translations.md) for guidance and
    details.
 
@@ -26,11 +24,11 @@ This guide outlines a common workflow for contributing to our project.
    new issues or regressions.
 
 6. **Format and Lint Your Changes**
-   Your code should be well-formatted and linted to ensure consistency and readability.  
+   Your code should be well-formatted and linted to ensure consistency and readability.<br>
    If you've set up the project correctly, the tools for this should already be available to this project.
 
 7. **Commit Your Changes**
-   Stage your changes and commit them with a clear, descriptive message.  
+   Stage your changes and commit them with a clear, descriptive message.<br>
    Aim for a concise subject line followed by a more detailed body if necessary.
    E.g.:
 
diff --git a/docs/faq.md b/docs/faq.md
@@ -12,13 +12,13 @@
 
     !!! 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.  
+        you can set an area to it.<br>
         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?"
 
-    When creating this dashboard for the first time, you might be overwhelmed by the number of entities.  
+    When creating this dashboard for the first time, you might be overwhelmed by the number of entities.<br>
     To reduce the number of entities shown, you can hide these entities by following the steps below:
     
     1. Click and hold the entity.
diff --git a/docs/getting-started/basic-setup.md b/docs/getting-started/basic-setup.md
@@ -31,7 +31,7 @@ To apply the Mushroom Strategy to a dashboard:
          be registered
     ```
 
-This is mainly because of cache issues or HACS didn't create a reference.  
+This is mainly because of cache issues or HACS didn't create a reference.<br>
 Try clearing the cache of your client and/or re-downloading the strategy from HACS.
 
 If it still doesn't work, please consult guide
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -3,25 +3,25 @@
 ## ⚙️ Prerequisites
 
 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.  
+Community Store).<br>
+Install HACS if you don't have it already.<br>
 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.  
+Once you have HACS installed, you can install custom integration and plug-ins.<br>
+This guide offers you badges to open your Home Assistant on the correct page.<br>
 If the badges don't work, try installing from HACS manually:
 
 1. Open HACS in Home Assistant (Usually in the menu on the left side).
 2. At the top, search for the component you want to install.
 3. Select the `three-dot` menu on the right side of the component and select `Download`.
 4. Choose the desired version and select `Download` again.
 
-You need to install the following HACS integrations before you can use this strategy.  
-Click the badges below and follow the installation instructions.  
+You need to install the following HACS integrations before you can use this strategy.<br>
+Click the badges below and follow the installation instructions.<br>
 They will open the HACS repository at your Home Assistant instance directly.
 
 [![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMushroomUrl]{: target="_blank"} to install
-[Mushroom][mushroomUrl]{: target="_blank"}.  
+[Mushroom][mushroomUrl]{: target="_blank"}.<br>
 [![Open in HACS at your Home Assistant instance.][hacsBadge]][hacsMiniGraphUrl]{: target="_blank"} to
 install [Mini graph card][miniGraphUrl]{: target="_blank"}.
 
@@ -33,7 +33,7 @@ If you meet all the prerequisites, click the badge below to install the strategy
 
 ## 🛠️ Local Installation
 
-Please install the strategy with HACS as described above.  
+Please install the strategy with HACS as described above.<br>
 If you require testing a custom build for debug purposes, follow these steps:
 
 1. Build the strategy with `npm build` or `npm build-dev`.
@@ -47,7 +47,7 @@ If you require testing a custom build for debug purposes, follow these steps:
 
 ## 🔄 Updating
 
-By default, Home Assistant will notify you when an update of the strategy is available.  
+By default, Home Assistant will notify you when an update of the strategy is available.<br>
 You can update the strategy by going to `Settings` found at the bottom of the sidebar.
 
 !!! tip
diff --git a/docs/options/area-options.md b/docs/options/area-options.md
@@ -1,6 +1,6 @@
 # 🛋️ Area Options
 
-The `areas` group enables you to specify the configuration of specific areas.  
+The `areas` group enables you to specify the configuration of specific areas.<br>
 Each configuration is identified by an area id and can have the following options:
 
 | Name          | Type           | Default         | Description                                                                |
@@ -11,7 +11,7 @@ Each configuration is identified by an area id and can have the following option
 | `order`       | number         | `unset`         | Ordering position of the area in the list of available areas.              |
 | `type`        | string         | `default`       | Set to a type of area card. (Currently supported: `default` & `HaAreaCard` |
 
-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.<br>
 Please follow the links below to see the additional options per card type.
 
 - [Mushroom Template Card][templateDocUrl]{: target="_blank"}.
@@ -31,7 +31,7 @@ To make the most of this, it helps to understand how the system prioritizes your
 
 ## Extra Cards
 
-The `extra_cards` group enables you to specify the configuration of additional cards an Area view.  
+The `extra_cards` group enables you to specify the configuration of additional cards an Area view.<br>
 These cards will be shown last in the view.
 
 See Home View Options → [Extra Cards](#extra-cards) for more information.
@@ -86,7 +86,7 @@ To exclude this area from the dashboard and views, set its property `hidden` to
 
 ## Setting options for all areas
 
-Use `_` as an identifier to set the options for all areas.  
+Use `_` as an identifier to set the options for all areas.<br>
 The following example sets the type of all area-cards to the one of Home Assistant:
 
 ### Example
diff --git a/docs/options/domain-options.md b/docs/options/domain-options.md
@@ -22,7 +22,7 @@ Mushroom strategy supports several domains to control/view entities of.<br>
 | Sensor        |        160        | State entities for data like temperature, humidity, or power usage. |
 | Other         |        170        | Any other domain not explicitly categorized above.                  |
 
-The `domains` group enables you to specify the configuration of a domain in a view.  
+The `domains` group enables you to specify the configuration of a domain in a view.<br>
 Each configuration is identified by a domain name and can have the following options:
 
 | Option                   | type    | Default           | Description                                                               |
@@ -36,7 +36,7 @@ Each configuration is identified by a domain name and can have the following opt
 | title                    | string  | `domain specific` | Title of the domain in a view.                                            |
 
 [^1]:
-In the different views, the cards belonging to a specific domain will be horizontally stacked into a row.  
+In the different views, the cards belonging to a specific domain will be horizontally stacked into a row.<br>
 The number of cards per row can be configured with this option.
 
 !!! note
diff --git a/docs/options/home-view-options.md b/docs/options/home-view-options.md
@@ -35,10 +35,10 @@ strategy:
 
 ## Stack Count
 
-The `stack_count` option is a map of sections to define the number of cards per row.  
+The `stack_count` option is a map of sections to define the number of cards per row.<br>
 The key of the map is the section, while the value is the number of cards per row.
 
-The `areas` section is a special case, where the value is an array of two numbers.  
+The `areas` section is a special case, where the value is an array of two numbers.<br>
 The first number is the number of default cards per row, while the second number is the number of
 [Home Assistant cards](https://www.home-assistant.io/dashboards/area/) per row.
 
@@ -60,9 +60,9 @@ home_view:
 
 ## Badge Options
 
-Badges are widgets that sit at the top of a panel, above all the cards.  
+Badges are widgets that sit at the top of a panel, above all the cards.<br>
 The mushroom strategy has badges that indicate the number of entities for a specific domain which are in an "active"
-state.  
+state.<br>
 Hidden/Disabled entities are excluded from this count.
 
 - Tapping a badge will set corresponding entities to an "inactive" state.[^1]  
@@ -84,7 +84,7 @@ The `badges` group enables you to specify its configuration of badges.
 | `weather_entity` | string  | `auto`  | Entity id for the weather badge to use.     |
 | `extra_badges`   | array   | `[]`    | List of extra badges to show.               |
 
-If `weather_entity` is set to `auto`, the weather badge uses the first entity of the weather domain it finds.  
+If `weather_entity` is set to `auto`, the weather badge uses the first entity of the weather domain it finds.<br>
 You can define a custom entity to use by setting an entity id.
 
 !!! note
@@ -107,7 +107,7 @@ strategy:
 
 ## Extra Badges
 
-To add custom badges, you can configure them in `extra_badges`.  
+To add custom badges, you can configure them in `extra_badges`.<br>
 See [Mushroom Badges][MushroomBadgeDocUrl]{: target="_blank"} and [Home Assistant Badges][HassBadgeDocUrl]{: target="_blank"}
 
 !!! tip
diff --git a/docs/options/view-options.md b/docs/options/view-options.md
@@ -1,6 +1,6 @@
 # 👀 View Options
 
-Mushroom strategy includes several views to control/view entities of a specific domain.  
+Mushroom strategy includes several views to control/view entities of a specific domain.<br>
 Hidden/Disabled entities or linked to a hidden area are excluded from the view.
 
 The following views are supported and enabled by default:
