mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Additional data into documentation
This commit is contained in:
@@ -59,7 +59,7 @@
|
||||
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/git/" class="disabled">Git</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
|
||||
@@ -97,7 +97,7 @@
|
||||
|
||||
|
||||
<br/>
|
||||
<i class="fas fa-clock"></i> 1 min read
|
||||
<i class="fas fa-clock"></i> 2 min read
|
||||
</span>
|
||||
</div>
|
||||
|
||||
@@ -105,6 +105,11 @@
|
||||
|
||||
<h2 id="description">Description</h2>
|
||||
|
||||
<p>Displays a configurable list of current weather report, including
|
||||
current temperature, sunrise time, and sunset time.</p>
|
||||
|
||||
<p><img src="/imgs/modules/weather.png" width="320" height="187" alt="weather screenshot" /></p>
|
||||
|
||||
<h2 id="source-code">Source Code</h2>
|
||||
|
||||
<pre><code class="language-bash">wtf/weather/
|
||||
@@ -135,6 +140,7 @@
|
||||
<h2 id="configuration">Configuration</h2>
|
||||
|
||||
<pre><code class="language-yaml">weather:
|
||||
# From http://openweathermap.org/help/city_list.txt
|
||||
cityids:
|
||||
- 6173331
|
||||
- 3128760
|
||||
@@ -155,6 +161,36 @@
|
||||
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<p><code>cityids</code> <br />
|
||||
A list of the <a
|
||||
href="http://openweathermap.org/help/city_list.txt">OpenWeatherMap city
|
||||
IDs</a> for the cities you want to view. <br />
|
||||
Values: A list of positive integers, <code>0..n</code></p>
|
||||
|
||||
<p><code>colors.current</code> <br />
|
||||
The color to highlight the current temperature in. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.</p>
|
||||
|
||||
<p><code>enabled</code> <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: <code>true</code>, <code>false</code>.</p>
|
||||
|
||||
<p><code>language</code> <br />
|
||||
The human language in which to present the weather data. <br />
|
||||
Values: Any <a href="https://openweathermap.org/current">language identifier</a> specified by OpenWeatherMap.</p>
|
||||
|
||||
<p><code>position</code> <br />
|
||||
Defines where in the grid this module’s widget will be displayed. <br /></p>
|
||||
|
||||
<p><code>refreshInterval</code> <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, <code>0..n</code>.</p>
|
||||
|
||||
<p><code>tempUnit</code> <br />
|
||||
The temperature scale in which to display temperature values. <br />
|
||||
Values: <code>F</code> for Fahrenheit, <code>C</code> for Celcius.</p>
|
||||
|
||||
</div>
|
||||
<div class="footer">
|
||||
|
||||
|
||||
Reference in New Issue
Block a user