Refactor configuration files

This commit is contained in:
DigiLive
2025-05-28 18:20:20 +02:00
parent f29a90da9d
commit 6a2e64f6ad
7 changed files with 62 additions and 83 deletions

View File

@ -21,7 +21,6 @@
"ignorePatterns": [ "ignorePatterns": [
"dist/", "dist/",
"node_modules/", "node_modules/",
"*.js",
"src/types/homeassistant/", "src/types/homeassistant/",
"src/types/lovelace-mushroom/" "src/types/lovelace-mushroom/"
], ],

View File

@ -1,22 +1,18 @@
{ {
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema.json", "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema-strict.json",
"default": true, "default": true,
"MD013": { "MD013": {
"line_length": 120, "line_length": 120,
"code_block_line_length": 120, "code_block_line_length": 120,
"heading_line_length": 80, "heading_line_length": 80,
"tables": false "tables": false,
}, },
"MD024": { "MD024": {
"siblings_only": true "siblings_only": true,
}, },
"MD033": { "MD033": {
"allowed_elements": [ "allowed_elements": ["br", "summary", "details"],
"br",
"summary",
"details"
]
}, },
"MD040": false, "MD040": false,
"MD046": false "MD046": false,
} }

View File

@ -9,6 +9,5 @@
"semi": true, "semi": true,
"singleQuote": true, "singleQuote": true,
"tabWidth": 2, "tabWidth": 2,
"trailingComma": "all",
"useTabs": false "useTabs": false
} }

115
README.md
View File

