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

More documentation for Clocks, GCal, and Jira.

Browse Source
This commit is contained in:
Chris Cummer
2018-05-16 19:37:23 -07:00
parent 2ecd5e4b84
commit 40ca748b8d
11 changed files with 166 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
_site/content/posts/modules/clocks.md
View File

@@ -52,13 +52,13 @@ clocks:
```
### Attributes
`colors.even` <br />
Define the text color for even-numbered rows (2, 4, 6...). <br />
`colors.rows.even` <br />
Define 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.odd` <br />
Define the text color for the odd-numbered rows (1, 3, 5...). <br />
`colors.rows.odd` <br />
Define 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>.

18
_site/content/posts/modules/gcal.md
View File

@@ -43,6 +43,8 @@ gcal:
past: "gray"
conflictIcon: "🚨"
currentIcon: "💥"
displayResponseStatus: true
email: "chriscummer@me.com"
enabled: true
eventCount: 12
position:
@@ -52,6 +54,7 @@ gcal:
width: 1
refreshInterval: 300
secretFile: "~/.wtf/gcal/client_secret.json"
withLocation: true
```
### Attributes
@@ -83,6 +86,20 @@ Values: Any displayable unicode character.
The icon displayed beside the current calendar event. <br />
Values: Any displayable unicode character.
`displayLocation` <br />
Whether or not to display the location of the calendar event. <br />
Values: `true`, `false`.
`displayResponseStatus` <br />
Whether or not to display your response status to the calendar event.
<br />
Values: `true`, `false`.
`email` <br />
The email address associated with your Google account. Necessary for
determining `responseStatus`. <br />
Values: A valid email address string.
`enabled` <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
@@ -101,3 +118,4 @@ Values: A positive integer, `0..n`.
`secretFile` <br />
Your <a href="https://developers.google.com/calendar/quickstart/go">Google client secret</a> JSON file. <br />
Values: A string representing a file path to the JSON secret file.

20
_site/content/posts/modules/jira.md
View File

@@ -29,6 +29,10 @@ None.
```yaml
jira:
colors:
rows:
even: "lightblue"
odd: "white"
domain: "https://umbrellacorp.atlassian.net"
email: "chriscummer@me.com"
enabled: true
@@ -44,9 +48,23 @@ jira:
### Attributes
`colors.rows.even` <br />
Define 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 odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`domain` <br />
Your Jira corporate domain. <br />
Values: A valid URI.
`email` <br />
The email address associated with your Jira account. <br />
Values: A valid email address string.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
@@ -56,9 +74,11 @@ Values: `true`, `false`.
Defines where in the grid this module's widget will be displayed. <br />
`project` <br />
The Jira project to fetch information for. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0..n`.
`username` <br />
Your Jira username. <br />