Skip to content

Commit

Permalink
Deployed 6898faa to main with MkDocs 1.5.3 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Oct 20, 2023
1 parent 198c629 commit b1afecb
Show file tree
Hide file tree
Showing 3 changed files with 145 additions and 8 deletions.
2 changes: 1 addition & 1 deletion main/search/search_index.json
View file

Large diffs are not rendered by default.

Binary file modified main/sitemap.xml.gz
View file
Binary file not shown.
151 changes: 144 additions & 7 deletions main/widgets/services/calendar/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">


<a href="#monthly-view" class="md-skip">
Skip to content
</a>

</div>
<div data-md-component="announce">

Expand Down Expand Up @@ -1474,6 +1479,23 @@



<label class="md-nav__link md-nav__link--active" for="__toc">


<span class="md-ellipsis">


Calendar



</span>



<span class="md-nav__icon md-icon"></span>
</label>

<a href="./" class="md-nav__link md-nav__link--active">


Expand All @@ -1490,6 +1512,62 @@

</a>



<nav class="md-nav md-nav--secondary" aria-label="Table of contents">




<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#monthly-view" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Monthly view
</span>

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#agenda" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Agenda
</span>

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#integrations" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Integrations
</span>

</span>
</a>

</li>

</ul>

</nav>

</li>


Expand Down Expand Up @@ -4510,6 +4588,53 @@



<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#monthly-view" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Monthly view
</span>

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#agenda" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Agenda
</span>

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#integrations" class="md-nav__link">
<span class="md-ellipsis">

<span class="md-typeset">
Integrations
</span>

</span>
</a>

</li>

</ul>

</nav>
</div>
</div>
Expand All @@ -4534,19 +4659,31 @@

<h1>Calendar</h1>

<h2 id="monthly-view">Monthly view</h2>
<p><img alt="calendar" src="https://user-images.githubusercontent.com/5442891/271131282-6767a3ea-573e-4005-aeb9-6e14ee01e845.png"></p>
<p>This widget shows monthly calendar, with optional integrations to show events from supported widgets.</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">widget</span><span class="p">:</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><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">calendar</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">firstDayInWeek</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">sunday</span><span class="w"> </span><span class="c1"># optional - defaults to monday</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">integrations</span><span class="p">:</span><span class="w"> </span><span class="c1"># optional</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="p p-Indicator">-</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">sonarr</span><span class="w"> </span><span class="c1"># active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="nt">service_group</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Media</span><span class="w"> </span><span class="c1"># group name where widget exists</span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="nt">service_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Sonarr</span><span class="w"> </span><span class="c1"># service name for that widget</span>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="nt">color</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">teal</span><span class="w"> </span><span class="c1"># optional - defaults to pre-defined color for the service (teal for sonarr)</span>
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span><span class="nt">params</span><span class="p">:</span><span class="w"> </span><span class="c1"># optional - additional params for the service</span>
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="nt">unmonitored</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># optional - defaults to false, used with *arr stack</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">view</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">monthly</span><span class="w"> </span><span class="c1"># optional - possible values monthly, agenda</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="nt">maxEvents</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># optional - defaults to 10</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="nt">integrations</span><span class="p">:</span><span class="w"> </span><span class="c1"># optional</span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="p p-Indicator">-</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">sonarr</span><span class="w"> </span><span class="c1"># active widget type that is currently enabled on homepage - possible values: radarr, sonarr, lidarr, readarr</span>
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="nt">service_group</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Media</span><span class="w"> </span><span class="c1"># group name where widget exists</span>
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span><span class="nt">service_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Sonarr</span><span class="w"> </span><span class="c1"># service name for that widget</span>
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="nt">color</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">teal</span><span class="w"> </span><span class="c1"># optional - defaults to pre-defined color for the service (teal for sonarr)</span>
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w"> </span><span class="nt">params</span><span class="p">:</span><span class="w"> </span><span class="c1"># optional - additional params for the service</span>
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w"> </span><span class="nt">unmonitored</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># optional - defaults to false, used with *arr stack</span>
</span></code></pre></div>
<h2 id="agenda">Agenda</h2>
<p>This view shows only list of events from configured integrations</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">widget</span><span class="p">:</span>
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><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">calendar</span>
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">view</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">agenda</span>
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">maxEvents</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># optional - defaults to 10</span>
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt">integrations</span><span class="p">:</span><span class="w"> </span><span class="c1"># same as in Monthly view example</span>
</span></code></pre></div>
<h2 id="integrations">Integrations</h2>
<p>Currently integrated widgets are <a href="../sonarr/">sonarr</a>, <a href="../radarr/">radarr</a>, <a href="../lidarr/">lidarr</a> and <a href="../readarr/">readarr</a>.</p>
<p>Supported colors can be found on <a href="../../../configs/settings/#color-palette">color palette</a>.</p>

Expand Down

0 comments on commit b1afecb

Please sign in to comment.