mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
First pass at new site template
This commit is contained in:
committed by
Chris Cummer
parent
215c7e571f
commit
d872a28cf7
0
_site/content/_footer.md
Normal file
0
_site/content/_footer.md
Normal file
@@ -2,6 +2,7 @@
|
||||
title: "Configuration"
|
||||
date: 2018-04-15T21:17:16-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
## Index
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: "Configuration: Attributes"
|
||||
title: "Attributes"
|
||||
date: 2018-05-16T21:51:23-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
The following top-level attributes are configurable in `config.yml`.
|
||||
@@ -12,7 +13,7 @@ wtf:
|
||||
colors:
|
||||
background: "red"
|
||||
border:
|
||||
Focusable: "darkslateblue"
|
||||
focusable: "darkslateblue"
|
||||
focused: "orange"
|
||||
normal: "gray"
|
||||
grid:
|
||||
@@ -23,9 +24,8 @@ wtf:
|
||||
# How _high_ the rows are, in terminal lines. In this case we have five rows
|
||||
# that support ten line of text, one of three lines, and one of four
|
||||
rows: [10, 10, 10, 10, 10, 3, 4]
|
||||
# The app redraws itself once a second
|
||||
openFileUtil: open
|
||||
refreshInterval: 1
|
||||
openFileUtil: open # the name of the utility to call to open files
|
||||
refreshInterval: 1 # the app refreshes once per second
|
||||
term: "xterm-256color"
|
||||
```
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: "Configuration: iTerm2"
|
||||
title: "iTerm2"
|
||||
date: 2018-05-24T09:57:40-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Many terminal apps don't properly display multibyte emoji characters
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: "Overview"
|
||||
title: "Getting Started"
|
||||
date: 2018-05-21T16:11:58-07:00
|
||||
draft: false
|
||||
weight: 1
|
||||
---
|
||||
|
||||
<span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.
|
||||
@@ -4,20 +4,6 @@ date: 2018-05-18T09:59:40-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
There are two ways to install WTF:
|
||||
|
||||
## From Source
|
||||
|
||||
Get this repo and install the dependencies:
|
||||
|
||||
```bash
|
||||
go get -u github.com/senorprogrammer/wtf
|
||||
cd $GOPATH/src/github.com/senorprogrammer/wtf
|
||||
make install
|
||||
make run
|
||||
```
|
||||
and that should probably do it.
|
||||
|
||||
## As a Binary
|
||||
|
||||
Grab the latest version from here:
|
||||
@@ -33,3 +19,16 @@ expand it, and `cd` into the resulting directory. Then run:
|
||||
```
|
||||
|
||||
and that should also do it.
|
||||
|
||||
## From Source
|
||||
|
||||
Download the source code repo and install the dependencies:
|
||||
|
||||
```bash
|
||||
go get -u github.com/senorprogrammer/wtf
|
||||
cd $GOPATH/src/github.com/senorprogrammer/wtf
|
||||
go install -ldflags="-s -w"
|
||||
make run
|
||||
```
|
||||
and that should do it.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Modules"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
The heart of WTF is the modules. A module is a discreet unit of
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "BambooHR"
|
||||
date: 2018-05-07T20:17:37-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Connects to the BambooHR API and displays who will be Away today.
|
||||
@@ -12,10 +13,6 @@ Connects to the BambooHR API and displays who will be Away today.
|
||||
wtf/bamboohr/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,13 +2,15 @@
|
||||
title: "CircleCI"
|
||||
date: 2018-06-10T19:26:08-04:00
|
||||
draft: false
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<img src="/imgs/modules/circleci.png" class="screenshot" width="609" height="150" alt="circleci screenshot" />
|
||||
|
||||
Added in `v0.0.7`.
|
||||
|
||||
Displays build information for your CircleCI account.
|
||||
|
||||
<img src="/imgs/modules/circleci.png" width="609" height="150" alt="circleci screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -16,10 +18,6 @@ Displays build information for your CircleCI account.
|
||||
wtf/circleci/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,11 +2,13 @@
|
||||
title: "Clocks"
|
||||
date: 2018-05-07T19:47:31-07:00
|
||||
draft: false
|
||||
weight: 30
|
||||
---
|
||||
|
||||
<img src="/imgs/modules/clocks.png" class="screenshot" width="320" height="191" alt="clocks screenshot" />
|
||||
|
||||
Displays a configurable list of world clocks, the local time, and date.
|
||||
|
||||
<img src="/imgs/modules/clocks.png" width="320" height="191" alt="clocks screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -14,14 +16,6 @@ Displays a configurable list of world clocks, the local time, and date.
|
||||
wtf/clocks/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "CmdRunner"
|
||||
date: 2018-05-17T17:17:10-07:00
|
||||
draft: false
|
||||
weight: 40
|
||||
---
|
||||
|
||||
Runs a terminal command on a schedule.
|
||||
@@ -12,14 +13,6 @@ Runs a terminal command on a schedule.
|
||||
wtf/cmdrunner/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
8
_site/content/modules/cryptocurrencies/_index.md
Normal file
8
_site/content/modules/cryptocurrencies/_index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Crypo Currencies"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 50
|
||||
---
|
||||
|
||||
For all modules cryptocurrency-related.
|
||||
@@ -2,28 +2,21 @@
|
||||
title: "Bittrex"
|
||||
date: 2018-06-04T20:06:40-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/bittrex.png" width="320" height="412" alt="bittrex screenshot" />
|
||||
|
||||
Added in `v0.0.5`.
|
||||
|
||||
Get the last 24 hour summary of cryptocurrencies market using [Bittrex](https://bittrex.com).
|
||||
|
||||
<img src="/imgs/modules/bittrex.png" width="320" height="412" alt="bittrex screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/cryptoexchanges/bittrex/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,13 +2,15 @@
|
||||
title: "Blockfolio"
|
||||
date: 2018-06-13T09:29:59-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/blockfolio.png" width="320" height="185" alt="blockfolio screenshot" />
|
||||
|
||||
Added in `v0.0.8`.
|
||||
|
||||
Display your Blockfolio crypto holdings.
|
||||
|
||||
<img src="/imgs/modules/blockfolio.png" width="320" height="185" alt="blockfolio screenshot" />
|
||||
|
||||
## Source
|
||||
|
||||
@@ -16,14 +18,6 @@ Display your Blockfolio crypto holdings.
|
||||
wtf/blockfolio/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,13 +2,15 @@
|
||||
title: "CryptoLive"
|
||||
date: 2018-06-03T20:06:40-07:00
|
||||
draft: false
|
||||
weight: 15
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/cryptolive.png" width="320" height="203" alt="cryptolive screenshot" />
|
||||
|
||||
Added in `v0.0.5`.
|
||||
|
||||
Compare crypto currencies using [CryptoCompare](https://cryptocompare.com).
|
||||
|
||||
<img src="/imgs/modules/cryptolive.png" width="320" height="203" alt="cryptolive screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -16,14 +18,6 @@ Compare crypto currencies using [CryptoCompare](https://cryptocompare.com).
|
||||
wtf/cryptoexchanges/cryptolive/
|
||||
```
|
||||
|
||||
## Required ENV Vars
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -33,12 +27,12 @@ cryptolive:
|
||||
top: 5
|
||||
left: 2
|
||||
height: 1
|
||||
width: 2
|
||||
width: 2
|
||||
updateInterval: 15
|
||||
currencies:
|
||||
currencies:
|
||||
BTC:
|
||||
displayName: Bitcoin
|
||||
to:
|
||||
to:
|
||||
- USD
|
||||
- EUR
|
||||
- ETH
|
||||
@@ -46,7 +40,7 @@ cryptolive:
|
||||
- DOGE
|
||||
LTC:
|
||||
displayName: Ethereum
|
||||
to:
|
||||
to:
|
||||
- USD
|
||||
- EUR
|
||||
- BTC
|
||||
@@ -56,7 +50,7 @@ cryptolive:
|
||||
limit: 5
|
||||
to:
|
||||
- USD
|
||||
colors:
|
||||
colors:
|
||||
from:
|
||||
name: coral
|
||||
displayName: grey
|
||||
@@ -2,11 +2,12 @@
|
||||
title: "Google Calendar"
|
||||
date: 2018-05-10T08:25:33-07:00
|
||||
draft: false
|
||||
weight: 60
|
||||
---
|
||||
|
||||
Displays your upcoming Google calendar events.
|
||||
<img class="screenshot" src="/imgs/modules/gcal.png" width="320" height="389" alt="gcal screenshot" />
|
||||
|
||||
<img src="/imgs/modules/gcal.png" width="320" height="389" alt="gcal screenshot" />
|
||||
Displays your upcoming Google calendar events.
|
||||
|
||||
**Not:** Setting up access to Google Calendars for Go is a bit unobvious. Check out Google's [Go Quickstart](https://developers.google.com/calendar/quickstart/go)
|
||||
first and if you have problems, then take a look at this [comment by WesleydeSouza](https://github.com/senorprogrammer/wtf/issues/83#issuecomment-393665229) which offers a slightly different approach.
|
||||
@@ -17,14 +18,6 @@ first and if you have problems, then take a look at this [comment by WesleydeSou
|
||||
wtf/gcal/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,8 +2,11 @@
|
||||
title: "Gerrit"
|
||||
date: 2018-06-27T15:55:42-07:00
|
||||
draft: false
|
||||
weight: 70
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/gerrit.png" width="640" height="167" alt="gerrit screenshot" />
|
||||
|
||||
Displays information about your projects hosted on Gerrit:
|
||||
|
||||
#### Open Incoming Reviews
|
||||
@@ -14,8 +17,6 @@ All open reviews that are requesting your approval.
|
||||
|
||||
All open reviews created by you.
|
||||
|
||||
<img src="/imgs/modules/gerrit.png" width="640" height="167" alt="gerrit screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@@ -2,13 +2,14 @@
|
||||
title: "Git"
|
||||
date: 2018-05-09T14:20:48-07:00
|
||||
draft: false
|
||||
weight: 80
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/git.png" width="720" height="292" alt="git screenshot" />
|
||||
|
||||
Displays information about local git repositories: branch, changed
|
||||
files, and recent commits.
|
||||
|
||||
<img src="/imgs/modules/git.png" width="720" height="292" alt="git screenshot" />
|
||||
|
||||
#### Branch
|
||||
|
||||
The name of the currently-active git branch.
|
||||
@@ -28,10 +29,6 @@ A list of `n` recent commits, who committed it, and when.
|
||||
wtf/git/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
@@ -2,10 +2,12 @@
|
||||
title: "GitHub"
|
||||
date: 2018-05-09T19:20:20-07:00
|
||||
draft: false
|
||||
weight: 90
|
||||
---
|
||||
|
||||
Displays information about your git repositories hosted on GitHub:
|
||||
<img class="screenshot" src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
||||
|
||||
Displays information about your git repositories hosted on GitHub:
|
||||
|
||||
#### Open Review Requests
|
||||
|
||||
@@ -15,8 +17,6 @@ All open code review requests assigned to you.
|
||||
|
||||
All open pull requests created by you.
|
||||
|
||||
<img src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@@ -2,11 +2,12 @@
|
||||
title: "GitLab"
|
||||
date: 2018-06-08T13:14:11-07:00
|
||||
draft: false
|
||||
weight: 100
|
||||
---
|
||||
|
||||
Added in `v0.0.8`.
|
||||
<img class="screenshot" src="/imgs/modules/gitlab.png" width="640" height="390" alt="gitlab screenshot" />
|
||||
|
||||
<img src="/imgs/modules/gitlab.png" width="640" height="384" alt="gitlab screenshot" />
|
||||
Added in `v0.0.8`.
|
||||
|
||||
Displays information about your projects hosted on GitLab:
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Google Spreadsheets"
|
||||
date: 2018-06-10T18:26:26-04:00
|
||||
draft: false
|
||||
weight: 110
|
||||
---
|
||||
|
||||
Added in `v0.0.7`.
|
||||
@@ -12,14 +13,6 @@ Display information from cells in a Google Spreadsheet.
|
||||
wtf/gspreadsheets/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
9
_site/content/modules/ipaddress/_index.md
Normal file
9
_site/content/modules/ipaddress/_index.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
title: "IP Address"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 120
|
||||
---
|
||||
|
||||
For all modules IP address-related.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "IP-API"
|
||||
date: 2018-06-10T19:41:52-04:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Added in `v0.0.7`.
|
||||
@@ -17,14 +18,6 @@ minute.
|
||||
wtf/ipapi/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,13 +2,15 @@
|
||||
title: "IPInfo"
|
||||
date: 2018-06-01T23:18:48-07:00
|
||||
draft: false
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/ipinfo.png" width="320" height="199" alt="ipinfo screenshot" />
|
||||
|
||||
Displays your current IP address information, from ipinfo.io.
|
||||
|
||||
**Note:** IPInfo.io has a free-plan rate limit of 1000 requests per day.
|
||||
|
||||
<img src="/imgs/modules/ipinfo.png" width="320" height="199" alt="ipinfo screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -16,14 +18,6 @@ Displays your current IP address information, from ipinfo.io.
|
||||
wtf/ipinfo/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -1,26 +1,22 @@
|
||||
---
|
||||
title: "Modules: Jenkins"
|
||||
title: "Jenkins"
|
||||
date: 2018-06-09T20:53:35-07:00
|
||||
draft: false
|
||||
weight: 130
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/jenkins.png" alt="jenkins screenshot" width="320" height="68" />
|
||||
|
||||
Added in `v0.0.8`.
|
||||
|
||||
Displays jenkins status of given builds in a project or view
|
||||
|
||||
<img src="/imgs/modules/jenkins.png" alt="jenkins screenshot",
|
||||
width="320" height="68" alt="jenkins screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/jenkins/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,11 +2,12 @@
|
||||
title: "Jira"
|
||||
date: 2018-05-10T10:44:35-07:00
|
||||
draft: false
|
||||
weight: 140
|
||||
---
|
||||
|
||||
Displays all Jira issues assigned to you for the specified project.
|
||||
<img class="screenshot" src="/imgs/modules/jira.png" width="640" height="188" alt="jira screenshot" />
|
||||
|
||||
<img src="/imgs/modules/jira.png" width="640" height="188" alt="jira screenshot" />
|
||||
Displays all Jira issues assigned to you for the specified project.
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -2,15 +2,16 @@
|
||||
title: "Logger"
|
||||
date: 2018-06-16T14:22:18-07:00
|
||||
draft: false
|
||||
weight: 150
|
||||
---
|
||||
|
||||
Displays the contents of the WTF log file.
|
||||
Displays the contents of the WTF log file. The log file is located at `~/.config/wtf/log.txt`.
|
||||
|
||||
To log to this file in your own modules:
|
||||
|
||||
```golang
|
||||
require "github.com/senorprogrammer/wtf/logger"
|
||||
logger.Log("This is a log entry")
|
||||
logger.Log("This is a log entry")
|
||||
```
|
||||
|
||||
## Source Code
|
||||
@@ -19,10 +20,6 @@ require "github.com/senorprogrammer/wtf/logger"
|
||||
wtf/logger/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
Arrow keys scroll through the log file.
|
||||
@@ -2,23 +2,20 @@
|
||||
title: "New Relic"
|
||||
date: 2018-05-09T09:01:14-07:00
|
||||
draft: false
|
||||
weight: 160
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/newrelic.png" width="640" height="189" alt="newrelic screenshot" />
|
||||
|
||||
Connects to the New Relic API and displays the last n deploys of the
|
||||
monitored application: deploy ID, deploy time, and who deployed it.
|
||||
|
||||
<img src="/imgs/modules/newrelic.png" width="640" height="189" alt="newrelic screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/newrelic/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,23 +2,20 @@
|
||||
title: "OpsGenie"
|
||||
date: 2018-05-08T20:53:40-07:00
|
||||
draft: false
|
||||
weight: 170
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" />
|
||||
|
||||
Connects to the OpsGenie API and displays all your scheduled rotations
|
||||
and who's currently on call.
|
||||
|
||||
<img src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/opsgenie/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,28 +2,21 @@
|
||||
title: "Power"
|
||||
date: 2018-05-26T19:26:23-07:00
|
||||
draft: false
|
||||
weight: 180
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/power.png" width="320" height="129" alt="power screenshot" />
|
||||
|
||||
Displays information about the current power source.
|
||||
|
||||
For battery, also displays the current charge, estimated time remaining,
|
||||
and whether it is charging or discharging.
|
||||
|
||||
<img src="/imgs/modules/power.png" width="320" height="129" alt="power screenshot" />
|
||||
|
||||
## Source Code
|
||||
```bash
|
||||
wtf/power/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,13 +2,14 @@
|
||||
title: "Security"
|
||||
date: 2018-05-08T20:33:28-07:00
|
||||
draft: false
|
||||
weight: 200
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/security.png" width="320" height="192" alt="security screenshot" />
|
||||
|
||||
Displays some general information about the state of the machine's wifi
|
||||
connection, firewall, DNS settings, and logged-in users.
|
||||
|
||||
<img src="/imgs/modules/security.png" width="320" height="192" alt="security screenshot" />
|
||||
|
||||
#### Wifi Network
|
||||
|
||||
<ul class="list-ornate">
|
||||
@@ -42,14 +43,6 @@ show hidden users.</li>
|
||||
wtf/security/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,11 +2,12 @@
|
||||
title: "Textfile"
|
||||
date: 2018-05-09T11:13:11-07:00
|
||||
draft: false
|
||||
weight: 210
|
||||
---
|
||||
|
||||
Displays the contents of the specified text file in the widget.
|
||||
<img class="screenshot" src="/imgs/modules/textfile.png" width="320" height="133" alt="textfile screenshot" />
|
||||
|
||||
<img src="/imgs/modules/textfile.png" width="320" height="133" alt="textfile screenshot" />
|
||||
Displays the contents of the specified text file in the widget.
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -14,10 +15,6 @@ Displays the contents of the specified text file in the widget.
|
||||
wtf/textfile/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
@@ -2,11 +2,12 @@
|
||||
title: "Todo"
|
||||
date: 2018-05-10T12:41:50-07:00
|
||||
draft: false
|
||||
weight: 220
|
||||
---
|
||||
|
||||
An interactive todo list.
|
||||
<img class="screenshot" src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" />
|
||||
|
||||
<img src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" />
|
||||
An interactive todo list.
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -14,10 +15,6 @@ An interactive todo list.
|
||||
wtf/todo/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
@@ -2,14 +2,15 @@
|
||||
title: "Todoist"
|
||||
date: 2018-07-05T22:55:55-03:00
|
||||
draft: false
|
||||
weight: 230
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/todoist.png" alt="todoist screenshot" />
|
||||
|
||||
Added in `v0.0.11`.
|
||||
|
||||
Displays all items on specified project.
|
||||
|
||||
<img src="/imgs/modules/todoist.png" alt="todoist screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@@ -2,14 +2,15 @@
|
||||
title: "TravisCI"
|
||||
date: 2018-07-18T14:36:08-04:00
|
||||
draft: false
|
||||
weight: 240
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/travisci.png" width="640" height="187" alt="travisci screenshot" />
|
||||
|
||||
Added in `v0.0.12`.
|
||||
|
||||
Displays build information for your Travis CI account.
|
||||
|
||||
<img src="/imgs/modules/travisci.png" width="609" height="150" alt="travisci screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@@ -63,10 +64,10 @@ 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: A positive integer, `0..n`.
|
||||
|
||||
`pro` <br />
|
||||
Determines whether or not this module will use the Pro version of Travis CI.<br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@@ -2,11 +2,12 @@
|
||||
title: "Trello"
|
||||
date: 2018-05-10T10:44:35-07:00
|
||||
draft: false
|
||||
weight: 250
|
||||
---
|
||||
|
||||
Displays all Trello cards on specified lists.
|
||||
<img class="screenshot" src="/imgs/modules/trello.png" width="640" height="197" alt="trello screenshot" />
|
||||
|
||||
<img src="/imgs/modules/trello.png" width="640" height="188" alt="trello screenshot" />
|
||||
Displays all Trello cards on specified lists.
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -14,10 +15,6 @@ Displays all Trello cards on specified lists.
|
||||
wtf/trello/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Single Trello List
|
||||
@@ -2,9 +2,10 @@
|
||||
title: "Twitter"
|
||||
date: 2018-07-31T20:21:37-07:00
|
||||
draft: false
|
||||
weight: 260
|
||||
---
|
||||
|
||||
Added in `v0.1.2`.
|
||||
Added in `v0.2.0`.
|
||||
|
||||
Connects to the Twitter API and displays a single user's tweets.
|
||||
|
||||
8
_site/content/modules/weather_services/_index.md
Normal file
8
_site/content/modules/weather_services/_index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Weather Services"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 270
|
||||
---
|
||||
|
||||
For all modules weather-related.
|
||||
@@ -2,12 +2,14 @@
|
||||
title: "Pretty Weather"
|
||||
date: 2018-06-02T05:32:04-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/prettyweather.png" width="320" height="191" alt="prettyweather screenshot" />
|
||||
|
||||
Displays weather information as ASCII art from
|
||||
[Wttr.in](http://wttr.in).
|
||||
|
||||
<img src="/imgs/modules/prettyweather.png" width="320" height="191" alt="prettyweather screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -15,14 +17,6 @@ Displays weather information as ASCII art from
|
||||
wtf/prettyweather/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@@ -2,12 +2,14 @@
|
||||
title: "Weather"
|
||||
date: 2018-05-09T11:44:13-07:00
|
||||
draft: false
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/weather.png" width="320" height="187" alt="weather screenshot" />
|
||||
|
||||
Displays a configurable list of current weather report, including
|
||||
current temperature, sunrise time, and sunset time.
|
||||
|
||||
<img src="/imgs/modules/weather.png" width="320" height="187" alt="weather screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@@ -15,14 +17,6 @@ current temperature, sunrise time, and sunset time.
|
||||
wtf/weather/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
|
||||
|
||||
<span class="caption">Key:</span> `WTF_OWM_API_KEY` <br />
|
||||
<span class="caption">Action:</span> Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key. <br />
|
||||
<span class="caption">Note:</span> DEPRECATED. See the `apiKey` config value, below.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
@@ -2,6 +2,7 @@
|
||||
title: "Zendesk"
|
||||
date: 2018-07-23T18:55:37-08:00
|
||||
draft: false
|
||||
weight: 280
|
||||
---
|
||||
|
||||
Added in `v0.1.0`.
|
||||
Reference in New Issue
Block a user