diff --git a/_site/content/modules/textfile.md b/_site/content/modules/textfile.md index 47a0de6e..0aed87ee 100644 --- a/_site/content/modules/textfile.md +++ b/_site/content/modules/textfile.md @@ -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`
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`. + +`formatStyle`
+The style of syntax highlighting to format the text with.
+Values: See [Chroma styles](https://github.com/alecthomas/chroma/tree/master/styles) for all +valid options.
+Default: `vim`. + `position`
Defines where in the grid this module's widget will be displayed.
diff --git a/docs/configuration/index.html b/docs/configuration/index.html index 21817d29..312be0f6 100644 --- a/docs/configuration/index.html +++ b/docs/configuration/index.html @@ -141,6 +141,35 @@ CmdRunner + +
  • +
    + Crypo Currencies +
    +
  • @@ -176,6 +205,28 @@ Gitter
    +
    • +
  • +
    + Google Apps +
    +
  • @@ -183,6 +234,28 @@ Hacker News
    +
    • +
  • +
    + IP Addresses +
    +
  • @@ -274,6 +347,28 @@ Twitter
    +
    • +
  • +
    + Weather Services +
    +
  • diff --git a/docs/getting_started/index.html b/docs/getting_started/index.html index 6522a216..3255eb77 100644 --- a/docs/getting_started/index.html +++ b/docs/getting_started/index.html @@ -141,6 +141,35 @@ CmdRunner
    +
    • +
  • +
    + Crypo Currencies +
    +
  • @@ -176,6 +205,28 @@ Gitter
    +
    • +
  • +
    + Google Apps +
    +
  • @@ -183,6 +234,28 @@ Hacker News
    +
    • +
  • +
    + IP Addresses +
    +
  • @@ -274,6 +347,28 @@ Twitter
    +
    • +
  • +
    + Weather Services +
    +
  • diff --git a/docs/index.html b/docs/index.html index d45d5626..9f056d92 100644 --- a/docs/index.html +++ b/docs/index.html @@ -353,6 +353,20 @@ Weather Services
  • diff --git a/docs/index.json b/docs/index.json index 01a300e8..604d826f 100644 --- a/docs/index.json +++ b/docs/index.json @@ -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/", diff --git a/docs/index.xml b/docs/index.xml index 9b72ff40..8d0c0db3 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -402,7 +402,7 @@ Wifi Network The name of the current network Whether or not the network uses enc Displays the contents of the specified text file in the widget. Source Code wtf/textfile/ Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: o Action: Opens the text file in whichever text editor is associated with that file type. -Configuration textfile:enabled:truefilePath:"~/Desktop/notes.md"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:"~/Desktop/notes.md"format:trueformatStyle:"dracula"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. diff --git a/docs/modules/index.xml b/docs/modules/index.xml index b7b19214..42b59c7c 100644 --- a/docs/modules/index.xml +++ b/docs/modules/index.xml @@ -252,7 +252,7 @@ Wifi Network The name of the current network Whether or not the network uses enc Displays the contents of the specified text file in the widget. Source Code wtf/textfile/ Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: o Action: Opens the text file in whichever text editor is associated with that file type. -Configuration textfile:enabled:truefilePath:"~/Desktop/notes.md"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:"~/Desktop/notes.md"format:trueformatStyle:"dracula"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. diff --git a/docs/modules/textfile/index.html b/docs/modules/textfile/index.html index fea67c0a..682baca1 100644 --- a/docs/modules/textfile/index.html +++ b/docs/modules/textfile/index.html @@ -482,6 +482,8 @@ 
    textfile:
   enabled: true
   filePath: "~/Desktop/notes.md"
+  format: true
+  formatStyle: "dracula"
   position:
     top: 5
     left: 4
@@ -497,6 +499,17 @@ Values: true, false.
    
 
    filePath 
    
 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.
    
+
+
    formatStyle 
    
+The style of syntax highlighting to format the text with. 
    
+Values: See Chroma styles for all
+valid options. 
    
+Default: vim.
    
+
 
    position 
    
 Defines where in the grid this module’s widget will be displayed.