forked from DigiLive/mushroom-strategy
Continuous Integration - Deploy Documentation
This commit is contained in:
179
404.html
179
404.html
@@ -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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -721,8 +722,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -732,11 +749,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
|
1060
contributing/code/index.html
Normal file
1060
contributing/code/index.html
Normal file
File diff suppressed because it is too large
Load Diff
1133
contributing/documentation/index.html
Normal file
1133
contributing/documentation/index.html
Normal file
File diff suppressed because it is too large
Load Diff
1114
contributing/getting-started/index.html
Normal file
1114
contributing/getting-started/index.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -18,13 +18,15 @@
|
|||||||
<link rel="prev" href="../faq/">
|
<link rel="prev" href="../faq/">
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="next" href="getting-started/">
|
||||||
|
|
||||||
|
|
||||||
<link rel="icon" href="../assets/images/favicon.png">
|
<link rel="icon" href="../assets/images/favicon.png">
|
||||||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
|
<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">
|
<div class="md-header__topic" data-md-component="header-topic">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
|
|
||||||
Contributing
|
🤝 Contributing to Mushroom Strategy
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</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">
|
<li class="md-nav__item md-nav__item--active">
|
||||||
|
|
||||||
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||||||
@@ -747,7 +798,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
Contributing
|
🤝 Contributing to Mushroom Strategy
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
|
|
||||||
@@ -760,7 +811,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
Contributing
|
🤝 Contributing to Mushroom Strategy
|
||||||
|
|
||||||
</span>
|
</span>
|
||||||
|
|
||||||
@@ -807,33 +858,6 @@
|
|||||||
</span>
|
</span>
|
||||||
</a>
|
</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>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
@@ -853,6 +877,129 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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>
|
<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>
|
</a>
|
||||||
@@ -896,7 +1043,7 @@ carefully.</p>
|
|||||||
<li><strong>Open a new issue:</strong> If it's a new bug, please open
|
<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>
|
a <a href="https://github.com/DigiLive/mushroom-strategy/issues/new?template=bug_report.yml">new issue</a>.</li>
|
||||||
<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>
|
||||||
<li>
|
<li>
|
||||||
<p>A clear and concise description of the bug.</p>
|
<p>A clear and concise description of the bug.</p>
|
||||||
@@ -915,128 +1062,13 @@ carefully.</p>
|
|||||||
requested.</li>
|
requested.</li>
|
||||||
<li><strong>Open a new issue:</strong> If it's a new idea, open
|
<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>
|
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>
|
</ol>
|
||||||
<hr />
|
<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>
|
<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
|
<p>If you have questions about contributing or need help with your setup, please open a
|
||||||
a <a href="https://github.com/DigiLive/mushroom-strategy/discussions">discussion</a> on our GitHub repository.</p>
|
<a href="https://github.com/DigiLive/mushroom-strategy/discussions">discussion</a> on our GitHub repository.</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
1097
contributing/translations/index.html
Normal file
1097
contributing/translations/index.html
Normal file
File diff suppressed because it is too large
Load Diff
1064
contributing/workflow/index.html
Normal file
1064
contributing/workflow/index.html
Normal file
File diff suppressed because it is too large
Load Diff
179
faq/index.html
179
faq/index.html
@@ -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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -744,8 +745,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -755,11 +772,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -749,8 +750,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -760,11 +777,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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>
|
<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">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>
|
<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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -749,8 +750,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -760,11 +777,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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>
|
<p>To apply the Mushroom Strategy to a dashboard:</p>
|
||||||
<ol>
|
<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>
|
<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>
|
</ol>
|
||||||
<div class="highlight"><pre><span></span><code><span class="nt">strategy</span><span class="p">:</span>
|
<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">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>
|
</code></pre></div>
|
||||||
<blockquote>
|
<div class="admonition warning">
|
||||||
<p>[!NOTE]
|
<p class="admonition-title">Warning</p>
|
||||||
You may see the following error:</p>
|
<p>You may see the following error:</p>
|
||||||
</blockquote>
|
|
||||||
<div class="highlight"><pre><span></span><code> Error loading the dashboard strategy:
|
<div class="highlight"><pre><span></span><code> Error loading the dashboard strategy:
|
||||||
Error: Timeout waiting for strategy
|
Error: Timeout waiting for strategy
|
||||||
element ||-strategy-mushroom-strategy to
|
element ||-strategy-mushroom-strategy to
|
||||||
be registered
|
be registered
|
||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
|
</div>
|
||||||
<p>This is mainly because of cache issues or HACS didn't create a reference.<br />
|
<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>
|
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
|
<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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -506,7 +507,7 @@
|
|||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#prerequisites" class="md-nav__link">
|
<a href="#prerequisites" class="md-nav__link">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
Prerequisites
|
⚙️ Prerequisites
|
||||||
</span>
|
</span>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@@ -515,7 +516,7 @@
|
|||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#dashboard-installation" class="md-nav__link">
|
<a href="#dashboard-installation" class="md-nav__link">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
Dashboard Installation
|
🛠️ Dashboard Installation
|
||||||
</span>
|
</span>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@@ -524,7 +525,7 @@
|
|||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#local-installation" class="md-nav__link">
|
<a href="#local-installation" class="md-nav__link">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
Local Installation
|
🛠️ Local Installation
|
||||||
</span>
|
</span>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@@ -533,7 +534,7 @@
|
|||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#updating" class="md-nav__link">
|
<a href="#updating" class="md-nav__link">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
Updating
|
🔄 Updating
|
||||||
</span>
|
</span>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@@ -817,8 +818,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -828,11 +845,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -857,8 +1024,8 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h1>
|
<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>
|
<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
|
<p>Mushroom dashboard strategy and dependencies are available in <a href="https://hacs.xyz" target="_blank">HACS</a> (Home Assistant
|
||||||
Community Store).<br />
|
Community Store).<br />
|
||||||
Install HACS if you don't have it already.<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://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
|
<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>
|
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>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>
|
<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 />
|
<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>
|
If you require testing a custom build for debug purposes, follow these steps:</p>
|
||||||
<ol>
|
<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 class="admonition-title">Note</p>
|
||||||
<p>Refresh the cache of the client you use to access Home Assistant.</p>
|
<p>Refresh the cache of the client you use to access Home Assistant.</p>
|
||||||
</div>
|
</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 />
|
<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>
|
You can update the strategy by going to <code>Settings</code> found at the bottom of the sidebar.</p>
|
||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
|
187
index.html
187
index.html
@@ -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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -450,9 +451,9 @@
|
|||||||
</li>
|
</li>
|
||||||
|
|
||||||
<li class="md-nav__item">
|
<li class="md-nav__item">
|
||||||
<a href="#previews" class="md-nav__link">
|
<a href="#sneak-peak" class="md-nav__link">
|
||||||
<span class="md-ellipsis">
|
<span class="md-ellipsis">
|
||||||
Previews
|
👀 Sneak Peak
|
||||||
</span>
|
</span>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
@@ -801,8 +802,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -812,11 +829,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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>
|
<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://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>
|
<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
|
<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
|
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>
|
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>
|
<p><img alt="Preview GIF" src="images/preview.gif" /></p>
|
||||||
<details class="note">
|
<details class="note">
|
||||||
<summary>Click here for more images...</summary>
|
<summary>Click here for more images...</summary>
|
||||||
|
@@ -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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -832,8 +833,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -843,11 +860,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -872,8 +1039,8 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="area-options">Area Options<a class="headerlink" href="#area-options" title="Permanent link">#</a></h1>
|
<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.
|
<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>
|
Each configuration is identified by an area id and can have the following options:</p>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<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>
|
<li><a href="https://www.home-assistant.io/dashboards/area/#configuration-variables" target="_blank">Home Assistant Area Card</a>.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h2 id="extra-cards">Extra Cards<a class="headerlink" href="#extra-cards" title="Permanent link">#</a></h2>
|
<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>
|
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>
|
<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>
|
<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>
|
</code></pre></div>
|
||||||
<div class="admonition note">
|
<div class="admonition note">
|
||||||
<p class="admonition-title">Note</p>
|
<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>
|
</div>
|
||||||
<!-- References -->
|
<!-- References -->
|
||||||
|
|
||||||
|
@@ -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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -790,8 +791,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -801,11 +818,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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.
|
<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>
|
Each configuration is identified by an entity id and can have the following options:</p>
|
||||||
<table>
|
<table>
|
||||||
@@ -881,8 +1048,7 @@ Each configuration is identified by an entity id and can have the following opti
|
|||||||
<div class="admonition tip">
|
<div class="admonition tip">
|
||||||
<p class="admonition-title">Tip</p>
|
<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
|
<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 />
|
<code>card_options</code> of the strategy configuration. The YAML can be found in the Raw configuration editor.</p>
|
||||||
The YAML can be found in the Raw configuration editor.</p>
|
|
||||||
</div>
|
</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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -799,8 +800,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -810,11 +827,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -839,8 +1006,8 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h1 id="domain-options">Domain Options<a class="headerlink" href="#domain-options" title="Permanent link">#</a></h1>
|
<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.
|
<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>
|
Each configuration is identified by a domain name and can have the following options:</p>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -925,8 +926,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -936,11 +953,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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>
|
<p>The <code>home_view</code> group enables you to specify the configuration of the Home view.</p>
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
@@ -1012,7 +1179,7 @@
|
|||||||
</code></pre></div>
|
</code></pre></div>
|
||||||
<hr />
|
<hr />
|
||||||
<h2 id="stack-count">Stack Count<a class="headerlink" href="#stack-count" title="Permanent link">#</a></h2>
|
<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>
|
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 />
|
<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
|
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>
|
</code></pre></div>
|
||||||
<div class="admonition note">
|
<div class="admonition note">
|
||||||
<p class="admonition-title">Note</p>
|
<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>
|
</div>
|
||||||
<hr />
|
<hr />
|
||||||
<h2 id="chip-options">Chip Options<a class="headerlink" href="#chip-options" title="Permanent link">#</a></h2>
|
<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">
|
<div class="admonition tip">
|
||||||
<p class="admonition-title">Tip</p>
|
<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
|
<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 />
|
group <code>extra_views</code> of the strategy configuration. The YAML can be found in the Raw configuration editor.</p>
|
||||||
The YAML can be found in the Raw configuration editor.</p>
|
|
||||||
</div>
|
</div>
|
||||||
<h3 id="example_4">Example<a class="headerlink" href="#example_4" title="Permanent link">#</a></h3>
|
<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>
|
<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">
|
<div class="admonition tip">
|
||||||
<p class="admonition-title">Tip</p>
|
<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
|
<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 />
|
group <code>extra_cards</code> of the strategy configuration. The YAML can be found in the Raw configuration editor.</p>
|
||||||
The YAML can be found in the Raw configuration editor.</p>
|
|
||||||
</div>
|
</div>
|
||||||
<h4 id="example_5">Example<a class="headerlink" href="#example_5" title="Permanent link">#</a></h4>
|
<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>
|
<div class="highlight"><pre><span></span><code><span class="nt">strategy</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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -790,8 +791,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -801,11 +818,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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>
|
<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>
|
<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">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">custom:mushroom-strategy</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
|
Contributing
|
||||||
|
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -814,8 +815,24 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -825,11 +842,161 @@
|
|||||||
</span>
|
</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>
|
</a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
@@ -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 />
|
<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>
|
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>
|
<p>The following views are supported and enabled by default:</p>
|
||||||
|
File diff suppressed because one or more lines are too long
50
sitemap.xml
50
sitemap.xml
@@ -2,50 +2,70 @@
|
|||||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/</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-28</lastmod>
|
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/faq/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/faq/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/full-example/</loc>
|
<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>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/getting-started/basic-setup/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/getting-started/basic-setup/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/getting-started/installation/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/getting-started/installation/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/options/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/options/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/options/area-options/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/options/area-options/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/options/card-options/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/options/card-options/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/options/domain-options/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/options/domain-options/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/options/home-view-options/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/options/home-view-options/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://digilive.github.io/mushroom-strategy/options/view-options/</loc>
|
<loc>https://digilive.github.io/mushroom-strategy/options/view-options/</loc>
|
||||||
<lastmod>2025-05-28</lastmod>
|
<lastmod>2025-05-31</lastmod>
|
||||||
</url>
|
</url>
|
||||||
</urlset>
|
</urlset>
|
BIN
sitemap.xml.gz
BIN
sitemap.xml.gz
Binary file not shown.
Reference in New Issue
Block a user