[CODESPELL] Added codespell

mdb17 · Jul 29, 2022 · 005c2b3 · 005c2b3
1 parent cfc6957
commit 005c2b3
Show file tree

Hide file tree

Showing 31 changed files with 72 additions and 49 deletions.
diff --git a/.codespell b/.codespell
@@ -0,0 +1 @@
+# list of words ignored by codespell
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,4 @@
+[codespell]
+skip = *.svg
+count =
+quiet-level = 3
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -0,0 +1,18 @@
+---
+name: "Codespell"
+
+on:
+  pull_request:
+    branches: ["main", "release"]
+
+jobs:
+  codespell:
+    name: "Check for spelling errors"
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "⤵️ Check out code from GitHub"
+        uses: "actions/checkout@v2"
+      - uses: codespell-project/actions-codespell@master
+        with:
+          ignore_words_list: .codespell
+          config: .codespellrc
diff --git a/docs/assets/logos/Minimalist UI Logo.svg b/docs/assets/logos/Minimalist UI Logo.svg
diff --git a/docs/development/card_style_guide.md b/docs/development/card_style_guide.md
@@ -48,7 +48,7 @@ At the top of each page you can find the `chips`, which allow to quickly visuali
 In the list above #5 enhances the normal `cards` with a "second line", that is used to display other information like a graph or the controls for your covers. For this readme the `cards` are divided into three groups:
 
 - 1-line cards: These are cards for `sensor` or `binary_sensors` like *light* or *power outlets*.
-- 2-line cards: These are cards with a second line for informations or controls, eg. your `cover controls`.
+- 2-line cards: These are cards with a second line for information or controls, eg. your `cover controls`.
 - Custom cards: These are special cards, that you can install, only if needed. These cards are mostly developed and contributed to the repository. Eg. an `aircondition-card` that shows the state of your aircondition and buttons to control it.
 
 #### Color Scheme
@@ -94,12 +94,12 @@ Sometimes the language specific strings from Home Assistant aren't available for
 ### Custom cards
 
 This "theme" is designed with an open structure in mind, that's why it is possible to add `custom-cards` without much hassle. A few `custom-cards` are readily available through the folder `custom-cards` in the repository.
