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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
_site/content/modules/textfile.md
View File

@ -29,6 +29,8 @@ wtf/textfile/
textfile:
enabled: true
filePath: "~/Desktop/notes.md"
format: true
formatStyle: "dracula"
position:
top: 5
left: 4
@ -46,6 +48,17 @@ Values: `true`, `false`.
`filePath` <br />
The path to the file to be displayed in the widget. <br />
`format` <br />
Whether or not to try and format and syntax highlight the displayedtext. <br />
Values: `true`, `false`. <br />
Default: `false`.
`formatStyle` <br />
The style of syntax highlighting to format the text with. <br />
Values: See [Chroma styles](https://github.com/alecthomas/chroma/tree/master/styles) for all
valid options. <br />
Default: `vim`.
`position` <br />
Defines where in the grid this module's widget will be displayed. <br />

95
docs/configuration/index.html
View File

@ -141,6 +141,35 @@
CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
">
<div>
<a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/gerrit/" class="dd-item">
<div>
@ -176,6 +205,28 @@
Gitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/" class="dd-item haschildren
">
<div>
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/hackernews/" class="dd-item">
<div>
@ -183,6 +234,28 @@
Hacker News
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
">
<div>
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipapi/">
IP-API
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipinfo/">
IPInfo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/jenkins/" class="dd-item">
<div>
@ -274,6 +347,28 @@
Twitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
">
<div>
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/zendesk/" class="dd-item">
<div>

95
docs/getting_started/index.html
View File

@ -141,6 +141,35 @@
CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
">
<div>
<a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/gerrit/" class="dd-item">
<div>
@ -176,6 +205,28 @@
Gitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/" class="dd-item haschildren
">
<div>
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/hackernews/" class="dd-item">
<div>
@ -183,6 +234,28 @@
Hacker News
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
">
<div>
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipapi/">
IP-API
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipinfo/">
IPInfo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/jenkins/" class="dd-item">
<div>
@ -274,6 +347,28 @@
Twitter
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
">
<div>
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/zendesk/" class="dd-item">
<div>

14
docs/index.html vendored
View File

@ -353,6 +353,20 @@
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li>
<li data-nav-id="/modules/zendesk/" class="dd-item">

2
docs/index.json vendored
View File

@ -242,7 +242,7 @@
"title": "Textfile",
"tags": [],
"description": "",
"content": " Displays the contents of the specified text file in the widget.\nSource Code wtf/textfile/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: o Action: Opens the text file in whichever text editor is associated with that file type.\nConfiguration textfile:enabled:truefilePath:\u0026#34;~/Desktop/notes.md\u0026#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.\nfilePath The path to the file to be displayed in the widget. position Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
"content": " Displays the contents of the specified text file in the widget.\nSource Code wtf/textfile/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: o Action: Opens the text file in whichever text editor is associated with that file type.\nConfiguration textfile:enabled:truefilePath:\u0026#34;~/Desktop/notes.md\u0026#34;format:trueformatStyle:\u0026#34;dracula\u0026#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.\nfilePath The path to the file to be displayed in the widget. format Whether or not to try and format and syntax highlight the displayedtext. Values: true, false. Default: false.\nformatStyle The style of syntax highlighting to format the text with. Values: See Chroma styles for all valid options. Default: vim.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
},
{
"uri": "https://wtfutil.com/modules/todo/",

2
docs/index.xml vendored
View File

@ -402,7 +402,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>

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>