mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Additional data into documentation
This commit is contained in:
@@ -50,4 +50,4 @@ 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`.
|
||||
Values: Any positive integer, `0..n`.
|
||||
|
||||
@@ -77,7 +77,7 @@ 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`.
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`sort` <br />
|
||||
Defines the display order of the clocks in the widget. <br />
|
||||
|
||||
89
_site/content/posts/modules/git.md
Normal file
89
_site/content/posts/modules/git.md
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: "Git"
|
||||
date: 2018-05-09T14:20:48-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Displays information about local git repositories: branch, changed
|
||||
files, and recent commits.
|
||||
|
||||
#### Branch
|
||||
|
||||
Displays the of the currently-active git branch.
|
||||
|
||||
#### Changed Files
|
||||
|
||||
Displays a list of all the files that have changed since the last
|
||||
commit, and their status.
|
||||
|
||||
#### Recent Commits
|
||||
|
||||
Displays a list of `n` recent commits, who committed it, and when.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/git/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
<span class="caption">Action:</span> Open/close the widget's help window.
|
||||
|
||||
<span class="caption">Key:</span> `h` <br />
|
||||
<span class="caption">Action:</span> Show the previous git repository.
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Show the next git repository.
|
||||
|
||||
<span class="caption">Key:</span> `←` <br />
|
||||
<span class="caption">Action:</span> Show the previous git repository.
|
||||
|
||||
<span class="caption">Key:</span> `→` <br />
|
||||
<span class="caption">Action:</span> Show the next git repository.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
git:
|
||||
commitCount: 5
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 3
|
||||
height: 2
|
||||
width: 2
|
||||
refreshInterval: 8
|
||||
repositories:
|
||||
- "/Users/chris/go/src/github.com/senorprogrammer/wtf"
|
||||
- "/Users/chris/Documents/Lendesk/core-api"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`commitCount` <br />
|
||||
The number of past commits to display. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
|
||||
`enabled` <br />
|
||||
Determines 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 />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`repositories` <br />
|
||||
Defines which git repositories to watch. <br />
|
||||
Values: A list of zero or more local file paths pointing to valid git repositories.
|
||||
@@ -47,11 +47,11 @@ newrelic:
|
||||
`applicationId` <br />
|
||||
The integer ID of the New Relic application you wish to report on. <br
|
||||
/>
|
||||
Values: A positive integer, `0...n`.
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`deployCount` <br />
|
||||
The number of past deploys to display on screen. <br />
|
||||
Values: A positive integer, `0...n`.
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
@@ -62,4 +62,4 @@ 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`.
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
@@ -51,4 +51,4 @@ 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`.
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
@@ -69,4 +69,4 @@ 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`.
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
@@ -58,4 +58,4 @@ 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`.
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
@@ -6,6 +6,11 @@ draft: false
|
||||
|
||||
## Description
|
||||
|
||||
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
|
||||
|
||||
```bash
|
||||
@@ -38,6 +43,7 @@ wtf/weather/
|
||||
|
||||
```yaml
|
||||
weather:
|
||||
# From http://openweathermap.org/help/city_list.txt
|
||||
cityids:
|
||||
- 6173331
|
||||
- 3128760
|
||||
@@ -57,3 +63,33 @@ weather:
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`cityids` <br />
|
||||
A list of the <a
|
||||
href="http://openweathermap.org/help/city_list.txt">OpenWeatherMap city
|
||||
IDs</a> for the cities you want to view. <br />
|
||||
Values: A list of positive integers, `0..n`
|
||||
|
||||
`colors.current` <br />
|
||||
The color to highlight the current temperature in. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`language` <br />
|
||||
The human language in which to present the weather data. <br />
|
||||
Values: Any <a href="https://openweathermap.org/current">language identifier</a> specified by OpenWeatherMap.
|
||||
|
||||
`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`.
|
||||
|
||||
`tempUnit` <br />
|
||||
The temperature scale in which to display temperature values. <br />
|
||||
Values: `F` for Fahrenheit, `C` for Celcius.
|
||||
|
||||
Reference in New Issue
Block a user