-`Custom-cards` are `cards`, that don't fit everywhere and therefor are not part of the standard installation, but can be easily added, if needed. Take an air-condition card. Not everybody has an air-condition. So why include this `card` as a default? And that's why we did a structure and system for `custom-cards`. Easily added, but only when needed!
+`Custom-cards` are `cards`, that don't fit everywhere and therefore are not part of the standard installation, but can be easily added, if needed. Take an air-condition card. Not everybody has an air-condition. So why include this `card` as a default? And that's why we did a structure and system for `custom-cards`. Easily added, but only when needed!
 And the best thing is: everybody can develop a cool `card` and can (not have to) share it afterwards with the community (hint, hint, the support thread is [here](https://community.home-assistant.io/t/lovelace-ui-minimalist/322687)).
 
 See a complete list of already included `custom-cards` in our [wiki](https://ui-lovelace-minimalist.github.io/UI/usage/custom_cards/custom_card_bar_card/).
 
-Find informations on how to develop a `custom-card` [here](https://ui-lovelace-minimalist.github.io/UI/development/custom_cards/).
+Find information on how to develop a `custom-card` [here](https://ui-lovelace-minimalist.github.io/UI/development/custom_cards/).
 
 ### Extend with your own code
 

diff --git a/docs/development/custom_cards.md b/docs/development/custom_cards.md
@@ -83,7 +83,7 @@ custom_card_paddy_temperature
 
 ### Order
 
-To make reading the definitions easier, we use the following structure in our defintions in button_card_templates.yaml:
+To make reading the definitions easier, we use the following structure in our definitions in button_card_templates.yaml:
 
 ```yaml
 name:
@@ -115,7 +115,7 @@ name:
         template:
 ```
 
-Feel free to delete defintions, that you don’t use or need.
+Feel free to delete definitions, that you don’t use or need.
 
 !!! info ""
 

diff --git a/docs/development/docs_style_guide.md b/docs/development/docs_style_guide.md
@@ -58,7 +58,7 @@ Images, including screenshots, can help a reader better understand a concept. Ho
 
 #### Add the image link to content
 
-The Markdown code for including an image in a document is `![Image description which will be teh alt tag](../../assets/img/ulm_cards/example.png)`
+The Markdown code for including an image in a document is `![Image description which will be the alt tag](../../assets/img/ulm_cards/example.png)`
 
 ### Admonitions / Call-outs
 

diff --git a/docs/index.md b/docs/index.md
@@ -42,7 +42,7 @@ This is a living project and all input is very welcome! If you configured and de
 - A lot of inspiration is taken from [7ahang’s work](https://www.behance.net/gallery/88433905/Redesign-Smart-Home) found on Behance.
 - Contributions from others in the HomeAssistant forum thread, you can find it here.
 - The technical part is realised mostly by taking advantage of the great work RomRaider did with his [button-card](https://github.com/custom-cards/button-card).
-- Code refactor, cleanup and maintainance by [schumijo](https://github.com/schumijo) and [paddy0174](https://github.com/Paddy0174) & [CM000n](https://github.com/CM000n).
+- Code refactor, cleanup and maintenance by [schumijo](https://github.com/schumijo) and [paddy0174](https://github.com/Paddy0174) & [CM000n](https://github.com/CM000n).
 - [dwainscheeren](https://github.com/dwainscheeren) for his inspiration to deliver themes via HACS.
 - Wiki by [paddy0174](https://github.com/Paddy0174).
 - Special thanks to clemalex and [schumijo](https://github.com/schumijo)for contributing their cards to the main repository.

diff --git a/docs/setup/adaptive_dash.md b/docs/setup/adaptive_dash.md
@@ -82,7 +82,7 @@ The best place to start adding your personal cards is in `adaptive-dash/views/ma
 
     All files use CSS grids. By giving each card an own grid-area we can control there place in the dashboard. For more information on how `grid-areas` do work check this [amazing guide](https://css-tricks.com/snippets/css/complete-guide-grid/).
 
-When you are familiar with CSS grids you can start to alter the `grid-template-areas` to your personal perference.
+When you are familiar with CSS grids you can start to alter the `grid-template-areas` to your personal preference.
 
 ### Adding Cards
 
@@ -106,7 +106,7 @@ To put card_light to the area: `card1`; you have to paste in the code as in your
 ```
 
 ```yaml
-# Example of a card_light assiged to area card1
+# Example of a card_light assigned to area card1
 - view_layout:
     grid-area: "card1"
   type: "custom:button-card"
@@ -165,7 +165,7 @@ states:
       ulm_popup_light_entity: "<your_entity>"
 ```
 
-You can also add any other card by copying its yaml code in without the hypen `(-)`
+You can also add any other card by copying its yaml code in without the hyphen `(-)`
 
 ```yaml
 states:

diff --git a/docs/setup/custom_actions.md b/docs/setup/custom_actions.md
@@ -37,7 +37,7 @@ Possible values for each variables are :
 | more-info  | Display more-info window                                                                                                        |
 | popup      | Display UI LOVELACE MINIMALIST popup if available and enabled on card (if not `more-info` action is used)                       |
 | adaptive   | Switch UI LOVELACE MINIMALIST popup on adaptive dashboard<br> if current dashboard is adaptive (if not `popup` action is used)  |
-| navigate   | Navigate to an other UI LOVELACE MINIMALIST view. Need additionnal variable (see below)                                         |
+| navigate   | Navigate to an other UI LOVELACE MINIMALIST view. Need additional variable (see below)                                         |
 
 !!! tip "Reloading"
 

diff --git a/docs/setup/customizing.md b/docs/setup/customizing.md
@@ -6,7 +6,7 @@ hide:
 
 <!-- markdownlint-disable MD046 -->
 
-When you have finished the installation process succesfully it's time to start customizing your dashboard.
+When you have finished the installation process successfully it's time to start customizing your dashboard.
 You can find your ui-minimalist-lovelace file here:
 
 ```yaml

diff --git a/docs/setup/download.md b/docs/setup/download.md
@@ -10,7 +10,7 @@ Before get started on anything, make sure you have created a backup of your home
 
 You can install this UI Lovelace Minimalist Theme manual or through HACS.
 
-You should have a HomeAssistant (HA) instance running, preferrably with [HACS](https://hacs.xyz/) installed and you should know the basics in using HA, eg. how to change settings in your `lovelace` configuration.
+You should have a HomeAssistant (HA) instance running, preferably with [HACS](https://hacs.xyz/) installed and you should know the basics in using HA, eg. how to change settings in your `lovelace` configuration.
 
 You have access to your `config` folder of HA. Doesn’t matter which way this is, but you need to be able to upload and change files in your config. If you’re running `HA-OS` or a `supervised install` of HA, we highly recommend the [Samba AddOn](https://www.home-assistant.io/common-tasks/supervised/#installing-and-using-the-samba-add-on) (see the AddOn page for instructions) and for editing the File editor AddOn or a good editor like [Notepad++](https://notepad-plus-plus.org/) or [SublimeText](https://www.sublimetext.com/) for your OS.
 

diff --git a/docs/setup/installation.md b/docs/setup/installation.md
@@ -8,7 +8,7 @@ hide:
 
 ## Install Integration
 
-Open your Home Assistant instance and start setting up "UI Lovelace Minimalist" under "Configuration" --> "Devices & Services". Or you can use the My Home Assistant Button bellow.
+Open your Home Assistant instance and start setting up "UI Lovelace Minimalist" under "Configuration" --> "Devices & Services". Or you can use the My Home Assistant Button below.
 
 !!! danger "Unsaved Settings"
 

diff --git a/docs/troubleshooting/troubleshooting.md b/docs/troubleshooting/troubleshooting.md
@@ -26,7 +26,7 @@ This is done by:
 
 ??? info "Custom element doesn't exist"
 
-    1. Check if you did install all [depencies](https://ui-lovelace-minimalist.github.io/UI/setup/download/#prerequisites_1) or checked the box to let UI-Minimalist them.
+    1. Check if you did install all [dependencies](https://ui-lovelace-minimalist.github.io/UI/setup/download/#prerequisites_1) or checked the box to let UI-Minimalist them.
     2. Clear your cache by clicking `CTRL + F5` on Windows or `SHIFT + reload` on Mac
 
 ??? info "Popups do not show up"

diff --git a/docs/usage/cards/card_cover.md b/docs/usage/cards/card_cover.md
@@ -11,10 +11,10 @@ hide:
 ![example-image](../../assets/img/ulm_cards/card_cover_controls.png){ width="500" }
 ![example-image](../../assets/img/ulm_cards/card_cover_horizontal.png){ width="500" }
 
-With the `cover-card` you have the state of your cover. Optionnaly, on the second line, OPEN / PAUSE / CLOSE to control it and/or a slider to control position.
+With the `cover-card` you have the state of your cover. Optionally, on the second line, OPEN / PAUSE / CLOSE to control it and/or a slider to control position.
 
 !!! warning
-    This card has backward compatibilty with older template except custom name. It means variable `ulm_card_cover_buttons_name` must be replaced by `ulm_card_cover_name`.
+    This card has backward compatibility with older template except custom name. It means variable `ulm_card_cover_buttons_name` must be replaced by `ulm_card_cover_name`.
 
 ## Variables
 

diff --git a/docs/usage/cards/card_graph.md b/docs/usage/cards/card_graph.md
@@ -16,13 +16,13 @@ The `card_graph` shows an entity with the actual state and a *min-graph-card* in
 | Variable | Default | Required         | Notes             |
 |----------|---------|------------------|-------------------|
 | entity      |         | :material-check: | Your entity_id for the temperature sensor |
-| ulm_card_graph_color     |         | :material-close: | This is to adjust your color value. Use a CSS varible from HA or set a color value (eg. #FFFFFF) |
+| ulm_card_graph_color     |         | :material-close: | This is to adjust your color value. Use a CSS variable from HA or set a color value (eg. #FFFFFF) |
 | ulm_card_graph_name      |         | :material-close: | Enable background |
 | ulm_card_graph_icon    |         | :material-close: | Set custom icon |
 | ulm_card_graph_entity      |         | :material-check: | Your entity_id for the temperature sensor |
 | ulm_card_graph_entity2      |         | :material-close: | Your entity_id for the second temperature sensor |
-| ulm_card_graph_color2      |         | :material-close: | This is to adjust your color value of the second graph. Use a CSS varible from HA or set a color value (eg. #FFFFFF) |
-| ulm_card_graph_type      | fill | :material-close: | This is to change the appearence of the graph. Default is fill, but line, bar are valid options. |
+| ulm_card_graph_color2      |         | :material-close: | This is to adjust your color value of the second graph. Use a CSS variable from HA or set a color value (eg. #FFFFFF) |
+| ulm_card_graph_type      | fill | :material-close: | This is to change the appearance of the graph. Default is fill, but line, bar are valid options. |
 | ulm_card_graph_hours      |  24 | :material-close: | How much time should the graph cover, default is 24 hours. |
 | ulm_card_graph_points      | 0.5 | :material-close: | Specify amount of data points the graph should display for each hour. A larger number results in a more detailed graph. |
 

diff --git a/docs/usage/cards/card_light.md b/docs/usage/cards/card_light.md
@@ -28,7 +28,7 @@ This card merges the following one :
 - custom `card_light_slider_collapse_color` by basbruss
 
 !!! warning
-This card has backward compatibilty with older template except custom names and icons. It means variables like `ulm_card_XXX_name` and `ulm_card_XXX_icon` must be replaced by `ulm_card_light_name` and `ulm_card_light_icon`.
+This card has backward compatibility with older template except custom names and icons. It means variables like `ulm_card_XXX_name` and `ulm_card_XXX_icon` must be replaced by `ulm_card_light_name` and `ulm_card_light_icon`.
 To use `popup_light` you need to set the variable `ulm_card_light_enable_popup` to `true`. This is a different approach as the other `popup_cards` use.
 
 ## Variables

diff --git a/docs/usage/cards/card_media_player.md b/docs/usage/cards/card_media_player.md
@@ -25,8 +25,8 @@ hide:
 | ulm_card_media_player_name                   |         |                  | Name to display for your media-player           |
 | ulm_card_media_player_icon                   |         |                  | Change the icon displayed                       |
 | ulm_card_media_player_enable_art             | false   |                  | Enable album picture on background              |
-| ulm_card_media_player_enable_controls        | false   |                  | Enable controls bellow the title                |
-| ulm_card_media_player_enable_volume_slider   | false   |                  | Enable volume slider bellow controls            |
+| ulm_card_media_player_enable_controls        | false   |                  | Enable controls below the title                |
+| ulm_card_media_player_enable_volume_slider   | false   |                  | Enable volume slider below controls            |
 | ulm_card_media_player_collapsible            | false   |                  | Controls are collapsible when state is off      |
 | ulm_card_media_player_player_controls_entity | entity  |                  | Change the controlled entity                    |
 | ulm_card_media_player_enable_popup           | false   |                  | Enable pop-up                                   |

diff --git a/docs/usage/cards/card_thermostat.md b/docs/usage/cards/card_thermostat.md
@@ -25,7 +25,7 @@ This card merges the following one :
 - custom `custom_card_httpedo13_thermostat_with_buttons_collapse` by httpedo13
 
 !!! warning
-    This card has backward compatibilty with older template except custom names and icons. It means variables like `ulm_card_XXX_name` and `ulm_card_XXX_icon` must be replaced by `ulm_card_thermostat_name` and `ulm_card_thermostat_icon`.
+    This card has backward compatibility with older template except custom names and icons. It means variables like `ulm_card_XXX_name` and `ulm_card_XXX_icon` must be replaced by `ulm_card_thermostat_name` and `ulm_card_thermostat_icon`.
     To use `popup_thermostat` you need to set the variable `ulm_card_thermostat_enable_popup` to `true`. This is a different approach as the other `popup_cards` use.
 
 ## Variables
@@ -42,7 +42,7 @@ This card merges the following one :
 | ulm_card_thermostat_enable_display_temperature  | `false`           | :material-close: | Display  current temperature on top right | |
 | ulm_card_thermostat_enable_horizontal           | `false`           | :material-close: | Enable horizontal card| Need `ulm_card_thermostat_enable_controls: true` |
 | ulm_card_thermostat_enable_popup                | `false`           | :material-close: | Enable `popup_thermostat` | |
-| ulm_card_thermostat_fan_entity                  | `null`            | :material-close: | `fan` entity for climate if seperate entity | |
+| ulm_card_thermostat_fan_entity                  | `null`            | :material-close: | `fan` entity for climate if separate entity | |
 | ulm_card_thermostat_minimum_temp_spread         | `1`               | :material-close: | Minimum temperature spread between low and high temperature when in `heat_cool` mode | |
 
 ## Usage

diff --git a/docs/usage/cards/card_title.md b/docs/usage/cards/card_title.md
@@ -9,7 +9,7 @@ hide:
 
 ![example-image](../../assets/img/ulm_cards/card_title.png){ width="500" }
 
-Titles (and optionally subtitles) are used to seperate different areas in your design. You can use only a title, only a subtitle or both at once.
+Titles (and optionally subtitles) are used to separate different areas in your design. You can use only a title, only a subtitle or both at once.
 
 ## Variables
 

diff --git a/docs/usage/cards/card_vertical_button.md b/docs/usage/cards/card_vertical_button.md
@@ -9,11 +9,11 @@ hide:
 
 ![example-image](../../assets/img/ulm_cards/card_example.png){ width="500" }
 
-Card `card_vertical_button` can be used in different ways. The primary usage is to switch between scenes or toggle a scene on/off. The seconday use is to toggle a switch or light. It's intended to be used with helper entities, either [input_select](https://www.home-assistant.io/integrations/input_select/) or [input_booelan](https://www.home-assistant.io/integrations/input_boolean/).
+Card `card_vertical_button` can be used in different ways. The primary usage is to switch between scenes or toggle a scene on/off. The secondary use is to toggle a switch or light. It's intended to be used with helper entities, either [input_select](https://www.home-assistant.io/integrations/input_select/) or [input_booelan](https://www.home-assistant.io/integrations/input_boolean/).
 
 You connect the card to either an input_select (toggle between scenes) or input_boolean (toggle one scene) and the button will change the state of these entities. The final step is to create an automation that triggers on the state change and then runs the actions you want, apply a scene or interact with other entities.
 
-The variable `ulm_card_vertical_button_state` needs to be used togehter with input_select to tie a specific state to the button.
+The variable `ulm_card_vertical_button_state` needs to be used together with input_select to tie a specific state to the button.
 
 ## Variables
 

diff --git a/docs/usage/cards/card_weather.md b/docs/usage/cards/card_weather.md
@@ -11,7 +11,7 @@ hide:
 ![example-image](../../assets/img/ulm_cards/card_weather.png){ width="500" }
 
 This is a card based on simple-weather-card to show your weather.
-[simple-weather-card](https://github.com/kalkih/simple-weather-card) lovelace ressources must be installed for this one!
+[simple-weather-card](https://github.com/kalkih/simple-weather-card) lovelace resources must be installed for this one!
 
 ## Variables
 

diff --git a/docs/usage/chips/chip_back.md b/docs/usage/chips/chip_back.md
@@ -10,7 +10,7 @@ hide:
 
 ![example-image](../../assets/img/ulm_chips/chip_back.png){ width="500" }
 
-This is a `back-button`, primarly used if you switch between views and want a convenient way back.
+This is a `back-button`, primarily used if you switch between views and want a convenient way back.
 
 ## Variables
 

diff --git a/docs/usage/custom_cards/custom_card_mpse_gauge.md b/docs/usage/custom_cards/custom_card_mpse_gauge.md
@@ -8,7 +8,7 @@ hide:
 
 # Custom-card "Gauge"
 
-The `custom_card_mpse_gauge` is used present a value in form of a gauge. The card can handle two gauges so it would be easy to adapt the card to that if required. I prefered the minimal look.
+The `custom_card_mpse_gauge` is used present a value in form of a gauge. The card can handle two gauges so it would be easy to adapt the card to that if required. I preferred the minimal look.
 
 ![Printer](../../assets/img/custom_gauge.png)
 
@@ -51,7 +51,7 @@ Uses this card: <https://github.com/custom-cards/dual-gauge-card> which can be i
 <td>ulm_card_mpse_gauge_min</td>
 <td>0</td>
 <td>no</td>
-<td>Minium value, defaults to 0.</td>
+<td>Minimum value, defaults to 0.</td>
 </tr>
 <tr>
 <td>ulm_card_mpse_gauge_max</td>

diff --git a/docs/usage/custom_cards/custom_card_mpse_printer.md b/docs/usage/custom_cards/custom_card_mpse_printer.md
@@ -21,7 +21,7 @@ Version: 0.3.0
 
 <details>
 <summary>0.3.0</summary>
-Updated documention.
+Updated documentation.
 Cleanup code in card.
 Updated colors to match input values.
 </details>