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

More documentation for Clocks, OpsGenie, and Todo.

This commit is contained in:
Chris Cummer
2018-05-16 19:42:23 -07:00
parent 40ca748b8d
commit 694490b0ca
8 changed files with 32 additions and 20 deletions

View File

@@ -53,12 +53,12 @@ clocks:
### Attributes
`colors.rows.even` <br />
Define the foreground color for even-numbered rows. <br />
The foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.rows.odd` <br />
Define the foreground color for the odd-numbered rows. <br />
The foreground color for the odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.

View File

@@ -31,6 +31,7 @@ None.
```yaml
opsgenie:
displayEmpty: false
enabled: true
position:
top: 2
@@ -42,12 +43,16 @@ opsgenie:
### Attributes
`displayEmpty` <br />
Whether schedules with no assigned person on-call should be displayed. <br />
Values: `true`, `false`.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
Defines where in the grid this module's widget will be displayed. <br />
Where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />

View File

@@ -94,9 +94,11 @@ Values: Any displayable unicode character.
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
`colors.highlight.fore` <br />
The foreground color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
`colors.highlight.back` <br />
The background color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
`enabled` <br />
@@ -105,8 +107,6 @@ Values: `true`, `false`.
`filename` <br />
The name for the todo file. <br />
*Note:* Currently this file *must* reside in the `~/.wtf/` directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>. <br />
Values: Any valid filename, ideally ending in `yml`.
`position` <br />