taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Add new attribute documentation for Textfile

Browse Source
This commit is contained in:
Chris Cummer
2018-08-19 14:11:54 -07:00
parent 6d8b20c785
commit 31bf15239f
8 changed files with 233 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/modules/index.xml
View File

@@ -252,7 +252,7 @@ Wifi Network The name of the current network Whether or not the network uses enc
<description>Displays the contents of the specified text file in the widget.
Source Code wtf/textfile/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
Configuration textfile:enabled:truefilePath:&amp;#34;~/Desktop/notes.md&amp;#34;position:top:5left:4height:2width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
Configuration textfile:enabled:truefilePath:&amp;#34;~/Desktop/notes.md&amp;#34;format:trueformatStyle:&amp;#34;dracula&amp;#34;position:top:5left:4height:2width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
filePath The path to the file to be displayed in the widget.</description>
</item>

13
docs/modules/textfile/index.html
View File

@@ -482,6 +482,8 @@
<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>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>format<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>formatStyle<span class="p">:</span><span class="w"> </span><span class="s2">&#34;dracula&#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">
@@ -497,6 +499,17 @@ Values: <code>true</code>, <code>false</code>.</p>
<p><code>filePath</code> <br />
The path to the file to be displayed in the widget. <br /></p>
<p><code>format</code> <br />
Whether or not to try and format and syntax highlight the displayedtext. <br />
Values: <code>true</code>, <code>false</code>. <br />
Default: <code>false</code>.</p>
<p><code>formatStyle</code> <br />
The style of syntax highlighting to format the text with. <br />
Values: See <a href="https://github.com/alecthomas/chroma/tree/master/styles">Chroma styles</a> for all
valid options. <br />
Default: <code>vim</code>.</p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>