mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Build of the site
This commit is contained in:
53
_site/content/posts/modules/bamboohr.md
Normal file
53
_site/content/posts/modules/bamboohr.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: "Bamboohr"
|
||||
date: 2018-05-07T20:17:37-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Connects to the BambooHR API and displays who will be Away today.
|
||||
|
||||
## Location
|
||||
|
||||
```bash
|
||||
wtf/bamboohr
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
`WTF_BAMBOO_HR_TOKEN` <br />
|
||||
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.
|
||||
|
||||
`WTF_BAMBOO_HR_SUBDOMAIN` <br />
|
||||
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
bamboohr:
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 1
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 900
|
||||
```
|
||||
|
||||
### Definitions
|
||||
|
||||
`enabled` <br />
|
||||
Whether or not this module is executed and its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines 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 />
|
||||
Values: Any positive integer, `0...n`.
|
||||
82
_site/content/posts/modules/clocks.md
Normal file
82
_site/content/posts/modules/clocks.md
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
title: "Clocks"
|
||||
date: 2018-05-07T19:47:31-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Displays a configurable list of world clocks, the local time, and date.
|
||||
|
||||
<img src="/imgs/modules/clocks.png" width="320" height="180" alt="clocks screenshot" />
|
||||
|
||||
## Location
|
||||
|
||||
```bash
|
||||
wtf/clocks/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
clocks:
|
||||
colors:
|
||||
rows:
|
||||
even: "lightblue"
|
||||
odd: "white"
|
||||
enabled: true
|
||||
locations:
|
||||
# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
Avignon: "Europe/Paris"
|
||||
Barcelona: "Europe/Madrid"
|
||||
Dubai: "Asia/Dubai"
|
||||
UTC: "Etc/UTC"
|
||||
Vancouver: "America/Vancouver"
|
||||
Toronto: "America/Toronto"
|
||||
position:
|
||||
top: 4
|
||||
left: 0
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 15
|
||||
# Valid options are: alphabetical, chronological
|
||||
sort: "alphabetical"
|
||||
```
|
||||
### Definitions
|
||||
|
||||
`colors.even` <br />
|
||||
Define the text color for even-numbered rows (2, 4, 6...). <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 />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`locations` <br />
|
||||
Defines the timezones for the world clocks that you want to display.
|
||||
`key` is a unique label that will be displayed in the UI. `value` is a
|
||||
timezone name. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">TZ database timezone</a>.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: Any positive integer, `0...n`.
|
||||
|
||||
`sort` <br />
|
||||
Defines the display order of the clocks in the widget. <br />
|
||||
Values: `alphabetical` or `chronological`. `alphabetical` will sort in
|
||||
acending order by `key`, `chronological` will sort in ascending order by
|
||||
date/time.
|
||||
Reference in New Issue
Block a user