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

Add new attribute documentation for Textfile

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

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 />