forked from DigiLive/mushroom-strategy
Continuous Integration - Deploy Documentation
This commit is contained in:
1 parent
98b75146f5
commit
1cf3b9404a
21 files changed
+7841
-321
No files matched your search
@@ -303,17 +303,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="/mushroom-strategy/contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="/mushroom-strategy/contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -721,9 +722,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/mushroom-strategy/contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -732,10 +749,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/mushroom-strategy/contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/mushroom-strategy/contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/mushroom-strategy/contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/mushroom-strategy/contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/mushroom-strategy/contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="/mushroom-strategy/contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
+191
-159
@@ -18,13 +18,15 @@
|
||||
<link rel="prev" href="../faq/">
|
||||
|
||||
|
||||
<link rel="next" href="getting-started/">
|
||||
|
||||
|
||||
<link rel="icon" href="../assets/images/favicon.png">
|
||||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
|
||||
|
||||
|
||||
|
||||
<title>Contributing - Mushroom Strategy Documentation</title>
|
||||
<title>🤝 Contributing to Mushroom Strategy - Mushroom Strategy Documentation</title>
|
||||
|
||||
|
||||
|
||||
@@ -112,7 +114,7 @@
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Contributing
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
</div>
|
||||
@@ -314,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item md-tabs__item--active">
|
||||
<a href="./" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item md-tabs__item--active">
|
||||
<a href="./" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -734,6 +737,54 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Contributing
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active">
|
||||
|
||||
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||||
@@ -747,7 +798,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Contributing
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
@@ -760,7 +811,7 @@
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Contributing
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
@@ -807,33 +858,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#contributing-code" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
💻 Contributing Code
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#improving-documentation" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
📄 Improving Documentation
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#translations" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
🌐 Translations
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -852,6 +876,129 @@
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -869,7 +1016,7 @@
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/DigiLive/mushroom-strategy/edit/main/docs/contributing.md" title="Edit this page" class="md-content__button md-icon">
|
||||
<a href="https://github.com/DigiLive/mushroom-strategy/edit/main/docs/contributing/index.md" title="Edit this page" class="md-content__button md-icon">
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
|
||||
</a>
|
||||
@@ -896,7 +1043,7 @@ carefully.</p>
|
||||
<li><strong>Open a new issue:</strong> If it's a new bug, please open
|
||||
a <a href="https://github.com/DigiLive/mushroom-strategy/issues/new?template=bug_report.yml">new issue</a>.</li>
|
||||
<li>
|
||||
<p><strong>Provide details:</strong> In your report, please include:</p>
|
||||
<p><strong>Provide details:</strong> In your report, please follow the instructions and template to include:</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>A clear and concise description of the bug.</p>
|
||||
@@ -915,128 +1062,13 @@ carefully.</p>
|
||||
requested.</li>
|
||||
<li><strong>Open a new issue:</strong> If it's a new idea, open
|
||||
a <a href="https://github.com/DigiLive/mushroom-strategy/issues/new?template=feature_request.yml">new issue</a>.</li>
|
||||
<li><strong>Describe your idea:</strong> Clearly explain the feature, why you think it's useful, and any potential use cases.</li>
|
||||
<li><strong>Describe your idea:</strong> Clearly explain the feature, why you think it's useful, and any potential use cases by
|
||||
following the instructions and template.</li>
|
||||
</ol>
|
||||
<hr />
|
||||
<h2 id="contributing-code">💻 Contributing Code<a class="headerlink" href="#contributing-code" title="Permanent link">#</a></h2>
|
||||
<p>Want to get your hands dirty with the code? Awesome! We appreciate all code contributions.</p>
|
||||
<ol>
|
||||
<li><strong>Fork the Repository:</strong> Start by forking
|
||||
the <a href="https://github.com/DigiLive/mushroom-strategy">DigiLive/mushroom-strategy</a> repository to your own GitHub
|
||||
account.</li>
|
||||
<li>
|
||||
<p><strong>Clone Your Fork:</strong> Clone your forked repository to your local machine.</p>
|
||||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/YOUR_USERNAME/mushroom-strategy.git
|
||||
<span class="nb">cd</span><span class="w"> </span>mushroom-strategy
|
||||
</code></pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Create a New Branch:</strong> Create a new branch for your feature or bug fix.<br />
|
||||
Use a descriptive name (e.g., <code>feature/my-awesome-feature</code>, <code>bugfix/fix-admonition-rendering</code>).</p>
|
||||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>feature/my-new-feature
|
||||
</code></pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Set up Development Environment:</strong></p>
|
||||
<ul>
|
||||
<li>Ensure you have Node.js and npm installed.</li>
|
||||
<li>Install project dependencies: <code>npm install</code></li>
|
||||
<li>You can build the strategy with <code>npm run build</code> (for production) or <code>npm run build-dev</code> (for development/testing).</li>
|
||||
<li>Copy the built files to your Home Assistant's <code>www/community/mushroom-strategy</code> folder for testing.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Make Your Changes:</strong> Implement your bug fix or new feature.</p>
|
||||
</li>
|
||||
<li><strong>Test Your Changes:</strong> Thoroughly test your changes to ensure they work as expected and don't introduce new issues.</li>
|
||||
<li>
|
||||
<p><strong>Commit Your Changes:</strong></p>
|
||||
<ul>
|
||||
<li>We follow <a href="https://www.conventionalcommits.org/en/v1.0.0/">Conventional Commits</a> for clear commit history.</li>
|
||||
<li>Example: <code>feat: add new card option</code> or <code>fix: correct card rendering issue</code></li>
|
||||
</ul>
|
||||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>add<span class="w"> </span>.
|
||||
git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"feat: add super cool new feature"</span>
|
||||
</code></pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Push to Your Fork:</strong></p>
|
||||
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>feature/my-new-feature
|
||||
</code></pre></div>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Create a Pull Request (PR):</strong></p>
|
||||
<ul>
|
||||
<li>Go to your forked repository on GitHub.</li>
|
||||
<li>You should see a prompt to create a pull request from your new branch to the <code>main</code> branch of
|
||||
<code>DigiLive/mushroom-strategy</code>.</li>
|
||||
<li>Provide a clear title and description for your PR, referencing any related issues.</li>
|
||||
<li>Be prepared to discuss your changes and address any feedback during the review process.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ol>
|
||||
<hr />
|
||||
<h2 id="improving-documentation">📄 Improving Documentation<a class="headerlink" href="#improving-documentation" title="Permanent link">#</a></h2>
|
||||
<p>Good documentation is vital! If you find typos, unclear sections, or want to add more examples, please open a pull
|
||||
request. The documentation is located in the <code>docs/</code> folder of this repository.</p>
|
||||
<hr />
|
||||
<h2 id="translations">🌐 Translations<a class="headerlink" href="#translations" title="Permanent link">#</a></h2>
|
||||
<p>Help us make Mushroom Strategy accessible to more users around the world by contributing and improving translations!</p>
|
||||
<p>Language tags have to follow <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>.<br />
|
||||
A list of most language tags can be found
|
||||
here: <a href="http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">IANA subtag registry</a>.
|
||||
Examples: fr, fr-CA, zh-Hans.</p>
|
||||
<ol>
|
||||
<li><strong>Check for Existing Translations:</strong> See if your language is already being worked on or exists.</li>
|
||||
<li><strong>Locate Translation Files:</strong> Language files are found within the <code>src/translations</code> directory.
|
||||
Each language has its own <code>locale.json</code> file (e.g., <code>en.json</code>, <code>nl.json</code>, <code>pt-BR.json</code>).</li>
|
||||
<li>
|
||||
<p><strong>Create or Update:</strong></p>
|
||||
<ul>
|
||||
<li><strong>To create a new language:</strong> Copy an existing <code>.json</code> file (e.g., <code>en.json</code>), rename it to your language
|
||||
code (e.g., <code>de.json</code> for German), and translate the property values.</li>
|
||||
<li><strong>To update an existing language:</strong> Open the <code>.json</code> file for your language and update any missing or
|
||||
outdated translations.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Submit a Pull Request:</strong> Once your translations are complete, submit a pull request with your changes. Clearly
|
||||
state which language you are contributing to or updating.</p>
|
||||
</li>
|
||||
</ol>
|
||||
<div class="admonition info">
|
||||
<p class="admonition-title">Info</p>
|
||||
<p><strong>Integrating a new Translation:</strong></p>
|
||||
<ul>
|
||||
<li>For your new language file to be picked up, it needs to be imported and registered at file
|
||||
<code>src/utilities/localize.ts</code>.</li>
|
||||
<li>You will need to add an <code>import</code> statement for your new <code>.json</code> file at the top, following the existing pattern.</li>
|
||||
<li>Then, you'll need to add it to the <code>languages</code> map, associating the language code with the imported module.</li>
|
||||
</ul>
|
||||
<p><strong>Special Handling for <code>language-country</code> Locales:</strong><br />
|
||||
If you are adding a country-specific locale (e.g., <code>es-ES</code> for Spanish (Spain) or <code>en-GB</code> for English
|
||||
(United Kingdom)), you should create a file like <code>en-GB.json</code> in the <code>translations</code> folder. In
|
||||
<code>src/utilities/localize.ts</code>, you'll import it similarly and add it to the <code>languages</code> map using the full locale
|
||||
code.<br />
|
||||
Please ensure you follow existing patterns for <code>language-country</code> codes, which typically use a hyphen (<code>-</code>) + a
|
||||
UPPER-cased country code in the file name and an underscore (<code>_</code>) + a lower-cased country code in the import key. </p>
|
||||
<div class="admonition example">
|
||||
<p class="admonition-title">Example</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="k">import</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="kr">as</span><span class="w"> </span><span class="nx">en</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'../translations/en.json'</span><span class="p">;</span>
|
||||
<span class="k">import</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="kr">as</span><span class="w"> </span><span class="nx">pt_br</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'../translations/pt-BR.json'</span><span class="p">;</span>
|
||||
|
||||
<span class="cm">/** Registry of currently supported languages */</span>
|
||||
<span class="kd">const</span><span class="w"> </span><span class="nx">languages</span><span class="o">:</span><span class="w"> </span><span class="kt">Record</span><span class="o"><</span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="nx">unknown</span><span class="o">></span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nx">en</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="s1">'pt-BR'</span><span class="o">:</span><span class="w"> </span><span class="nx">pt_br</span><span class="p">,</span>
|
||||
<span class="p">};</span>
|
||||
</code></pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<hr />
|
||||
<h2 id="get-support">🙏 Get Support<a class="headerlink" href="#get-support" title="Permanent link">#</a></h2>
|
||||
<p>If you have questions about contributing or need help with your setup, please open
|
||||
a <a href="https://github.com/DigiLive/mushroom-strategy/discussions">discussion</a> on our GitHub repository.</p>
|
||||
<p>If you have questions about contributing or need help with your setup, please open a
|
||||
<a href="https://github.com/DigiLive/mushroom-strategy/discussions">discussion</a> on our GitHub repository.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
+176
-9
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -744,9 +745,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -755,10 +772,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
+177
-10
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -749,9 +750,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -760,10 +777,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -789,7 +956,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="full-example-using-all-the-options-provided-with-the-strategy">Full example using all the options provided with the strategy<a class="headerlink" href="#full-example-using-all-the-options-provided-with-the-strategy" title="Permanent link">#</a></h1>
|
||||
<h1 id="full-example-using-all-the-options-provided-with-the-strategy">📝 Full example using all the options provided with the strategy<a class="headerlink" href="#full-example-using-all-the-options-provided-with-the-strategy" title="Permanent link">#</a></h1>
|
||||
<div class="highlight"><pre><span></span><code><span class="nt">strategy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">custom:mushroom-strategy</span>
|
||||
<span class="w"> </span><span class="nt">options</span><span class="p">:</span>
|
||||
|
||||
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -749,9 +750,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -760,10 +777,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -789,7 +956,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="basic-setup">Basic Setup<a class="headerlink" href="#basic-setup" title="Permanent link">#</a></h1>
|
||||
<h1 id="basic-setup">⚙️ Basic Setup<a class="headerlink" href="#basic-setup" title="Permanent link">#</a></h1>
|
||||
<p>To apply the Mushroom Strategy to a dashboard:</p>
|
||||
<ol>
|
||||
<li>In the UI of the dashboard, select <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75z"/></svg></span> in the top right corner.</li>
|
||||
@@ -799,17 +966,16 @@
|
||||
</ol>
|
||||
<div class="highlight"><pre><span></span><code><span class="nt">strategy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">custom:mushroom-strategy</span>
|
||||
<span class="nt">views</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span>
|
||||
</code></pre></div>
|
||||
<blockquote>
|
||||
<p>[!NOTE]
|
||||
You may see the following error:</p>
|
||||
</blockquote>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>You may see the following error:</p>
|
||||
<div class="highlight"><pre><span></span><code> Error loading the dashboard strategy:
|
||||
Error: Timeout waiting for strategy
|
||||
element ||-strategy-mushroom-strategy to
|
||||
be registered
|
||||
</code></pre></div>
|
||||
</div>
|
||||
<p>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.</p>
|
||||
<p>If it still doesn't work, please consult guide
|
||||
|
||||
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -506,7 +507,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#prerequisites" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Prerequisites
|
||||
⚙️ Prerequisites
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -515,7 +516,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#dashboard-installation" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Dashboard Installation
|
||||
🛠️ Dashboard Installation
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -524,7 +525,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#local-installation" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Local Installation
|
||||
🛠️ Local Installation
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -533,7 +534,7 @@
|
||||
<li class="md-nav__item">
|
||||
<a href="#updating" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Updating
|
||||
🔄 Updating
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -817,9 +818,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -828,10 +845,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -857,8 +1024,8 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h1>
|
||||
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">#</a></h2>
|
||||
<h1 id="installation">🚀 Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h1>
|
||||
<h2 id="prerequisites">⚙️ Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">#</a></h2>
|
||||
<p>Mushroom dashboard strategy and dependencies are available in <a href="https://hacs.xyz" target="_blank">HACS</a> (Home Assistant
|
||||
Community Store).<br />
|
||||
Install HACS if you don't have it already.<br />
|
||||
@@ -879,10 +1046,10 @@ They will open the HACS repository at your Home Assistant instance directly.</p>
|
||||
<a href="https://github.com/piitaya/lovelace-mushroom" target="_blank">Mushroom</a>.<br />
|
||||
<a href="https://my.home-assistant.io/redirect/hacs_repository/?owner=kalkih&repository=mini-graph-card&category=frontend" target="_blank"><img alt="Open in HACS at your Home Assistant instance." src="https://img.shields.io/badge/Open%20my%20HACS%20Repository-%2318BCF2?logo=homeassistant&logoColor=%23FFFFFF&labelColor=%2318BCF2" /></a> to
|
||||
install <a href="https://github.com/kalkih/mini-graph-card" target="_blank">Mini graph card</a>.</p>
|
||||
<h2 id="dashboard-installation">Dashboard Installation<a class="headerlink" href="#dashboard-installation" title="Permanent link">#</a></h2>
|
||||
<h2 id="dashboard-installation">🛠️ Dashboard Installation<a class="headerlink" href="#dashboard-installation" title="Permanent link">#</a></h2>
|
||||
<p>If you meet all the prerequisites, click the badge below to install the strategy.</p>
|
||||
<p><a href="https://my.home-assistant.io/redirect/hacs_repository/?owner=DigiLive&repository=mushroom-strategy&category=frontend" target="_blank"><img alt="Open in HACS at your Home Assistant instance." src="https://img.shields.io/badge/Open%20my%20HACS%20Repository-%2318BCF2?logo=homeassistant&logoColor=%23FFFFFF&labelColor=%2318BCF2" /></a></p>
|
||||
<h2 id="local-installation">Local Installation<a class="headerlink" href="#local-installation" title="Permanent link">#</a></h2>
|
||||
<h2 id="local-installation">🛠️ Local Installation<a class="headerlink" href="#local-installation" title="Permanent link">#</a></h2>
|
||||
<p>Please install the strategy with HACS as described above.<br />
|
||||
If you require testing a custom build for debug purposes, follow these steps:</p>
|
||||
<ol>
|
||||
@@ -894,7 +1061,7 @@ If you require testing a custom build for debug purposes, follow these steps:</p
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Refresh the cache of the client you use to access Home Assistant.</p>
|
||||
</div>
|
||||
<h2 id="updating">Updating<a class="headerlink" href="#updating" title="Permanent link">#</a></h2>
|
||||
<h2 id="updating">🔄 Updating<a class="headerlink" href="#updating" title="Permanent link">#</a></h2>
|
||||
<p>By default, Home Assistant will notify you when an update of the strategy is available.<br />
|
||||
You can update the strategy by going to <code>Settings</code> found at the bottom of the sidebar.</p>
|
||||
<div class="admonition tip">
|
||||
|
||||
+180
-13
@@ -314,17 +314,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -450,9 +451,9 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#previews" class="md-nav__link">
|
||||
<a href="#sneak-peak" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Previews
|
||||
👀 Sneak Peak
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -801,9 +802,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -812,10 +829,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -841,7 +1008,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="welcome-to-the-mushroom-strategy-documentation">Welcome to the Mushroom Strategy Documentation <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a10 10 0 0 1 10 10 2 2 0 0 1-2 2H4a2 2 0 0 1-2-2A10 10 0 0 1 12 2m0 6a2 2 0 0 0 2-2 2 2 0 0 0-2-2 2 2 0 0 0-2 2 2 2 0 0 0 2 2m5 4a2 2 0 0 0 2-2 2 2 0 0 0-2-2 2 2 0 0 0-2 2 2 2 0 0 0 2 2M7 12a2 2 0 0 0 2-2 2 2 0 0 0-2-2 2 2 0 0 0-2 2 2 2 0 0 0 2 2m8 3 1.27 4.45.08.55c0 1.1-.9 2-2 2h-4.7a2 2 0 0 1-2-2l.08-.55L9 15z"/></svg></span> <a class="headerlink" href="#welcome-to-the-mushroom-strategy-documentation" title="Permanent link">#</a></h1>
|
||||
<h1 id="welcome-to-the-mushroom-strategy-documentation"><img alt="🍄🟫" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/1f344-200d-1f7eb.svg" title=":brown_mushroom:" /> Welcome to the Mushroom Strategy Documentation<a class="headerlink" href="#welcome-to-the-mushroom-strategy-documentation" title="Permanent link">#</a></h1>
|
||||
<p><a href="https://github.com/DigiLive/mushroom-strategy/releases/tag/v2.3.2"><img alt="Release" src="https://img.shields.io/github/v/tag/digilive/mushroom-strategy?filter=v2.3.2&label=Release" /></a>
|
||||
<a href="https://hacs.xyz"><img alt="HACS" src="https://img.shields.io/badge/HACS-Default-blue" /></a>
|
||||
<a href="https://app.codacy.com/gh/DigiLive/mushroom-strategy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img alt="Codacy" src="https://app.codacy.com/project/badge/Grade/24de1e79aea445499917d9acd5ce9e04" /></a></p>
|
||||
@@ -888,7 +1055,7 @@ engage with the community!</p>
|
||||
<img alt="⭐" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2b50.svg" title=":star:" /> <a href="https://github.com/DigiLive/mushroom-strategy">star on GitHub</a> and exploring ways
|
||||
to <img alt="❤" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2764.svg" title=":heart:" /> <a href="https://github.com/sponsors/DigiLive">sponsor the project</a> to support its continued development! Your
|
||||
support helps us grow and improve.</p>
|
||||
<h2 id="previews">Previews<a class="headerlink" href="#previews" title="Permanent link">#</a></h2>
|
||||
<h2 id="sneak-peak">👀 Sneak Peak<a class="headerlink" href="#sneak-peak" title="Permanent link">#</a></h2>
|
||||
<p><img alt="Preview GIF" src="images/preview.gif" /></p>
|
||||
<details class="note">
|
||||
<summary>Click here for more images...</summary>
|
||||
|
||||
+180
-13
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -832,9 +833,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -843,10 +860,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -872,8 +1039,8 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="area-options">Area Options<a class="headerlink" href="#area-options" title="Permanent link">#</a></h1>
|
||||
<p>The <code>areas</code> group enables you to specify the configuration of specific areas.
|
||||
<h1 id="area-options">🛋️ Area Options<a class="headerlink" href="#area-options" title="Permanent link">#</a></h1>
|
||||
<p>The <code>areas</code> 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:</p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -924,7 +1091,7 @@ Please follow the links below to see the additional options per card type.</p>
|
||||
<li><a href="https://www.home-assistant.io/dashboards/area/#configuration-variables" target="_blank">Home Assistant Area Card</a>.</li>
|
||||
</ul>
|
||||
<h2 id="extra-cards">Extra Cards<a class="headerlink" href="#extra-cards" title="Permanent link">#</a></h2>
|
||||
<p>The <code>extra_cards</code> group enables you to specify the configuration of additional cards an Area view.
|
||||
<p>The <code>extra_cards</code> group enables you to specify the configuration of additional cards an Area view.<br />
|
||||
These cards will be shown last in the view.</p>
|
||||
<p>See Home View Options → <a href="#extra-cards">Extra Cards</a> for more information.</p>
|
||||
<h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
|
||||
@@ -983,7 +1150,7 @@ The following example sets the type of all area-cards to the one of Home Assista
|
||||
</code></pre></div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Area specific options take precedence over options set for all areas.!</p>
|
||||
<p>Area specific options take precedence over options set for all areas!</p>
|
||||
</div>
|
||||
<!-- References -->
|
||||
|
||||
|
||||
+178
-12
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -790,9 +791,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -801,10 +818,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -830,7 +997,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="card-options">Card Options<a class="headerlink" href="#card-options" title="Permanent link">#</a></h1>
|
||||
<h1 id="card-options"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.19 2.25c-.26 0-.52.06-.77.15L3.06 5.45a1.994 1.994 0 0 0-1.09 2.6L6.93 20a2 2 0 0 0 1.81 1.25c.26 0 .53-.03.79-.15l7.37-3.05a2.02 2.02 0 0 0 1.23-1.8c.01-.25-.04-.54-.13-.8L13 3.5a1.95 1.95 0 0 0-1.81-1.25m3.48 0 3.45 8.35V4.25a2 2 0 0 0-2-2m4.01 1.54v9.03l2.43-5.86a1.99 1.99 0 0 0-1.09-2.6m-10.28-.14 4.98 12.02-7.39 3.06L3.8 7.29"/></svg></span> Card Options<a class="headerlink" href="#card-options" title="Permanent link">#</a></h1>
|
||||
<p>The <code>card_options</code> group enables you to specify the configuration of entity cards.
|
||||
Each configuration is identified by an entity id and can have the following options:</p>
|
||||
<table>
|
||||
@@ -881,8 +1048,7 @@ Each configuration is identified by an entity id and can have the following opti
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>You can build your card at another dashboard and copy the <code>cards</code> group from the YAML of that dashboard into group
|
||||
<code>card_options</code> of the strategy configuration.<br />
|
||||
The YAML can be found in the Raw configuration editor.</p>
|
||||
<code>card_options</code> of the strategy configuration. The YAML can be found in the Raw configuration editor.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -799,9 +800,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -810,10 +827,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -839,8 +1006,8 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="domain-options">Domain Options<a class="headerlink" href="#domain-options" title="Permanent link">#</a></h1>
|
||||
<p>The <code>domains</code> group enables you to specify the configuration of a domain in a view.
|
||||
<h1 id="domain-options">💡 Domain Options<a class="headerlink" href="#domain-options" title="Permanent link">#</a></h1>
|
||||
<p>The <code>domains</code> 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:</p>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -925,9 +926,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -936,10 +953,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -965,7 +1132,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="home-view-options">Home View Options<a class="headerlink" href="#home-view-options" title="Permanent link">#</a></h1>
|
||||
<h1 id="home-view-options">🏠 Home View Options<a class="headerlink" href="#home-view-options" title="Permanent link">#</a></h1>
|
||||
<p>The <code>home_view</code> group enables you to specify the configuration of the Home view.</p>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1012,7 +1179,7 @@
|
||||
</code></pre></div>
|
||||
<hr />
|
||||
<h2 id="stack-count">Stack Count<a class="headerlink" href="#stack-count" title="Permanent link">#</a></h2>
|
||||
<p>The <code>stack_count</code> option is a map of sections to define the number of cards per row.
|
||||
<p>The <code>stack_count</code> 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.</p>
|
||||
<p>The <code>areas</code> 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
|
||||
@@ -1026,7 +1193,7 @@ The first number is the number of default cards per row, while the second number
|
||||
</code></pre></div>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Section specific options take precedence over options set for all sections.!</p>
|
||||
<p>Section specific options take precedence over options set for all sections!</p>
|
||||
</div>
|
||||
<hr />
|
||||
<h2 id="chip-options">Chip Options<a class="headerlink" href="#chip-options" title="Permanent link">#</a></h2>
|
||||
@@ -1141,8 +1308,7 @@ These cards will be shown between the greeting card and area cards.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>You can build your view in a temporary dashboard and copy the <code>views</code> group from the YAML of that dashboard into
|
||||
group <code>extra_views</code> of the strategy configuration.<br />
|
||||
The YAML can be found in the Raw configuration editor.</p>
|
||||
group <code>extra_views</code> of the strategy configuration. The YAML can be found in the Raw configuration editor.</p>
|
||||
</div>
|
||||
<h3 id="example_4">Example<a class="headerlink" href="#example_4" title="Permanent link">#</a></h3>
|
||||
<div class="highlight"><pre><span></span><code><span class="nt">strategy</span><span class="p">:</span>
|
||||
@@ -1170,8 +1336,7 @@ These cards will be shown below the areas.</p>
|
||||
<div class="admonition tip">
|
||||
<p class="admonition-title">Tip</p>
|
||||
<p>You can build your view in a temporary dashboard and copy the <code>views</code> group from the YAML of that dashboard into
|
||||
group <code>extra_cards</code> of the strategy configuration.<br />
|
||||
The YAML can be found in the Raw configuration editor.</p>
|
||||
group <code>extra_cards</code> of the strategy configuration. The YAML can be found in the Raw configuration editor.</p>
|
||||
</div>
|
||||
<h4 id="example_5">Example<a class="headerlink" href="#example_5" title="Permanent link">#</a></h4>
|
||||
<div class="highlight"><pre><span></span><code><span class="nt">strategy</span><span class="p">:</span>
|
||||
|
||||
+177
-10
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -790,9 +791,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -801,10 +818,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -830,7 +997,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">#</a></h1>
|
||||
<h1 id="overview">⚙️ Overview<a class="headerlink" href="#overview" title="Permanent link">#</a></h1>
|
||||
<p>The dashboard can be highly customized using the <code>options</code> parameter in the yaml configuration of your dashboard.</p>
|
||||
<div class="highlight"><pre><span></span><code><span class="nt">strategy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">custom:mushroom-strategy</span>
|
||||
|
||||
+177
-10
@@ -316,17 +316,18 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-tabs__item">
|
||||
<a href="../../contributing/" class="md-tabs__link">
|
||||
|
||||
|
||||
|
||||
Contributing
|
||||
|
||||
</a>
|
||||
</li>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -814,9 +815,25 @@
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--nested">
|
||||
|
||||
|
||||
|
||||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
||||
|
||||
|
||||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
@@ -825,10 +842,160 @@
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
||||
<label class="md-nav__title" for="__nav_5">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Contributing
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-scrollfix>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
🤝 Contributing to Mushroom Strategy
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/getting-started/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Getting Started
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/workflow/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Workflow
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/code/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Code
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/documentation/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Documentation
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../contributing/translations/" class="md-nav__link">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Translations
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
@@ -854,7 +1021,7 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="view-options">View Options<a class="headerlink" href="#view-options" title="Permanent link">#</a></h1>
|
||||
<h1 id="view-options">👀 View Options<a class="headerlink" href="#view-options" title="Permanent link">#</a></h1>
|
||||
<p>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.</p>
|
||||
<p>The following views are supported and enabled by default:</p>
|
||||
|
||||
@@ -1 +1 @@
|
||||
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the Mushroom Strategy Documentation","text":"<p>The Mushroom Strategy is an innovative solution for Home Assistant that empowers you to effortlessly create beautiful, intuitive, and automatically generated dashboards using the popular Mushroom cards.</p> <p>Say goodbye to tedious manual YAML configuration for every card! With the Mushroom Strategy, you can define your entities, areas, and devices and let the strategy intelligently build a dynamic and responsive dashboard tailored to your smart home.</p>"},{"location":"#key-features-benefits","title":"\u2728 Key Features & Benefits","text":"<ul> <li>Automated Dashboard Generation: Create a comprehensive dashboard with minimal YAML, saving you countless hours.</li> <li>Leverages Mushroom Cards: Enjoy the stunning aesthetics and rich functionality of Mushroom cards, renowned for their clean design and user-friendliness.</li> <li>Entity, Device, and Area-Aware: Automatically organizes your Home Assistant components into logical, navigable views.</li> <li>Built-in Views: Access pre-built views for specific domains like lights, fans, climate, and more, ensuring quick control.</li> <li>Highly Customizable: While automated, the strategy provides ample options to fine-tune the appearance and behavior to match your preferences.</li> <li>Responsive Design: Your generated dashboard will look great and function seamlessly across all devices \u2013 mobile, tablet, and desktop.</li> <li>Mini Graph: Utilize Mini Graphs to visualize data of sensors.</li> <li>Stateful Scenes Support: Support for stateful scenes from Stateful Scenes.</li> </ul>"},{"location":"#get-started-in-minutes","title":"\ud83d\ude80 Get Started in Minutes","text":"<p>Ready to transform your Home Assistant interface? Follow these guides to get your Mushroom Strategy dashboard up and running:</p> <ul> <li>Installation Guide: Step-by-step instructions to install the strategy via HACS or manually.</li> <li>Basic Setup: Learn the fundamental configuration to generate your first dashboard.</li> <li>Configuration Options: Dive deeper into all available settings to customize your dashboard to perfection.</li> <li>Usage Example: An example to show most of the configuration options.</li> </ul> <p>We're excited for you to experience the simplicity and power of the Mushroom Strategy. If you have questions, encounter issues, or want to contribute, please visit our GitHub repository and engage with the community!</p> <p>Enjoying the Mushroom Strategy? Consider giving our project a star on GitHub and exploring ways to sponsor the project to support its continued development! Your support helps us grow and improve.</p>"},{"location":"#previews","title":"Previews","text":"Click here for more images..."},{"location":"contributing/","title":"\ud83e\udd1d Contributing to Mushroom Strategy","text":"<p>We love contributions from the community! Whether you're reporting a bug, suggesting a new feature, or submitting code changes, your help makes the Mushroom Strategy better for everyone.</p> <p>Please take a moment to review this guide before making a contribution.</p>"},{"location":"contributing/#code-of-conduct","title":"\ud83d\udcdc Code of Conduct","text":"<p>To ensure a welcoming and inclusive environment, all contributors are expected to adhere to our Code of Conduct. Please read it carefully.</p>"},{"location":"contributing/#reporting-bugs","title":"\ud83d\udc1e Reporting Bugs","text":"<p>Found a bug? That's not ideal, but your report helps us squash it!</p> <ol> <li>Check existing issues: Before opening a new issue, please search our GitHub Issues or Discussions to see if the bug has already been reported.</li> <li>Open a new issue: If it's a new bug, please open a new issue.</li> <li> <p>Provide details: In your report, please include:</p> </li> <li> <p>A clear and concise description of the bug.</p> </li> <li>Steps to reproduce the behavior.</li> <li>Expected behavior.</li> <li>Screenshots or animated GIFs (if applicable).</li> <li>Your Home Assistant version and Mushroom Strategy version.</li> </ol>"},{"location":"contributing/#suggesting-features","title":"\u2728 Suggesting Features","text":"<p>Have a great idea for a new feature or enhancement? We'd love to hear it!</p> <ol> <li>Check existing suggestions: Search our GitHub Issues or Discussions to see if the feature has already been requested.</li> <li>Open a new issue: If it's a new idea, open a new issue.</li> <li>Describe your idea: Clearly explain the feature, why you think it's useful, and any potential use cases.</li> </ol>"},{"location":"contributing/#contributing-code","title":"\ud83d\udcbb Contributing Code","text":"<p>Want to get your hands dirty with the code? Awesome! We appreciate all code contributions.</p> <ol> <li>Fork the Repository: Start by forking the DigiLive/mushroom-stratLine truncated
|
||||
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the Mushroom Strategy Documentation","text":"<p>The Mushroom Strategy is an innovative solution for Home Assistant that empowers you to effortlessly create beautiful, intuitive, and automatically generated dashboards using the popular Mushroom cards.</p> <p>Say goodbye to tedious manual YAML configuration for every card! With the Mushroom Strategy, you can define your entities, areas, and devices and let the strategy intelligently build a dynamic and responsive dashboard tailored to your smart home.</p>"},{"location":"#key-features-benefits","title":"\u2728 Key Features & Benefits","text":"<ul> <li>Automated Dashboard Generation: Create a comprehensive dashboard with minimal YAML, saving you countless hours.</li> <li>Leverages Mushroom Cards: Enjoy the stunning aesthetics and rich functionality of Mushroom cards, renowned for their clean design and user-friendliness.</li> <li>Entity, Device, and Area-Aware: Automatically organizes your Home Assistant components into logical, navigable views.</li> <li>Built-in Views: Access pre-built views for specific domains like lights, fans, climate, and more, ensuring quick control.</li> <li>Highly Customizable: While automated, the strategy provides ample options to fine-tune the appearance and behavior to match your preferences.</li> <li>Responsive Design: Your generated dashboard will look great and function seamlessly across all devices \u2013 mobile, tablet, and desktop.</li> <li>Mini Graph: Utilize Mini Graphs to visualize data of sensors.</li> <li>Stateful Scenes Support: Support for stateful scenes from Stateful Scenes.</li> </ul>"},{"location":"#get-started-in-minutes","title":"\ud83d\ude80 Get Started in Minutes","text":"<p>Ready to transform your Home Assistant interface? Follow these guides to get your Mushroom Strategy dashboard up and running:</p> <ul> <li>Installation Guide: Step-by-step instructions to install the strategy via HACS or manually.</li> <li>Basic Setup: Learn the fundamental configuration to generate your first dashboard.</li> <li>Configuration Options: Dive deeper into all available settings to customize your dashboard to perfection.</li> <li>Usage Example: An example to show most of the configuration options.</li> </ul> <p>We're excited for you to experience the simplicity and power of the Mushroom Strategy. If you have questions, encounter issues, or want to contribute, please visit our GitHub repository and engage with the community!</p> <p>Enjoying the Mushroom Strategy? Consider giving our project a star on GitHub and exploring ways to sponsor the project to support its continued development! Your support helps us grow and improve.</p>"},{"location":"#sneak-peak","title":"\ud83d\udc40 Sneak Peak","text":"Click here for more images..."},{"location":"faq/","title":"Frequently Asked Questions","text":"How do I add a device or entity to an area? <p>You can add devices to an area by going to <code>Settings</code> found at the bottom of the sidebar.</p> <ol> <li>Select <code>Devices & services</code>.</li> <li>Select <code>Devices</code> or <code>Entities</code>at the top.</li> <li>Choose the device or entity you wish to add to an area.</li> <li>Select or in the top right corner.</li> <li>Choose an area in the area field.</li> </ol> <p>Warning</p> <p>If you created an entity manually (in your <code>configuration.yaml</code>), you may need to create a <code>unique_id</code> before you can set an area to it. See Home Assistant's documentation for more info about unique ids.</p> How do I hide entities from the Strategy? <p>When creating this dashboard for the first time, you might be overwhelmed by the number of entities. To reduce the number of entities shown, you can hide these entities by following the steps below:</p> <ol> <li>Click and hold the entity.</li> <li>Click in the top right corner of the popup.</li> <li>Set <code>Visible</code> to <code>off</code>.</li> </ol> <p>Note</p> <p>If you don't want to hide the entity from all dashboards, you can use Card Options to hide specific entities and devices.</p> How do I get the id of entities, devices and areas? <ul> <li> <p>Entity Id</p> <ol> <li>Select <code>Settings</code> at the bottom of the sidebar.</li> <li>Select <code>Devices & services</code>.</li> <li>Select <code>Entities</code> at the top.</li> <li>Choose the entity you want to get the id of.</li> <li>Click in the top right corner of the popup.</li> </ol> </li> <li> <p>Device Id</p> <ol> <li>Select <code>Settings</code> at the bottom of the sidebar.</li> <li>Select <code>Devices & services</code>.</li> <li>Select <code>Devices</code> at the top.</li> <li>Select the device you want to get the id of.</li> <li>The device id is shown as the last part of the url in the address bar. E.g.: <code>https://.../config/devices/device/h55b6k54j76g56</code></li> </ol> </li> <li>Line truncated
|
||||
+35
-15
@@ -2,50 +2,70 @@
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/contributing/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/faq/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/full-example/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/contributing/</loc>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/contributing/code/</loc>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/contributing/documentation/</loc>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/contributing/getting-started/</loc>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/contributing/translations/</loc>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/contributing/workflow/</loc>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/getting-started/basic-setup/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/getting-started/installation/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/options/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/options/area-options/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/options/card-options/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/options/domain-options/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/options/home-view-options/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
<url>
|
||||
<loc>https://digilive.github.io/mushroom-strategy/options/view-options/</loc>
|
||||
<lastmod>2025-05-28</lastmod>
|
||||
<lastmod>2025-05-31</lastmod>
|
||||
</url>
|
||||
</urlset>
|
||||
Binary file not shown.
Reference in new issue
Block a user