1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

More documentation for Clocks, GCal, and Jira.

This commit is contained in:
Chris Cummer
2018-05-16 19:37:23 -07:00
parent 2ecd5e4b84
commit 40ca748b8d
11 changed files with 166 additions and 51 deletions

View File

@@ -129,7 +129,7 @@
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">textfile<span class="p">:</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>filename<span class="p">:</span><span class="w"> </span><span class="s2">&#34;notes.md&#34;</span><span class="w">
</span><span class="w"> </span>filePath<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/Desktop/notes.md&#34;</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">5</span><span class="w">
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
@@ -142,10 +142,8 @@
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>filename</code> <br />
The name of the file to be displayed in the widget. <br />
<em>Note:</em> Currently this file <em>must</em> reside in the <code>~/.wtf/</code> directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>.</p>
<p><code>filePath</code> <br />
The path to the file to be displayed in the widget. <br /></p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>