From f7c8753b905d487ea2281c83e5f0eefc4c19a014 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20H=C3=B6rrle?= Date: Wed, 12 Jan 2022 13:56:10 +0100 Subject: [PATCH] Use pre-commit Hook for markdownlint --- .devcontainer/README.md | 2 +- .markdownlint.yml | 31 ---- .pre-commit-config.yaml | 1 + CHANGELOG.md | 144 ++++++++++-------- README.md | 26 +++- README_POPUPS.md | 13 ++ custom_cards/custom_card_bar_card/readme.md | 6 + custom_cards/custom_card_chromecast/README.md | 1 + .../README.md | 4 + .../custom_card_httpedo13_sun/README.md | 7 +- .../README.md | 17 ++- .../custom_card_input_number/README.md | 5 + .../custom_card_light_color/README.md | 9 ++ .../custom_card_light_colorpick/README.md | 6 + .../custom_card_light_icon_info/README.md | 6 + .../custom_card_media_player_sonos/README.md | 1 + .../custom_card_mpse_dualgraph/README.md | 3 + custom_cards/custom_card_mpse_gauge/README.md | 7 +- .../custom_card_mpse_printer/README.md | 9 +- .../custom_card_mpse_thermostat/README.md | 3 + .../custom_card_mpse_wifisignal/README.md | 5 + custom_cards/custom_card_nas/README.md | 5 + .../custom_card_paddy_dwd_pollen/README.md | 8 +- .../README.md | 8 + .../custom_card_paddy_welcome/README.md | 8 + .../custom_card_playstation/README.md | 1 + custom_cards/custom_card_qubino/README.md | 7 + custom_cards/custom_card_saxel_fan/README.md | 10 ++ custom_cards/custom_card_scenes/README.md | 6 +- .../custom_card_schumijo_car/README.md | 5 + .../custom_card_schumijo_flower/README.md | 5 + custom_cards/custom_card_thermostat/README.md | 5 +- .../custom_card_tpx01_aircondition/README.md | 9 +- .../README.md | 1 + .../custom_card_water_heater/README.md | 7 + docs/README_DOCS.md | 2 + docs/index.md | 2 +- info.md | 8 +- 38 files changed, 289 insertions(+), 114 deletions(-) delete mode 100644 .markdownlint.yml diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 194bc6723..b98249057 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -95,7 +95,7 @@ wget -O - https://get.hacs.xyz | bash - #### Add Integrations - Run task: `Run Home Assistant on port 9123` described in [Tasks](#tasks) -- Head to: http://localhost:9123 +- Head to: - create user - Add HACS integration - Go to HACS diff --git a/.markdownlint.yml b/.markdownlint.yml deleted file mode 100644 index c9f50e7ee..000000000 --- a/.markdownlint.yml +++ /dev/null @@ -1,31 +0,0 @@ ---- -# Base Markdownlint configuration -# Extended Markdownlint configuration in doc/.markdownlint/ -default: true -first-header-h1: false -no-bare-urls: false -header-style: - style: "atx" -ul-style: - style: "dash" -ul-indent: - indent: 4 -no-trailing-spaces: false -line-length: false -no-duplicate-header: - allow_different_nesting: true -no-trailing-punctuation: - punctuation: ".,;:!。，；：！？" -ol-prefix: - style: "ordered" -no-inline-html: false -hr-style: - style: "---" -no-emphasis-as-heading: false -first-line-h1: false -code-block-style: - style: "fenced" -proper-names: - names: [] - -code_blocks: false diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a16d19eb8..7c726bc62 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -28,6 +28,7 @@ repos: rev: v0.30.0 hooks: - id: markdownlint + args: ["--fix"] - repo: "https://github.com/jumanjihouse/pre-commit-hook-yamlfmt" rev: "0.1.0" diff --git a/CHANGELOG.md b/CHANGELOG.md index f4da30263..a1f1f4ac0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,6 @@ ## Version 1.0.0-beta.11 - ### 🚀 Features - #154 New custom cards and update of existing ones @mp-se @@ -17,7 +16,8 @@ - #155 Update card_light_icon_info.yaml @basbruss - #156 Fix custom_card_saxel blue style card @saxel - #153 Fix battery_card icon color when state is unavailable @saxel -- #146 fix Card "card_media_player_with_controls" (missing variable "ulm_card_media_player_with_controls_entity") @vncnt-dev +- #146 fix Card "card_media_player_with_controls" + (missing variable "ulm_card_media_player_with_controls_entity") @vncnt-dev - #183 Light Slider unavailable color @schumijo - #182 Update chips_icon_label to use base chips template @schumijo @@ -34,38 +34,43 @@ - #173 Update README_POPUPS.md @schumijo ### ❤️ Thank you so much for helping out to keep this UI awesome + @13robin37, @CM000n, @KaherdinTristan, @basbruss, @denes44, @desty2k, @kaphwor, @mp-se, @revin34, @saxel, @schumijo and @vncnt-dev ## Version 1.0.0-beta.10-hotfix ### What's Changed -* Add discord channel badge by @CM000n in https://github.com/UI-Lovelace-Minimalist/UI/pull/159 -* Add discord channel badge by @CM000n in https://github.com/UI-Lovelace-Minimalist/UI/pull/160 -* Use new slider from AnthonMS for popup card by @bavo in https://github.com/UI-Lovelace-Minimalist/UI/pull/162 -* Hotfix popup card by @schumijo in https://github.com/UI-Lovelace-Minimalist/UI/pull/164 +- Add discord channel badge by @CM000n in +- Add discord channel badge by @CM000n in +- Use new slider from AnthonMS for popup card by @bavo in +- Hotfix popup card by @schumijo in -**Full Changelog**: https://github.com/UI-Lovelace-Minimalist/UI/compare/v1.0.0-beta.10...v1.0.0-beta.10-hotfix +**Full Changelog**: ## Version 1.0.0-beta.10 ### What's Changed -* Fix lowercase readme files by @CM000n in https://github.com/UI-Lovelace-Minimalist/UI/pull/142 -* Automatically detect lowercase README.md files by @CM000n in https://github.com/UI-Lovelace-Minimalist/UI/pull/145 -* Hotfix: Fix folder structure for basbruss light cards by @basbruss in https://github.com/UI-Lovelace-Minimalist/UI/pull/144 -* Hotfix for folder structure on basbruss light cards by @CM000n in https://github.com/UI-Lovelace-Minimalist/UI/pull/150 -* Implementation of popup cards by @schumijo in https://github.com/UI-Lovelace-Minimalist/UI/pull/132 -* First release of popup cards by @schumijo in https://github.com/UI-Lovelace-Minimalist/UI/pull/157 + +- Fix lowercase readme files by @CM000n in +- Automatically detect lowercase README.md files by @CM000n in +- Hotfix: Fix folder structure for basbruss light cards by @basbruss in +- Hotfix for folder structure on basbruss light cards by @CM000n in +- Implementation of popup cards by @schumijo in +- First release of popup cards by @schumijo in ### 📄 Documentation -* Specific readme for popups is available [here](https://github.com/UI-Lovelace-Minimalist/UI/blob/main/ups.md) -**Full Changelog**: https://github.com/UI-Lovelace-Minimalist/UI/compare/v1.0.0-beta.9...v1.0.0-beta.10 +- Specific readme for popups is available [here](https://github.com/UI-Lovelace-Minimalist/UI/blob/main/ups.md) + +**Full Changelog**: #### ❤️ Special thanks to @bavo for his help on creating these popups -#### ❤️ And @CM000n for his hard work on this project. + +#### ❤️ And @CM000n for his hard work on this project ## Version 1.0.0-beta.9 + ### 🚀 Features - #121 Custom-card "Device Tracker (Online or Offline ?) @vncnt-dev @@ -95,10 +100,11 @@ - #135 Restructure images in custom cards folder + fix broken links @bavo ### ❤️ Thank you so much for helping out to keep this UI awesome -@13robin37, @CM000n, @basbruss, @bavo, @checkerschaf, @httpedo13, @mp-se, @sildehoop, @vncnt-dev +@13robin37, @CM000n, @basbruss, @bavo, @checkerschaf, @httpedo13, @mp-se, @sildehoop, @vncnt-dev ## Version 1.0.0-beta.8 + ### 🚀 Features - More-info function light card and Custom auto-color light cards @basbruss (#80) @@ -126,14 +132,14 @@ - Fix german translation an clean some code @CM000n (#91) - Add Spanish translations @jmoransalama (#93) - ## Version 1.0.0-beta.7 + ### ⚠️ Breaking Changes @saxel has done an excellent job of reworking the Vertical buttons custom state. However, a few old habits had to be cut off, concerning the specification of the variables for the colors of the `vertical_buttons`. If any of you have used this before, you should take a look at @saxel's pull request to get a better understanding of the new configuration: -https://github.com/UI-Lovelace-Minimalist/UI/pull/66 + ### 🔧 Code enhancements @@ -154,91 +160,109 @@ https://github.com/UI-Lovelace-Minimalist/UI/pull/66 - Fix card\_media\_player\_with\_controls variables access. @matrixx567 (#62) ## Version 1.0.0-beta.6 + ### Fixed -* Fixed `card_light_slider_*`: wrong background in dark theme with state=="on" (fix #18) -* Fixed `chip_icon_only`, `chip_icon_state` and `chip_icon_double_state` (fix #23) (thanks CM000n) -* Fixed missing default icon on `card_media_player` (fix #21) (thank you again {and again} schumijo) -* Fix wrong variable name in `card_light_slider_collapse` and `card_light_slider_horizontal` by schumijo (fix #13) (thank you schumijo) -* Fix `card_power_outlet` by saxel with PR #20 (fix #14) (thank you again saxel) -* Fix `card_battery` by saxel with PR #17 (thank you saxel) -* Fix `chip_power_consumption` by schumijo (fix #16) (thanks schumijo) + +- Fixed `card_light_slider_*`: wrong background in dark theme with state=="on" (fix #18) +- Fixed `chip_icon_only`, `chip_icon_state` and `chip_icon_double_state` (fix #23) (thanks CM000n) +- Fixed missing default icon on `card_media_player` (fix #21) (thank you again {and again} schumijo) +- Fix wrong variable name in `card_light_slider_collapse` and `card_light_slider_horizontal` by schumijo (fix #13) (thank you schumijo) +- Fix `card_power_outlet` by saxel with PR #20 (fix #14) (thank you again saxel) +- Fix `card_battery` by saxel with PR #17 (thank you saxel) +- Fix `chip_power_consumption` by schumijo (fix #16) (thanks schumijo) ### Changed -* Changed `cover` template to support covers without "current_position" attribute (fix #22) (and again, thanks schumijo!) -* Update `custom_card_schumijo_flower` by schumijo with PR #15 + +- Changed `cover` template to support covers without "current_position" attribute (fix #22) (and again, thanks schumijo!) +- Update `custom_card_schumijo_flower` by schumijo with PR #15 ### Added -* Added `chip_navigate` (close #24) + +- Added `chip_navigate` (close #24) ### Wiki -* Added CodeGenerator Button +- Added CodeGenerator Button ## Version 1.0.0-beta.5 + ### Fixed -* Fixed some links and typos in README.md -* Fixed `chip_icon_only` + +- Fixed some links and typos in README.md +- Fixed `chip_icon_only` ### Changed -* Changed name for language variables for schumijos flower card -* Changed link(s) in README.md for wiki -* Changed readme route people to the wiki -* Changed `card_battery` + +- Changed name for language variables for schumijos flower card +- Changed link(s) in README.md for wiki +- Changed readme route people to the wiki +- Changed `card_battery` ### Added -* Added `card_light_slider_collapse` and `card_light_slider_horizontal` (code, readme and wiki) -* Undocumented `card_script` - fully integrated in the next release + +- Added `card_light_slider_collapse` and `card_light_slider_horizontal` (code, readme and wiki) +- Undocumented `card_script` - fully integrated in the next release ### Removed -* Removed images that are no longer used (now in the wiki) +- Removed images that are no longer used (now in the wiki) ## Version 1.0.0-beta.4 + ### Fixed -* Fixed `custom_card_paddy_welcome` (fix #8) -* Fixed `examples.md` with wrong path to `button_card_templates.yaml` + +- Fixed `custom_card_paddy_welcome` (fix #8) +- Fixed `examples.md` with wrong path to `button_card_templates.yaml` ### Changed -* Changed all template names that start with `chips_` to `chip_` **breaking change** -* Changed `README.md` to reflect the new wiki (fix #5) -* Changed `card_light_slider` to remove slider while state=off -* Changed icon on `card_person` from mdi:account to mdi:face-man + +- Changed all template names that start with `chips_` to `chip_` **breaking change** +- Changed `README.md` to reflect the new wiki (fix #5) +- Changed `card_light_slider` to remove slider while state=off +- Changed icon on `card_person` from mdi:account to mdi:face-man ### Added -* Added `README.md` template to `custom-cards.md` -* Added author to `light_slider_card` +- Added `README.md` template to `custom-cards.md` +- Added author to `light_slider_card` ## Version 1.0.0-beta.3 + ### Changed -* Moved flower-card from minimalist-templates to custom-cards -* First examples written in `examples.md` -* Moved card_thermostat, card_water_heater, card_qubino and card_playstation to custom-cards and set them to review + +- Moved flower-card from minimalist-templates to custom-cards +- First examples written in `examples.md` +- Moved card_thermostat, card_water_heater, card_qubino and card_playstation to custom-cards and set them to review ### Added -* Re-added three commits from schumijo -* Added german (DE.yaml) to `custom_card_schumijo_flower` -* Added `card_navigate` -* Added `card_person` +- Re-added three commits from schumijo +- Added german (DE.yaml) to `custom_card_schumijo_flower` +- Added `card_navigate` +- Added `card_person` ## Version 1.0.0-beta.2 + ### Fixed -* Fix some typos in `README.md` -* Fix some typos in `custom-cards.md` -* Fix `box-shadow` in `card_graph` -* Fix `chip_icon_state` -* Fix `chips_icon_double_state` + +- Fix some typos in `README.md` +- Fix some typos in `custom-cards.md` +- Fix `box-shadow` in `card_graph` +- Fix `chip_icon_state` +- Fix `chips_icon_double_state` ### Added -* Added a few custom-cards (custom_card_paddy_welcome, custom_card_paddy_waste_collection, custom_card_tpx01_air_condition) +- Added a few custom-cards (custom_card_paddy_welcome, custom_card_paddy_waste_collection, custom_card_tpx01_air_condition) ## Version 1.0.0-beta.1 + ### Changed + Actually this version is a major re-write of the previous versions. As the new naming conventions are set, you may need to update your previous code to reflect these changes. This is necessary to ease future updates and get some structure in place, eg. for `custom_cards`. For most of the old definitions there are *legacy templates* in place. ## Notes + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). diff --git a/README.md b/README.md index eb541b2b8..3dfc65a23 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ [![Discord online members](https://badgen.net/discord/online-members/TPXg9b7GfR)](https://discord.gg/TPXg9b7GfR) # UI-Lovelace-Minimalist + It's kind of hard to explain what this is, so let's call it a "theme" (in quotation marks). But one thing is for sure, it is very nice! Taking the exceptional work of tben as a basis, this repository is aimed to ease installation and maintainance of his wonderful work. You can use this interpretation of a SmartHomeUI more or less like a theme in HomeAssistant. > ### Contributions + > This is a living project and all input is very welcome! If you configured and designed a card, that you would like to share, please feel free to do so! We are happy to include your contribution so others can use it as well! Your developments should always start from "dev" as the base branch. Due to the many contributions, it cannot be guaranteed that the "main" branch with the last published version contains all current changes. This project uses pre-commit for consistent and clean code. If possible, please make sure that you also use pre-commit for local development before creating a pull request. - - ## Wiki for documentation + We have setup an extensive Wiki for our documentation. It is more comfortable for you to read and for us to handle, than this file and gives our documentation the right framework to grow. Take a look here: [https://ui-lovelace-minimalist.netlify.app/](https://ui-lovelace-minimalist.netlify.app/) @@ -100,9 +101,11 @@ Take a look here: [https://ui-lovelace-minimalist.netlify.app/](https://ui-lovel * [List of templates](#list-of-templates) * [List of custom-cards](#custom-cards) * [Legacy templates](#legacy-templates) + ## Credits + * This design was made by [tben](https://community.home-assistant.io/u/tben/summary) * 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](https://community.home-assistant.io/t/lovelace-ui-minimalist/322687). @@ -112,31 +115,38 @@ Take a look here: [https://ui-lovelace-minimalist.netlify.app/](https://ui-lovel * Special thanks to clemalex and schumijo for contributing their cards to the main repository. ## This "theme" introduced + This "theme" provides you with four different elements, that combined give you a nice and functional layout. The basis for all these elements is `button-card` that allows for a great and individual styling. These elements, "cards", "chips", "title" and "vertical buttons", are fully customizable and can be enhanced to fit your needs. All this is only possible, because we are able to use the templating function from `button-card`. ### Chips + At the top of each page you can find the `chips`, which allow to quickly visualize important information. ![Chips](./docs/assets/screenshots/chips.png) ### Title + `Titles` are used to separate the different sections. Kind of a divider. ![Title](./docs/assets/screenshots/title.png) ### Vertical buttons + `Vertical buttons` show the information vertically aligned. These find their use eg. as navigation or scene buttons. ![Title](./docs/assets/screenshots/scene.gif) ### Cards + `Cards` are the main part of this design and are widely used in very different designs and functions. With these `cards` you can set up nearly every entity in HA, showing from "state-only" over a "full blown" information graphic with various values to "controlling" your covers and climate entities. ![Cards](./docs/assets/screenshots/cards.png) #### Anatomy of cards + ![Anatomy](./docs/assets/screenshots/anatomy.png) + 1. **Dot**: Visible when the device is unavailable. Also used on the entity **person** 2. **Icon**: Icon that represents the device 3. **Primary line**: Main information @@ -144,14 +154,17 @@ At the top of each page you can find the `chips`, which allow to quickly visuali 5. **Optional part**: Possibility to display buttons to launch actions related to the device. Or display a graph to view the history of a sensor or you let your fantasy take the ride... 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`. * 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. ### Language specific buttons + Sometimes the language specific strings from Home Assistant aren't available for your button, so we added the possibility to use language specific strings over the template system. ### 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! 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)). @@ -161,17 +174,21 @@ See a complete list of already included `custom-cards` in our [wiki](https://ui- Find informations on how to develop a `custom-card` [here](https://ui-lovelace-minimalist.netlify.app/development/custom_card). ### Extend with your own code + As we tried to be as modular as possible (and useful), it is easy to enhance or extend the code, we provide with your own definitions. That means for you, you can inherit every template to enhance it only with functions, you really want. No need to copy full blocks of code - just inherit and enhance only where changes are needed. We provided some instructions in our wiki, see [this page](https://ui-lovelace-minimalist.netlify.app/usage/changing_template). ### Code Generator(s) + We offer two (soon three) code generators, that support you in installing, getting example code and soon in configuring a button. Take a look at [this page](https://ui-lovelace-minimalist.netlify.app/codegen). ## Installation and update + At the moment there are two methods of installing this "theme", one for `yaml`-mode and one for `UI`-mode. We are working on getting this "theme" installable via HACS, but for now, we can only provide these two methods, sorry. We can offer you in-depth instructions for installation, as well as for future updates or from a previous version. Check our WIKI for more info: + * [Instructions for installation in `yaml`-mode](https://ui-lovelace-minimalist.netlify.app/installation/yaml-mode) * [Instructions for installation in `UI`-mode](https://ui-lovelace-minimalist.netlify.app/installation/ui-mode) * [Update in `yaml`mode](https://ui-lovelace-minimalist.netlify.app/installation/update#yaml-mode) @@ -182,13 +199,15 @@ TL;DR Download and copy content of `config` folder to HA `config` folder. Set link to include `button_card_templates`, install `lovelace-cards`, use example code to get started. ## List of templates + The actual version of this "theme" has 20 different cards, seven chips and other templates bundled into the download. We're sorry, but the list wouldn't fit into this readme. [Please see this page, where you can find an extensive list of templates with code examples, screenshots and explaination](https://ui-lovelace-minimalist.netlify.app/usage/template_list). ## Custom cards -The same goes for our `custom_cards`. As the number grows, the list would be to big for this readme, so we provide you with an overview page with pictures, code examples and additional informations. [Find the list here](https://ui-lovelace-minimalist.netlify.app/usage/custom_card_list). +The same goes for our `custom_cards`. As the number grows, the list would be to big for this readme, so we provide you with an overview page with pictures, code examples and additional informations. [Find the list here](https://ui-lovelace-minimalist.netlify.app/usage/custom_card_list). ## Legacy templates + As this "theme" evolved, there were some major changes and re-writes in the code, compared to the previous versions. That's why we tried to keep some legacy templates in place, to still be able to use your old template format. We provide a list of all legacy templates we support [here](https://ui-lovelace-minimalist.netlify.app/development/legacy_templates). @@ -196,6 +215,7 @@ We provide a list of all legacy templates we support [here](https://ui-lovelace- And if you had installed one of the previous versions, we made a short write-up, on how you can move to the new format and be able to use this theme in the future with all it's features and without worrying about updates. Take a look [here](https://ui-lovelace-minimalist.netlify.app/installation/update#previous-version). ## Popups + Readme is available [here](README_POPUPS.md).
diff --git a/README_POPUPS.md b/README_POPUPS.md index 90e403a8c..b89522ffb 100644 --- a/README_POPUPS.md +++ b/README_POPUPS.md @@ -1,4 +1,5 @@ # UI-Lovelace-Minimalist popups + The basis for all these popups is `button-card` that allows for a great and individual styling. These popups are "responsive". That means the layout automatically fit the size of the screen. ## Table of Content @@ -10,12 +11,15 @@ The basis for all these popups is `button-card` that allows for a great and indi * [Power outlet popup](#power-outlet-popup) * [Light popup](#light-popup) * [Media player popup](#media-player-popup) + ## Credits + * Designed by schumijo and bavo (special thanks to him for his help on this development)). ## Requirements + * Minimalist UI * button-card (download for HACS) * Browser_mod (download for HACS) @@ -25,11 +29,13 @@ The basis for all these popups is `button-card` that allows for a great and indi ## Requirements + * mini-graph-card (download for HACS) ### Card compatibility This popup is displayed using ``hold_action`` and it is compatible with the following cards/chips : + * card_generic * card_generic_swap * card_binary_sensor @@ -39,6 +45,7 @@ This popup is displayed using ``hold_action`` and it is compatible with the foll * card_battery ### Variables + @@ -71,6 +78,7 @@ This popup is displayed using ``hold_action`` and it is compatible with the foll To enable this popup, you need to add the ``popup_power_outlet`` template on your card. And also the previously explained variables. For exemple : + ```yaml - type: "custom:button-card" template: @@ -90,12 +98,14 @@ For exemple : ## Requirements + * My Cards Bundle aka slider-card (download for HACS) * Light Entity Card (download for HACS) ### Card compatibility This popup is displayed using ``hold_action`` and it is compatible with the following cards/chips : + * card_light ### How to use @@ -103,6 +113,7 @@ This popup is displayed using ``hold_action`` and it is compatible with the foll To enable this popup, you need to add the ``popup_light`` template on your card. For exemple : + ```yaml - type: "custom:button-card" template: @@ -118,6 +129,7 @@ For exemple : ### Card compatibility This popup is displayed using ``hold_action`` and it is compatible with the following cards/chips : + * card_media_player ### How to use @@ -125,6 +137,7 @@ This popup is displayed using ``hold_action`` and it is compatible with the foll To enable this popup, you need to add the ``popup_media_player`` template on your card. For exemple : + ```yaml - type: "custom:button-card" template: diff --git a/custom_cards/custom_card_bar_card/readme.md b/custom_cards/custom_card_bar_card/readme.md index fa5a357eb..aa9438e31 100644 --- a/custom_cards/custom_card_bar_card/readme.md +++ b/custom_cards/custom_card_bar_card/readme.md @@ -1,20 +1,24 @@ # Custom-card "Bar Card" + This is a `custom-card` to display a percentage value as a bar. ![Screenshot](../../../../../assets/screenshots/screenshot_bar_card.png) ## Credits + Author: rphlwnk - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release
## Requirements + This card needs the following to function correctly: [Custom Card 'Bar-Card'](https://github.com/custom-cards/bar-card) @@ -33,7 +37,9 @@ This card needs the following to function correctly: ulm_custom_card_bar_card_min: 10 ulm_custom_card_bar_card_max: 20 ``` + ## Variables +
Variable
diff --git a/custom_cards/custom_card_chromecast/README.md b/custom_cards/custom_card_chromecast/README.md index 62efb5742..6c82ff8c5 100644 --- a/custom_cards/custom_card_chromecast/README.md +++ b/custom_cards/custom_card_chromecast/README.md @@ -19,6 +19,7 @@ ``` #### Variables +
Variable
diff --git a/custom_cards/custom_card_damix48_power_details/README.md b/custom_cards/custom_card_damix48_power_details/README.md index f56faf283..290ae4c41 100644 --- a/custom_cards/custom_card_damix48_power_details/README.md +++ b/custom_cards/custom_card_damix48_power_details/README.md @@ -5,10 +5,12 @@ The `custom_card_damix48_power_details` is an extension of the standard graph ca ![Power details](../../../../../assets/screenshots/custom_power_details.png) ## Credits + Author: Damix48 Version: 0.1.0 ## Changelog +
0.1.0 Initial release. @@ -34,9 +36,11 @@ Initial release. ``` ## Requirements + Need [mini-graph-card](https://github.com/kalkih/mini-graph-card) ## Variables +
Variable
diff --git a/custom_cards/custom_card_httpedo13_sun/README.md b/custom_cards/custom_card_httpedo13_sun/README.md index e00ed0f1f..faaf79a8a 100644 --- a/custom_cards/custom_card_httpedo13_sun/README.md +++ b/custom_cards/custom_card_httpedo13_sun/README.md @@ -1,17 +1,21 @@ # Custom-card "Sun" + The `custom_card_httpedo13_sun` adapt `sun card` for minimalist ui. ## Credits + Author: httpedo13 - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release
## Requirements + This card uses:
Variable
@@ -31,8 +35,8 @@ This card uses:
- ## Images + ![Generic](../../../../../assets/screenshots/sun-card.png) ## Usage @@ -45,6 +49,7 @@ This card uses: ``` ## Variables + The same sun card config. | Name | Accepted values | Description | Default | diff --git a/custom_cards/custom_card_httpedo13_thermostat/README.md b/custom_cards/custom_card_httpedo13_thermostat/README.md index 98c25c2af..f40f33599 100644 --- a/custom_cards/custom_card_httpedo13_thermostat/README.md +++ b/custom_cards/custom_card_httpedo13_thermostat/README.md @@ -1,19 +1,23 @@ # Custom-card "Thermostat" + The `custom_card_httpedo13_thermostat` shows data from your thermostat and gives you the possibility to control it. Thanks to [tpx01's](https://github.com/httpedo13/UI/tree/main/custom_cards/custom_card_tpx01_aircondition) air-condition custom card! ## Credits + Author: httpedo13 - 2021 Version: 1.0.0 This design was made by [tpx01's](https://github.com/httpedo13/UI/tree/main/custom_cards/custom_card_tpx01_aircondition) ## Changelog +
1.0.0 Initial release
## Images + ![thermostat_white_collapse](../../../../../assets/screenshots/thermostat_white_collapse.png) ![thermostat_white](../../../../../assets/screenshots/thermostat_white.png) @@ -24,31 +28,34 @@ Initial release ![thermostat_dark_with_heating_ui](../../../../../assets/screenshots/thermostat_dark_with_heating_ui.png) - ## Usage With buttons: + ```yaml - type: custom:button-card template: custom_card_httpedo13_thermostat_with_buttons variables: - entity: climate.ground_floor - name: Heater Ground Floor + entity: climate.ground_floor + name: Heater Ground Floor ``` With collapse button: + ```yaml - type: custom:button-card template: custom_card_httpedo13_thermostat_with_buttons_collapse variables: - entity: climate.ground_floor - name: Heater Ground Floor + entity: climate.ground_floor + name: Heater Ground Floor ``` ## Requirements + Entity climate with only heat mode ## Variables + diff --git a/custom_cards/custom_card_input_number/README.md b/custom_cards/custom_card_input_number/README.md index 24c007f21..8ee1ca0ea 100644 --- a/custom_cards/custom_card_input_number/README.md +++ b/custom_cards/custom_card_input_number/README.md @@ -1,13 +1,16 @@ # Custom-card "NAS" + The `card_input_number` you can control a input_number entity ![Input Number Card](./assets/screenshots/card_input_number.png) ## Credits + Author: sildehoop - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -25,9 +28,11 @@ Initial release ``` ## Requirements + n/a ## Variables +
Variable
diff --git a/custom_cards/custom_card_light_color/README.md b/custom_cards/custom_card_light_color/README.md index 2f71022a0..92aa6159e 100644 --- a/custom_cards/custom_card_light_color/README.md +++ b/custom_cards/custom_card_light_color/README.md @@ -1,4 +1,5 @@ # Custom-card "Color Light Card" + This is a `custom-card` to add additionall function to the `light_card`. It comes in four different versions: * Color changing light card with icon as info button (*card_light_color*) @@ -14,11 +15,14 @@ The card shows you the color of the light. The icon is changeable for each MDI-i ![Dark](../../../../../assets/screenshots/light_dark.png) ![Dark_slider](../../../../../assets/screenshots/light_dark_slider.png) ![Dark_horizontal](../../../../../assets/screenshots/light_dark_horizontal.png) + ## Credits + Author: basbruss - 2021 Version: 1.0.1 ## Changelog +
1.0.0 Initial release @@ -33,6 +37,7 @@ Code celanup
## Requirements + This card needs the following to function correctly:
Variable
@@ -53,6 +58,7 @@ This card needs the following to function correctly:
## Installation + * Copy the folder `custom_card_light_color` from your download `custom_cards` to `config/minimalist-templates` In the end it should look like this: @@ -102,10 +108,13 @@ config ulm_card_light_icon: mdi:ceiling-light #leave empty for standard icon ulm_card_light_mode: dark # define light or dark theme-mode, leave empty if you use auto ``` + ## Dark/Light Mode support (*new function*) + The default for all cards include is auto switching. You can use only dark or light mode if you specify the `ulm_card_light_mode` variable. ## Variables + diff --git a/custom_cards/custom_card_light_colorpick/README.md b/custom_cards/custom_card_light_colorpick/README.md index 8df69082e..34a1eddb2 100644 --- a/custom_cards/custom_card_light_colorpick/README.md +++ b/custom_cards/custom_card_light_colorpick/README.md @@ -1,19 +1,23 @@ # Custom-card "Colorpicker Light Card" + This is a `custom-card` to add additional function to the `light_card`. The card uses a slider as well as six conditional icons to pick the color of the light. ## Credits + Author: 13robin37 - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release
## Requirements + This card needs the following to function correctly:
Card type
@@ -34,6 +38,7 @@ This card needs the following to function correctly:
## Installation + * Copy the folder `custom_card_light_colorpick` from your download `custom_cards` to `config/minimalist-templates` In the end it should look like this: @@ -61,6 +66,7 @@ config ``` ## Variables + diff --git a/custom_cards/custom_card_light_icon_info/README.md b/custom_cards/custom_card_light_icon_info/README.md index 860c57b68..934dab28d 100644 --- a/custom_cards/custom_card_light_icon_info/README.md +++ b/custom_cards/custom_card_light_icon_info/README.md @@ -1,4 +1,5 @@ # Custom-card "Light Card Icon Info" + This is a `custom-card` to add additionall function to the `light_card`. It comes in four different versions: * Light card with icon as info button (*card_light_icon_info*) @@ -9,10 +10,12 @@ This is a `custom-card` to add additionall function to the `light_card`. It come The icon is changeable for each MDI-icon. And the icon functions as button to show more-info. ## Credits + Author: basbruss - 2021 Version: 1.0.1 ## Changelog +
1.0.0 Initial release @@ -27,6 +30,7 @@ Code cleanup
## Requirements + This card needs the following to function correctly:
Card type
@@ -48,6 +52,7 @@ This card needs the following to function correctly:
## Installation + * Copy the folder `custom_card_light_icon_info` from your download `custom_cards` to `config/minimalist-templates` In the end it should look like this: @@ -95,6 +100,7 @@ config ``` ## Variables + diff --git a/custom_cards/custom_card_media_player_sonos/README.md b/custom_cards/custom_card_media_player_sonos/README.md index bebe7e414..1b53858b2 100644 --- a/custom_cards/custom_card_media_player_sonos/README.md +++ b/custom_cards/custom_card_media_player_sonos/README.md @@ -19,6 +19,7 @@ ``` #### Variables +
Card type
diff --git a/custom_cards/custom_card_mpse_dualgraph/README.md b/custom_cards/custom_card_mpse_dualgraph/README.md index 62ea639b0..93007f468 100644 --- a/custom_cards/custom_card_mpse_dualgraph/README.md +++ b/custom_cards/custom_card_mpse_dualgraph/README.md @@ -5,10 +5,12 @@ The `custom_card_mpse_dual_graph` is an extension of the standard graph card and ![Dual Graph](../../../../../assets/screenshots/custom_dual_graph.png) ## Credits + Author: mpse Version: 0.1.0 ## Changelog +
0.1.0 Initial release. @@ -30,6 +32,7 @@ Initial release. ## Requirements ## Variables +
Variable
diff --git a/custom_cards/custom_card_mpse_gauge/README.md b/custom_cards/custom_card_mpse_gauge/README.md index a489c4036..d18acc9a3 100644 --- a/custom_cards/custom_card_mpse_gauge/README.md +++ b/custom_cards/custom_card_mpse_gauge/README.md @@ -5,10 +5,12 @@ The `custom_card_mpse_gauge` is used present a value in form of a gauge. The car ![Printer](../../../../../assets/screenshots/custom_gauge.png) ## Credits + Author: mpse Version: 0.1.0 ## Changelog +
Initial release.
@@ -25,8 +27,11 @@ Initial release. ``` ## Requirements -Uses this card: https://github.com/custom-cards/dual-gauge-card which can be installed via HACS. + +Uses this card: which can be installed via HACS. + ## Variables +
Variable
diff --git a/custom_cards/custom_card_mpse_printer/README.md b/custom_cards/custom_card_mpse_printer/README.md index fb1cec12b..c69dc4013 100644 --- a/custom_cards/custom_card_mpse_printer/README.md +++ b/custom_cards/custom_card_mpse_printer/README.md @@ -5,10 +5,12 @@ The `custom_card_mpse_printer` is used to display the status of a printer and th ![Printer](../../../../../assets/screenshots/custom_printer.png) ## Credits + Author: mpse (based on clemalex post) Version: 0.3.0 ## Changelog +
0.3.0 Updated documention. @@ -40,10 +42,13 @@ Initial release adapted from a post on home assistant forum by user clemalex. ``` ## Requirements -Uses this card: https://github.com/custom-cards/bar-card -Tested with the IPP Integration from Home Assistant: https://www.home-assistant.io/integrations/ipp + +Uses this card: +Tested with the IPP Integration from Home Assistant: On my printer i cannot get any state update, it always reports idle. I wanted to highlight the button when the printer is active. + ## Variables +
Variable
diff --git a/custom_cards/custom_card_mpse_thermostat/README.md b/custom_cards/custom_card_mpse_thermostat/README.md index b0694853d..f78ab5d1c 100644 --- a/custom_cards/custom_card_mpse_thermostat/README.md +++ b/custom_cards/custom_card_mpse_thermostat/README.md @@ -7,10 +7,12 @@ The buttons are used to lower/raise the set temperature which is displayed betwe ![Thermostat](../../../../../assets/screenshots/custom_thermostat.png) ## Credits + Author: mpse Version: 0.1.0 ## Changelog +
0.1.0 Initial release inspired from various posts on home assistant forum. @@ -27,6 +29,7 @@ Initial release inspired from various posts on home assistant forum. ## Requirements ## Variables +
Variable
diff --git a/custom_cards/custom_card_mpse_wifisignal/README.md b/custom_cards/custom_card_mpse_wifisignal/README.md index 4cae22489..b06327c3c 100644 --- a/custom_cards/custom_card_mpse_wifisignal/README.md +++ b/custom_cards/custom_card_mpse_wifisignal/README.md @@ -5,10 +5,12 @@ The `custom_card_mpse_wifisignal` is used to display the status of a wifi signal ![WiFi Signal](../../../../../assets/screenshots/custom_wifisignal.png) ## Credits + Author: mpse Version: 0.2.0 ## Changelog +
0.2.0 Cleanup and updated documentation. @@ -27,8 +29,11 @@ Initial release. ``` ## Requirements + No special cards needed. + ## Variables +
Variable
diff --git a/custom_cards/custom_card_nas/README.md b/custom_cards/custom_card_nas/README.md index 5bad2d798..8b8937847 100644 --- a/custom_cards/custom_card_nas/README.md +++ b/custom_cards/custom_card_nas/README.md @@ -1,11 +1,14 @@ # Custom-card "NAS" + The `card-nas` shows you a specific sensor value from your NAS, eg. the disk space used. ## Credits + Author: tben - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -24,9 +27,11 @@ Initial release ``` ## Requirements + n/a ## Variables +
Variable
diff --git a/custom_cards/custom_card_paddy_dwd_pollen/README.md b/custom_cards/custom_card_paddy_dwd_pollen/README.md index 1c010c14d..c8adfa1e6 100644 --- a/custom_cards/custom_card_paddy_dwd_pollen/README.md +++ b/custom_cards/custom_card_paddy_dwd_pollen/README.md @@ -1,11 +1,14 @@ # Custom-card "DWD Pollen" + This is a `custom-card` to show the pollen count, taken from the DWD pollen service via a rest sensor. ## Credits + Author: Paddy0174 - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -16,11 +19,12 @@ Initial release ```yaml - type: custom:button-card template: - - custom_card_paddy_dwd_pollen + - custom_card_paddy_dwd_pollen entity: sensor.dwd_pollenbelastung_birke ``` ## Requirements + n/a ## Template code @@ -80,6 +84,7 @@ custom_card_paddy_dwd_pollen: ``` ## HomeAssistant + I use the following `rest` and `template` sensors in HA: ```yaml @@ -117,4 +122,5 @@ sensor: ``` ## Notes + * As this card is mainly for the DWD pollen sensor, that is based in Germany and shows only german data, the only available language is "German". If you want another language added, please leave a message in the support thread. diff --git a/custom_cards/custom_card_paddy_waste_collection/README.md b/custom_cards/custom_card_paddy_waste_collection/README.md index 544e1c758..6b4a35f04 100644 --- a/custom_cards/custom_card_paddy_waste_collection/README.md +++ b/custom_cards/custom_card_paddy_waste_collection/README.md @@ -1,11 +1,14 @@ # Custom-card "Waste collection" + This is a `custom-card` to show the next waste collection date. It uses the data from the `custom_component` "Waste Collection Framework". ## Credits + Author: Paddy0174 - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -21,6 +24,7 @@ Initial release ``` ## Requirements + This card needs the following to function correctly:
Variable
@@ -36,6 +40,7 @@ This card needs the following to function correctly:
## Variables + @@ -129,9 +134,11 @@ custom_card_paddy_waste_collection: ``` ## HomeAssistant + This is my `sensor` setup in HA. I do the change from "days" to "friendly days" in my template sensor. > #### Note +> > * Don't forget to set `add_days_to` in your `sensor` config > * "HEUTE" is german for today or aujourd'hui > * "MORGEN" is german for tomorrow or demain @@ -155,4 +162,5 @@ sensor: ``` ## Notes + n/a diff --git a/custom_cards/custom_card_paddy_welcome/README.md b/custom_cards/custom_card_paddy_welcome/README.md index dec256525..2edaa0616 100644 --- a/custom_cards/custom_card_paddy_welcome/README.md +++ b/custom_cards/custom_card_paddy_welcome/README.md @@ -1,4 +1,5 @@ # Custom-card "Welcome" + This is a `custom-card` to show a welcome message to the user. It comes in four different versions: * welcome message (*custom_card_paddy_welcome*) @@ -8,16 +9,19 @@ This is a `custom-card` to show a welcome message to the user. It comes in four The card shows a time based message (good morning/afternoon/evening/hello) to the logged-in user with username. The second part of the card varies depending on what version you choose. *Note, that you have different requirements depending on the version!* ## Credits + Author: Paddy0174 - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release
## Requirements + This card needs the following to function correctly:
Variable
@@ -43,6 +47,7 @@ This card needs the following to function correctly:
## Installation + * Copy the folder `custom_card_paddy_welcome` from your download `custom_cards` to `config/minimalist-templates` * Go to the folder `config/minimalist-templates/custom_card_paddy_welcome/languages` and delete all but the one language file you want to use. For english, delete all but `EN.yaml`, for german delete all but `DE.yaml`. @@ -86,6 +91,7 @@ config ``` ## Variables + @@ -118,6 +124,7 @@ config
Card type
> #### Note _welcome_with_news + > This card is based on [home-feed-card](https://github.com/gadgetchnnel/lovelace-home-feed-card) and needs a little different configuration in the variables. > To allow almost all entites from HomeAssistant to show in the news, you're able to set all options that `home-feed-card` provides. This makes it necessary, that you set these entities in a list. Let me show you an example: > @@ -371,6 +378,7 @@ custom_card_paddy_welcome_with_news: ``` ## Custom configuration Example + Here is one example, on how you can extend this (actually every) card. In the end we have the welcome card extended by four buttons to have something like a header with a navigation. ```yaml diff --git a/custom_cards/custom_card_playstation/README.md b/custom_cards/custom_card_playstation/README.md index fa948da5e..fa2089d4f 100644 --- a/custom_cards/custom_card_playstation/README.md +++ b/custom_cards/custom_card_playstation/README.md @@ -15,6 +15,7 @@ ``` #### Variables + diff --git a/custom_cards/custom_card_qubino/README.md b/custom_cards/custom_card_qubino/README.md index 7db1354fb..76a3d4330 100644 --- a/custom_cards/custom_card_qubino/README.md +++ b/custom_cards/custom_card_qubino/README.md @@ -4,10 +4,12 @@ > This card is under review and is not ready to use! ## Credits + Author: tben - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -19,6 +21,7 @@ Initial release ``` ## Requirements + This card needs the following to function correctly:
Variable
@@ -33,6 +36,7 @@ This card needs the following to function correctly:
## Variables + @@ -54,13 +58,16 @@ This card needs the following to function correctly: ``` ## HomeAssistant + ... ## Example + ... ```yaml ``` ## Note + ... diff --git a/custom_cards/custom_card_saxel_fan/README.md b/custom_cards/custom_card_saxel_fan/README.md index 628b41875..3db77f89e 100644 --- a/custom_cards/custom_card_saxel_fan/README.md +++ b/custom_cards/custom_card_saxel_fan/README.md @@ -1,4 +1,5 @@ # Custom-card "Fan" + This is a _custom card_ to control a fan. It allows you to turn on/off the fan, adjusting the fan speed with a slider, and turn on/off oscillation. Two styles are available: | Template | Description | @@ -7,22 +8,27 @@ This is a _custom card_ to control a fan. It allows you to turn on/off the fan, | custom_card_saxel_fan_blue | Card is theme based when the fan is __OFF__, Blue when the fan is __ON__ | #### Light theme + ![Light theme](../../../../../assets/screenshots/custom_fan_light_theme.png) #### Dark theme + ![Dark theme](../../../../../assets/screenshots/custom_fan_dark_theme.png) ## Credits + Author: saxel - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release
## Requirements + This card needs the following to function correctly:
Variable
@@ -43,11 +49,13 @@ This card needs the following to function correctly:
## Installation + Copy the folder `custom_card_saxel_fan` to `config/minimalist-templates/` ## Usage #### Standard + ```yaml - type: custom:button-card template: custom_card_saxel_fan_blue @@ -59,6 +67,7 @@ Copy the folder `custom_card_saxel_fan` to `config/minimalist-templates/` ``` #### Blue + ```yaml - type: custom:button-card template: custom_card_saxel_fan @@ -70,6 +79,7 @@ Copy the folder `custom_card_saxel_fan` to `config/minimalist-templates/` ``` ## Variables + diff --git a/custom_cards/custom_card_scenes/README.md b/custom_cards/custom_card_scenes/README.md index 43c675744..8c2cb8b05 100644 --- a/custom_cards/custom_card_scenes/README.md +++ b/custom_cards/custom_card_scenes/README.md @@ -1,13 +1,16 @@ # Custom-card "Scenes Card" + The `card_scenes` you can control a input_number entity ![Scenes Card](../../../../../assets/screenshots/card_scenes.png) ## Credits + Author: sildehoop - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -48,9 +51,11 @@ Initial release ``` ## Requirements + n/a ## Variables +
Variable
@@ -90,7 +95,6 @@ n/a
Variable
- ## Template code ```yaml diff --git a/custom_cards/custom_card_schumijo_car/README.md b/custom_cards/custom_card_schumijo_car/README.md index 05f74e1aa..1a463201b 100644 --- a/custom_cards/custom_card_schumijo_car/README.md +++ b/custom_cards/custom_card_schumijo_car/README.md @@ -1,4 +1,5 @@ # Custom-card "Car" + This is a `custom-card` to informations about your car. ![Generic](../../../../../assets/screenshots/car.png) @@ -6,10 +7,12 @@ This is a `custom-card` to informations about your car. _NB : This card has only been tested with Audi Connect integration but should work with some others._ ## Credits + Author: schumijo - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -27,7 +30,9 @@ Initial release ulm_card_schumijo_car_energy_level: sensor.audi_q3_tank_level ulm_card_schumijo_car_range: sensor.audi_q3_range ``` + #### Variables + diff --git a/custom_cards/custom_card_schumijo_flower/README.md b/custom_cards/custom_card_schumijo_flower/README.md index a6dc80cfb..81246f479 100644 --- a/custom_cards/custom_card_schumijo_flower/README.md +++ b/custom_cards/custom_card_schumijo_flower/README.md @@ -1,13 +1,16 @@ # Custom-card "Flower" + This is a `custom-card` to display a plant entity. Shows state of the plant and attributes. ![Generic](../../../../../assets/screenshots/flower.png) ## Credits + Author: schumijo - 2021 Version: 1.1.0 ## Changelog +
1.0.0 Initial release @@ -28,7 +31,9 @@ Updated README ulm_card_flower_name: Bonsai Ficus ulm_card_flower_species: "ficus retusa" ``` + #### Variables +
Variable
diff --git a/custom_cards/custom_card_thermostat/README.md b/custom_cards/custom_card_thermostat/README.md index b5f4c8da2..f40faab7b 100644 --- a/custom_cards/custom_card_thermostat/README.md +++ b/custom_cards/custom_card_thermostat/README.md @@ -5,12 +5,13 @@ The `thermostat-card` is used to switch a climate entity on/off and show the temperature from a (different) `sensor`. - ## Credits + Author: tben - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -28,9 +29,11 @@ Initial release ``` ## Requirements + n/a ## Variables +
Variable
diff --git a/custom_cards/custom_card_tpx01_aircondition/README.md b/custom_cards/custom_card_tpx01_aircondition/README.md index b627b94eb..106aebe9c 100644 --- a/custom_cards/custom_card_tpx01_aircondition/README.md +++ b/custom_cards/custom_card_tpx01_aircondition/README.md @@ -1,11 +1,14 @@ # Custom-card "AirCondition" + The `custom_card_tpx01_aircondition` shows data from your air condition and gives you the possibility to control it. ## Credits + Author: tpx01 - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -17,14 +20,16 @@ Initial release - type: custom:button-card template: custom_card_tpx01_aircondition_with_buttons variables: - entity: climate.livingroom - name: A/C Livingroom + entity: climate.livingroom + name: A/C Livingroom ``` ## Requirements + n/a ## Variables +
Variable
diff --git a/custom_cards/custom_card_vncntdev_device_tracer/README.md b/custom_cards/custom_card_vncntdev_device_tracer/README.md index 579cd64ef..b1871723f 100644 --- a/custom_cards/custom_card_vncntdev_device_tracer/README.md +++ b/custom_cards/custom_card_vncntdev_device_tracer/README.md @@ -12,6 +12,7 @@ Author: vncnt.dev - 2021 Version: 1.0.0 ## Changelog +
1.1.0 Support WoL diff --git a/custom_cards/custom_card_water_heater/README.md b/custom_cards/custom_card_water_heater/README.md index 9fea4dfcf..5810c7c3b 100644 --- a/custom_cards/custom_card_water_heater/README.md +++ b/custom_cards/custom_card_water_heater/README.md @@ -4,10 +4,12 @@ > This card is under review and is not ready to use! ## Credits + Author: tben - 2021 Version: 1.0.0 ## Changelog +
1.0.0 Initial release @@ -19,6 +21,7 @@ Initial release ``` ## Requirements + This card needs the following to function correctly:
Variable
@@ -33,6 +36,7 @@ This card needs the following to function correctly:
## Variables + @@ -54,13 +58,16 @@ This card needs the following to function correctly: ``` ## HomeAssistant + ... ## Example + ... ```yaml ``` ## Note + ... diff --git a/docs/README_DOCS.md b/docs/README_DOCS.md index ab77b15ec..fe3ea8a34 100644 --- a/docs/README_DOCS.md +++ b/docs/README_DOCS.md @@ -14,7 +14,9 @@ mkdocs serve --dirtyreload ``` ## Markdown linting + Can be done automatically by running pre-commit + ```bash pre-commit run markdownlint ``` diff --git a/docs/index.md b/docs/index.md index a1fe3f77c..5b8f3998c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,7 @@ hide: title: Welcome --- -# Welcome to the UI-Lovelace-Minimalist wiki! +# Welcome to the UI-Lovelace-Minimalist wiki External file test diff --git a/info.md b/info.md index 7d620233f..d3a73b116 100644 --- a/info.md +++ b/info.md @@ -1,15 +1,15 @@ {%- if version_installed == "dev" %} -## You are running dev! +## You are running dev This is **only** intended for development! -{%- elif (version_installed.split(".")[0] | int) < 0 %} +{%- elif [version_installed.split("."](0) | int) < 0 %} -# Breaking changes! +# Breaking changes Read the release notes! -https://github.com/UI-Lovelace-Minimalist/UI/releases/tag/0.0.0 + {% endif %} # UI-Lovelace-Minimalist
Variable