@ -1,62 +1,65 @@
# Mushroom dashboard strategy # Mushroom Dashboard Strategy 🍄✨
[![Release][releaseBadge]][releaseUrl] [![Release][releaseBadge]][releaseUrl]
[![HACS][hacsBadge]][hacsUrl] [![HACS][hacsBadge]][hacsUrl]
[![Codacy][codacyBadge]][codacyUrl] [![Codacy][codacyBadge]][codacyUrl]
---
**Effortlessly create stunning Home Assistant Dashboards with the Mushroom Dashboard Strategy!**
* Are you tired of manually configuring your Home Assistant dashboards?
Do you love the elegant design of Mushroom cards but wish for a simpler way to organize your entities,
devices, and areas?
The **Mushroom Dashboard Strategy** is your solution.
It automatically generates beautiful, organized dashboards for Home Assistant,
leveraging the power and aesthetics of Mushroom cards with minimal configuration.
---
## ⭐ **Why Choose Mushroom Dashboard Strategy?**
* **⚡️ Automatic Dashboard Generation:** Go from zero to a beautiful dashboard with just a few lines of YAML.
* **🏡 Intelligent Organization:** Automatically creates intuitive views for your devices, areas, and entities.
* **🎨 Highly Customizable:** Tailor your dashboard to your unique smart home setup with extensive options.
* **📈 Integrated Insights:** Seamlessly displays mini graph cards for your sensor data.
---
## 🚀 **Get Started in Minutes!**
Ready to transform your Home Assistant experience?
The **Mushroom Dashboard Strategy** is available through HACS (Home Assistant Community Store).
➡️ *
*[Explore the detailed documentation for Installation & Usage Guides!](https://digilive.github.io/mushroom-strategy/)**
---
## 📸 **Sneak Peek**
![Preview GIF](docs/images/preview.gif) ![Preview GIF](docs/images/preview.gif)
<details> ---
<summary>More images...</summary>
![Automatic](docs/images/auto.png) ## 🤝 **Contributing & Support**
![Views](docs/images/views.png) We welcome contributions and feedback!
![customizable](docs/images/customizable.png) * Have questions or need help?
</details> Check out our [Discussions](https://github.com/DigiLive/mushroom-strategy/discussions) page.
## What is the Mushroom Dashboard Strategy? * Found a bug or have an idea?
Open an [Issue](https://github.com/DigiLive/mushroom-strategy/issues).
Mushroom Dashboard Strategy provides a strategy for Home Assistant to automatically generate a dashboard * Enjoying the Mushroom Strategy?
using [Mushroom][mushroomUrl] cards. Consider giving our project a ⭐ [star on GitHub](https://github.com/DigiLive/mushroom-strategy) and exploring ways
to ❤️ [sponsor the project](https://github.com/sponsors/DigiLive) to support its continued development!
Your support helps us grow and improve.
Dashboard cards are generated for your Home Assistant's entities, devices and areas, divided over several views. ---
Starting at the Home view, you can enter an area subview.
For easy access, separate views are generated for entities which belong to specific domains.
### Features
* 🛠 Automatically create a dashboard with three lines of YAML.
* 😍 Built-in Views for device-specific controls.
* 🎨 Many options to customize to fit your needs.
* 📈 [Mini graph][miniGraphUrl] cards for sensor entities.
> [!TIP]
> If you like this package, please star the [project at GitHub][repositoryUrl]!
## Getting started
The strategy is easily installable from [HACS][hacsUrl] (Home Assistant Community Store).
Please visit [Installation Guide][installationUrl] at our Wiki.
## Need some help?
Visit the [Discussions][discussionsUrl] page or
the [Wiki][wikiUrl].
## Have an idea or want to report a bug?
Make sure your idea or bug isn't discussed already in our Discussions or Issues!
Visit the [issues][issuesUrl] page.
## Collaborators
* [DigiLive](https://github.com/DigiLive)
[![Sponsor DigiLive][sponsorBadge]](https://github.com/sponsors/DigiLive)
* [Aalian Khan](https://github.com/AalianKhan)
<!-- Badge References --> <!-- Badge References -->
@ -66,28 +69,12 @@ Visit the [issues][issuesUrl] page.
[releaseBadge]: https://img.shields.io/github/v/tag/digilive/mushroom-strategy?filter=v2.3.2&label=Release [releaseBadge]: https://img.shields.io/github/v/tag/digilive/mushroom-strategy?filter=v2.3.2&label=Release
[sponsorBadge]: https://img.shields.io/badge/Sponsor_him-%E2%9D%A4-%23db61a2.svg?&logo=github&color=%23fe8e86
<!-- Repository References --> <!-- Repository References -->
[codacyUrl]: https://app.codacy.com/gh/DigiLive/mushroom-strategy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
[repositoryUrl]: https://github.com/DigiLive/mushroom-strategy
[releaseUrl]: https://github.com/DigiLive/mushroom-strategy/releases/tag/v2.3.2 [releaseUrl]: https://github.com/DigiLive/mushroom-strategy/releases/tag/v2.3.2
[issuesUrl]: https://github.com/DigiLive/mushroom-strategy/issues
[discussionsUrl]: https://github.com/DigiLive/mushroom-strategy/discussions
[wikiUrl]: https://github.com/DigiLive/mushroom-strategy/wiki
[installationUrl]: https://github.com/DigiLive/mushroom-strategy/wiki#installation
<!-- Other References --> <!-- Other References -->
[codacyUrl]: https://app.codacy.com/gh/DigiLive/mushroom-strategy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
[hacsUrl]: https://hacs.xyz [hacsUrl]: https://hacs.xyz
[mushroomUrl]: https://github.com/piitaya/lovelace-mushroom
[miniGraphUrl]: https://github.com/kalkih/mini-graph-card

View File

@ -1,5 +1,5 @@
{ {
"name": "Mushroom Dashboard Strategy ", "name": "Mushroom Dashboard Strategy",
"render_readme": true, "render_readme": true,
"filename": "mushroom-strategy.js", "filename": "mushroom-strategy.js",
"homeassistant": "2024.7.0" "homeassistant": "2024.7.0"

View File

@ -13,23 +13,23 @@ theme:
icon: icon:
logo: material/mushroom logo: material/mushroom
palette: palette:
- media: "(prefers-color-scheme: light)" - media: '(prefers-color-scheme: light)'
scheme: default scheme: default
primary: blue primary: blue
accent: light blue accent: light blue
toggle: toggle:
icon: material/brightness-7 icon: material/brightness-7
name: Switch to dark mode name: Switch to dark mode
- media: "(prefers-color-scheme: dark)" - media: '(prefers-color-scheme: dark)'
scheme: slate scheme: slate
primary: blue primary: blue
accent: light blue accent: light blue
toggle: toggle:
icon: material/brightness-4 icon: material/brightness-4
name: Switch to light mode name: Switch to light mode
- media: "(prefers-color-scheme)" # This covers both light and dark system preferences - media: '(prefers-color-scheme)'
toggle: toggle:
icon: material/brightness-auto # Icon for automatic mode icon: material/brightness-auto
name: Switch to light/dark mode (auto) name: Switch to light/dark mode (auto)
features: features:
- navigation.tabs - navigation.tabs

View File

@ -1,7 +1,5 @@
{ {
"include": [ "include": ["src/**/*", "webpack.config.ts", "webpack.dev.config.ts"],
"src/**/*"
],
"compilerOptions": { "compilerOptions": {
// 1. Language and Environment // 1. Language and Environment
"target": "ES2020", "target": "ES2020",