mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Deleted the /_site and /docs directories
Moved them over to https://github.com/wtfutil/wtfdocs
This commit is contained in:
Chris Cummer
commit
75915fd868
@ -1,6 +0,0 @@
|
||||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
draft: true
|
||||
---
|
||||
|
||||
59
_site/config.toml
vendored
59
_site/config.toml
vendored
@ -1,59 +0,0 @@
|
||||
baseURL = "https://wtfutil.com/"
|
||||
defaultContentLanguage = "en"
|
||||
defaultContentLanguageInSubdir= false
|
||||
enableMissingTranslationPlaceholders = false
|
||||
languageCode = "en-us"
|
||||
publishDir = "../docs"
|
||||
pygmentsCodeFences = true
|
||||
pygmentsUseClasses = true
|
||||
pygmentsStyle = "monokailight"
|
||||
theme = "docdock"
|
||||
title = "WTF - the terminal dashboard"
|
||||
|
||||
# [Languages]
|
||||
# [Languages.en]
|
||||
# title = "Documentation for WTF"
|
||||
# weight = 1
|
||||
# languageName = "English"
|
||||
#
|
||||
# [Languages.fr]
|
||||
# title = "Documentation du WTF"
|
||||
# weight = 2
|
||||
# languageName = "Français"
|
||||
|
||||
|
||||
|
||||
|
||||
[params]
|
||||
editURL = "https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/"
|
||||
showVisitedLinks = true # default is false
|
||||
themeStyle = "flex" # "original" or "flex" # default "flex"
|
||||
themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default)
|
||||
ordersectionsby = "weight" # ordersectionsby = "title"
|
||||
disableHomeIcon = false # default is false
|
||||
disableSearch = false # default is false
|
||||
disableNavChevron = false # set true to hide next/prev chevron, default is false
|
||||
highlightClientSide = false # set true to use highlight.pack.js instead of the default hugo chroma highlighter
|
||||
menushortcutsnewtab = false # set true to open shortcuts links to a new tab/window
|
||||
enableGitInfo = true
|
||||
|
||||
[outputs]
|
||||
home = [ "HTML", "RSS", "JSON"]
|
||||
|
||||
|
||||
[[menu.shortcuts]]
|
||||
pre = "<h3>More</h3>"
|
||||
name = "<i class='fa fa-github'></i> <label>WTF on Github</label>"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/senorprogrammer/wtf"
|
||||
weight = 10
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-cloud-download'></i> <label>Download WTF</label>"
|
||||
url = "https://github.com/senorprogrammer/wtf/releases"
|
||||
weight = 11
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-bullhorn'></i> <label>Credits</label>"
|
||||
url = "https://github.com/senorprogrammer/wtf/blob/master/README.md#contributors"
|
||||
weight = 30
|
||||
12
_site/config.toml-orig
vendored
12
_site/config.toml-orig
vendored
@ -1,12 +0,0 @@
|
||||
baseURL = "https://wtfutil.com/"
|
||||
languageCode = "en-us"
|
||||
publishDir = "../docs"
|
||||
pygmentsCodeFences = true
|
||||
pygmentsUseClasses = true
|
||||
sectionPagesMenu = "main"
|
||||
theme = "hyde-hyde"
|
||||
title = "WTF - A Terminal Dashboard"
|
||||
|
||||
[params]
|
||||
author = "Chris Cummer"
|
||||
authorimage = "/img/wtf.png"
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
title: "WTF"
|
||||
date: 2018-08-14T01:51:58-07:00
|
||||
draft: false
|
||||
weight: 0
|
||||
---
|
||||
|
||||
<h1><span style="font-family: monospace; font-weight: heavy;">WTF</span></h1>
|
||||
|
||||
<img src='/imgs/screenshot.jpg' width="900" height="524" />
|
||||
|
||||
<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.
|
||||
|
||||
It allows you to monitor systems, services, and important information that you otherwise might keep browser tabs open for, the kinds of things you don't always need visible, but do check in on every now and then.
|
||||
|
||||
Keep an eye on your **OpsGenie** schedules, **Google Calendar**, **Git** and **GitHub** repositories, and **New Relic** deployments.
|
||||
|
||||
See who's away in **BambooHR**, which **Jira** tickets are assigned to you, and what time it is in Barcelona.
|
||||
|
||||
It even has weather. And clocks. And emoji.
|
||||
@ -1,79 +0,0 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
date: 2018-04-15T21:17:16-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
## Index
|
||||
|
||||
* [Configuration Files](#configuration-files)
|
||||
* [Example Configuration Files](#example-configuration-files)
|
||||
* [Custom Configuration Files](#custom-configuration-files)
|
||||
* [Configuration Attributes](#configuration-attributes)
|
||||
* [Grid Layout](#grid-layout)
|
||||
|
||||
## Configuration Files
|
||||
|
||||
By default WTF looks in a `~/.config/wtf/` directory for a YAML file called
|
||||
`config.yml`. If the `~/.config/wtf/` directory doesn't exist, WTF will create that directory
|
||||
on start-up, and then display instructions for creating a new
|
||||
configuration file.
|
||||
|
||||
In other words, WTF expects to have a YAML config file at: `~/.config/wtf/config.yml`.
|
||||
|
||||
#### Example Configuration Files
|
||||
|
||||
A couple of example config files are provided in the `_sample_configs/`
|
||||
directory of the Git repository.
|
||||
|
||||
To try out WTF quickly, copy
|
||||
`simple_config.yml` into `~/.config/wtf/` as `config.yml` and relaunch WTF. You
|
||||
should see the app launch and display the <a href="/posts/modules/security/">Security</a>,
|
||||
<a href="/posts/modules/clocks/">Clocks</a> and <a href="/posts/modules/status/">Status</a> widgets onscreen.
|
||||
|
||||
#### Custom Configuration Files
|
||||
|
||||
To try out different configurations (or run multiple instances of WTF),
|
||||
you can pass the path to a config file via command line arguments on
|
||||
start-up.
|
||||
|
||||
To load a custom configuration file (ie: one that's not
|
||||
`~/.config/wtf/config.yml`), pass in the path to configuration file as a
|
||||
parameter on launch:
|
||||
|
||||
```bash
|
||||
$> wtf --config=path/to/custom/config.yml
|
||||
```
|
||||
|
||||
#### Configuration Attributes
|
||||
|
||||
A number of top-level attributes can be set to customize your WTF
|
||||
install. See <a href="/posts/configuration/attributes/">Attributes</a> for details.
|
||||
|
||||
## Grid Layout
|
||||
|
||||
WTF uses the `Grid` layout system from [tview](https://github.com/rivo/tview/blob/master/grid.go) to position widgets
|
||||
onscreen. It's not immediately obvious how this works, so here's an
|
||||
explanation:
|
||||
|
||||
Think of your terminal screen as a matrix of letter positions, say `100` chrs wide and `58` chrs tall.
|
||||
|
||||
Columns breaks up the width of the screen into chunks, each chunk a specified number of characters wide. use
|
||||
|
||||
`[10, 10, 10, 10, 10, 10, 10, 10, 10, 10]`
|
||||
|
||||
Ten columns that are ten characters wide
|
||||
|
||||
Rows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows:
|
||||
|
||||
`[10, 10, 10, 10, 18]`
|
||||
|
||||
The co-ordinate system starts at top-left and defines how wide and tall a widget is. If we wanted to put a 2-col, 2-row widget in the bottom of the screen, we'd position it at:
|
||||
|
||||
```
|
||||
top: 4 // top starts in the 4th row
|
||||
left: 9 // left starts in the 9th column
|
||||
height: 2 // span down rows 4 & 5 (18 characters in size, total)
|
||||
width: 2 // span across cols 9 & 10 (20 characters in size, total)
|
||||
```
|
||||
@ -1,85 +0,0 @@
|
||||
---
|
||||
title: "Attributes"
|
||||
date: 2018-05-16T21:51:23-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
The following top-level attributes are configurable in `config.yml`.
|
||||
See this <a href="https://github.com/senorprogrammer/wtf/blob/master/_sample_configs/simple_config.yml">example config file</a> for more details.
|
||||
|
||||
```yaml
|
||||
wtf:
|
||||
colors:
|
||||
background: "red"
|
||||
border:
|
||||
focusable: "darkslateblue"
|
||||
focused: "orange"
|
||||
normal: "gray"
|
||||
grid:
|
||||
# How _wide_ the columns are, in terminal characters. In this case we have
|
||||
# six columns, each of which are 35 characters wide
|
||||
columns: [35, 35, 35, 35, 35, 35]
|
||||
|
||||
# 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]
|
||||
openFileUtil: open # the name of the utility to call to open files
|
||||
refreshInterval: 1 # the app refreshes once per second
|
||||
term: "xterm-256color"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.background` <br />
|
||||
The color to draw the background of the app in. Use this to match your
|
||||
terminal colors. May be over-written by individual module
|
||||
configurations. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.border.focusable` <br />
|
||||
The color in which to draw the border of widgets that can accept
|
||||
keyboard focus. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.border.focused` <br />
|
||||
The color in which to draw the border of the widget that currently has
|
||||
keyboard focus. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.border.normal` <br />
|
||||
The color in which to draw the borders of the widgets that cannot accept
|
||||
focus. <br/>
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`grid.columns` <br />
|
||||
An array that defines the widths of all the columns. <br />
|
||||
Values: See <a href="https://github.com/rivo/tview/wiki/Grid">tview's
|
||||
Grid</a> for details.
|
||||
|
||||
`grid.rows` <br />
|
||||
An array that defines the heights of all the rows. <br />
|
||||
Values: See <a href="https://github.com/rivo/tview/wiki/Grid">tview's
|
||||
Grid</a> for details.
|
||||
|
||||
`openFileUtil` <br />
|
||||
Command to use to open a file or URL
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, the UI refreshes itself. <br />
|
||||
**Note:** This implementation is probably wrong and buggy and likely to
|
||||
change. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`term` <br />
|
||||
_Optional_. <br />
|
||||
Sets a custom value for the terminal type this app runs in. Leave this entry out of the config if you simply want to use your terminal's
|
||||
default setting. <br />
|
||||
**Note:** If an invalid value is provided for this setting, the app will
|
||||
crash with a `"terminal entry not found"` error. <br />
|
||||
Values: Any valid terminal type (ie: vt100, xterm, xterm-256color, ansi,
|
||||
etc.).
|
||||
@ -1,28 +0,0 @@
|
||||
---
|
||||
title: "iTerm2"
|
||||
date: 2018-05-24T09:57:40-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Many terminal apps don't properly display multibyte emoji characters
|
||||
properly. This **may** fix the issue for you in iTerm2, it also may not.
|
||||
|
||||
By default iTerm2 uses a unicode rendering format
|
||||
that is not comletely compatible with some emoji characters. Instead what you'll
|
||||
see is the emoji over-lapping normal text characters, or drawing outside
|
||||
the bounds of where they should be.
|
||||
|
||||
In iTerm2 open:
|
||||
|
||||
```bash
|
||||
Preferences -> Profiles -> Text
|
||||
```
|
||||
and check **on** the "Use Unicode Version 9 Widths" checkbox. Then
|
||||
restart WTF.
|
||||
|
||||
<img src="/imgs/iterm2prefs.png" width="800" height="437" alt="iTerm2
|
||||
Prefs" />
|
||||
|
||||
(*Note:* This issue is not unique to iTerm2. As of this writing it also
|
||||
affects <a href="https://en.wikipedia.org/wiki/Terminal_(macOS)">Terminal</a>, and <a href="https://hyper.is">Hyper</a>.)
|
||||
@ -1,46 +0,0 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-21T16:11:58-07:00
|
||||
draft: false
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. <a href="https://github.com/senorprogrammer/wtf/releases">Download</a> the stand-alone, compiled binary.
|
||||
2. Unzip the downloaded file.
|
||||
3. From the command line, `cd` into the newly-created `/wtf` directory.
|
||||
4. From the command line, run the app: `./wtf`
|
||||
|
||||
This should launch the app in your terminal using the default simple
|
||||
configuration. See <a href="/posts/configuration/">Configuration</a> for
|
||||
more details.
|
||||
|
||||
## Command-line Options
|
||||
|
||||
`--config, -c` <br />
|
||||
Allows you to define a custom config file to use. See <a href="/posts/configuration/">Configuration</a> for more details.
|
||||
|
||||
`--help, -h` <br />
|
||||
Shows help information for the command-line arguments that WTF
|
||||
takes.
|
||||
|
||||
`--module, -m` <br />
|
||||
Shows help information for the specific named module, if that module
|
||||
supports help text. <br />
|
||||
Example: `wtf --module=todo`.
|
||||
|
||||
`--version, -v` <br />
|
||||
Shows version info.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `Ctrl-R` <br />
|
||||
<span class="caption">Action:</span> Force-refresh the data for all modules.
|
||||
|
||||
<span class="caption">Key:</span> `Esc` <br />
|
||||
<span class="caption">Action:</span> Unfocus the currently-focused
|
||||
widget.
|
||||
|
||||
<span class="caption">Key:</span> `Tab` <br />
|
||||
<span class="caption">Action:</span> Move between focusable modules (`Shift-Tab` to move backwards).
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
title: "Glossary"
|
||||
date: 2018-04-17T12:34:51-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
### Module
|
||||
A discreet unit of data collection and display. A data interface
|
||||
concept. A package inside the app.
|
||||
|
||||
Examples: New Relic, Git, Weather.
|
||||
|
||||
### Widget
|
||||
The onscreen representation of a Module. The widget is responsible for
|
||||
being the interface between the app and the data collection.
|
||||
|
||||
Widgets are defined by a required `widget.go` file in a Module.
|
||||
@ -1,34 +0,0 @@
|
||||
---
|
||||
title: "Installation"
|
||||
date: 2018-05-18T09:59:40-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
## As a Binary
|
||||
|
||||
Grab the latest version from here:
|
||||
|
||||
```bash
|
||||
https://github.com/senorprogrammer/wtf/releases
|
||||
```
|
||||
|
||||
expand it, and `cd` into the resulting directory. Then run:
|
||||
|
||||
```bash
|
||||
./wtf
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
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
|
||||
functionality that extracts data from some source and packages that data
|
||||
for display.
|
||||
|
||||
For example, the <a href="/posts/modules/newrelic">New Relic</a> module
|
||||
uses New Relic's API to retrieve a list of the latest deploys and
|
||||
packages that information as a list for display in the "New Relic"
|
||||
widget.
|
||||
|
||||
The <a href="/posts/modules/clocks">Clocks</a> module takes a list of
|
||||
timezones and packages that information as a list of city/time pairs for
|
||||
display in the "Clocks" widget.
|
||||
|
||||
See available modules at left.
|
||||
@ -1,48 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/bamboohr/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
bamboohr:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 1
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 900
|
||||
subdomain: "testco"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.
|
||||
|
||||
`enabled` <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 />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: Any positive integer, `0..n`.
|
||||
|
||||
`subdomain` <br />
|
||||
Value: Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.
|
||||
@ -1,49 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/circleci/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
circleci:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
refreshInterval: 900
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://circleci.com/account/api">CircleCI API</a> token.
|
||||
|
||||
`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`.
|
||||
@ -1,87 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/clocks/
|
||||
```
|
||||
|
||||
## 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"
|
||||
New York: "America/New York"
|
||||
Toronto: "America/Toronto"
|
||||
UTC: "Etc/UTC"
|
||||
Vancouver: "America/Vancouver"
|
||||
position:
|
||||
top: 4
|
||||
left: 0
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 15
|
||||
# Valid options are: alphabetical, chronological
|
||||
sort: "alphabetical"
|
||||
```
|
||||
### Attributes
|
||||
|
||||
`colors.rows.even` <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 />
|
||||
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>.
|
||||
|
||||
`dateFormat` <br />
|
||||
The format of the date string for all clocks. <br />
|
||||
Values: Any valid Go date layout which is handled by <a href="https://golang.org/pkg/time/#Time.Format">Time.Format</a>. Defaults to Jan 2.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`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: A 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.
|
||||
|
||||
`timeFormat` <br />
|
||||
The format of the time string for all clocks. <br />
|
||||
Values: Any valid Go time layout which is handled by <a href="https://golang.org/pkg/time/#Time.Format">Time.Format</a>. Defaults to 15:04 MST.
|
||||
@ -1,53 +0,0 @@
|
||||
---
|
||||
title: "CmdRunner"
|
||||
date: 2018-05-17T17:17:10-07:00
|
||||
draft: false
|
||||
weight: 40
|
||||
---
|
||||
|
||||
Runs a terminal command on a schedule.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/cmdrunner/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
cmdrunner:
|
||||
args: ["-g", "batt"]
|
||||
cmd: "pmset"
|
||||
enabled: true
|
||||
position:
|
||||
top: 6
|
||||
left: 1
|
||||
height: 1
|
||||
width: 3
|
||||
refreshInterval: 30
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`args` <br />
|
||||
The arguments to the command, with each item as an element in an array.
|
||||
Example: for `curl -I cisco.com`, the arguments array would be `["-I", "cisco.com"]`.
|
||||
|
||||
`cmd` <br />
|
||||
The terminal command to be run, withouth the arguments. Ie: `ping`,
|
||||
`whoami`, `curl`. <br />
|
||||
|
||||
|
||||
`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.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
title: "Crypo Currencies"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 50
|
||||
---
|
||||
|
||||
For all modules cryptocurrency-related.
|
||||
@ -1,80 +0,0 @@
|
||||
---
|
||||
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).
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/cryptoexchanges/bittrex/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
bittrex:
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
left: 2
|
||||
height: 3
|
||||
width: 1
|
||||
refreshInterval: 5
|
||||
summary:
|
||||
BTC:
|
||||
displayName: Bitcoin
|
||||
market:
|
||||
- LTC
|
||||
- ETH
|
||||
colors:
|
||||
base:
|
||||
name: orange
|
||||
displayName: red
|
||||
market:
|
||||
name: red
|
||||
field: white
|
||||
value: green
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.base.name` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.base.dispayName` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.market.name` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.market.field` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.market.value` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`summary` <br />
|
||||
|
||||
`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`.
|
||||
@ -1,69 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
|
||||
## Source
|
||||
|
||||
```bash
|
||||
wtf/blockfolio/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
blockfolio:
|
||||
colors:
|
||||
name: blue
|
||||
grows: green
|
||||
drop: red
|
||||
device_token: "device token"
|
||||
displayHoldings: true
|
||||
enabled: true
|
||||
position:
|
||||
top: 3
|
||||
left: 1
|
||||
width: 1
|
||||
height: 1
|
||||
refreshInterval: 400
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.name` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.grows` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.drop` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`device_token` <br />
|
||||
Value: See [this gist](https://github.com/bob6664569/blockfolio-api-client) for
|
||||
details on how to get your Blockfolio API token.
|
||||
|
||||
`displayHoldings` <br />
|
||||
|
||||
`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`.
|
||||
@ -1,99 +0,0 @@
|
||||
---
|
||||
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).
|
||||
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/cryptoexchanges/cryptolive/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
cryptolive:
|
||||
enabled: true
|
||||
position:
|
||||
top: 5
|
||||
left: 2
|
||||
height: 1
|
||||
width: 2
|
||||
updateInterval: 15
|
||||
currencies:
|
||||
BTC:
|
||||
displayName: Bitcoin
|
||||
to:
|
||||
- USD
|
||||
- EUR
|
||||
- ETH
|
||||
- LTC
|
||||
- DOGE
|
||||
LTC:
|
||||
displayName: Ethereum
|
||||
to:
|
||||
- USD
|
||||
- EUR
|
||||
- BTC
|
||||
top:
|
||||
BTC:
|
||||
displayName: Bitcoin
|
||||
limit: 5
|
||||
to:
|
||||
- USD
|
||||
colors:
|
||||
from:
|
||||
name: coral
|
||||
displayName: grey
|
||||
to:
|
||||
name: white
|
||||
price: green
|
||||
top:
|
||||
from:
|
||||
name: grey
|
||||
displayName: coral
|
||||
to:
|
||||
name: red
|
||||
field: white
|
||||
value: green
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.from.name` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.from.dispayName` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.to.name` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`colors.to.price` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`currencies` <br />
|
||||
|
||||
`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`.
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
title: "Datadog"
|
||||
date: 2018-08-18T00:00:00Z
|
||||
draft: false
|
||||
weight: 60
|
||||
---
|
||||
|
||||
Connects to the Datadog API and displays alerting modules.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/datadog/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
datadog:
|
||||
apiKey: "<yourapikey>"
|
||||
applicationKey: "<yourapplicationkey>"
|
||||
enabled: true
|
||||
monitors:
|
||||
tags:
|
||||
- "team:ops"
|
||||
position:
|
||||
top: 4
|
||||
left: 3
|
||||
height: 1
|
||||
width: 2
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://docs.datadoghq.com/api/?lang=python#overview">Datadog API</a> key.
|
||||
|
||||
`applicationKey` <br />
|
||||
Value: Your <a href="https://docs.datadoghq.com/api/?lang=python#overview">Datadog Application</a> key.
|
||||
|
||||
`monitors` <br />
|
||||
Configuration for the monitors functionality.
|
||||
|
||||
`tags` <br />
|
||||
Array of tags you want to query monitors by.
|
||||
|
||||
`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`.
|
||||
@ -1,124 +0,0 @@
|
||||
---
|
||||
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
|
||||
|
||||
All open reviews that are requesting your approval.
|
||||
|
||||
#### My Outgoing Reviews
|
||||
|
||||
All open reviews created by you.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/gerrit/
|
||||
```
|
||||
|
||||
## 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 project.
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Show the next project.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next review in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous review in the list.
|
||||
|
||||
<span class="caption">Key:</span> `r` <br />
|
||||
<span class="caption">Action:</span> Refresh the data.
|
||||
|
||||
<span class="caption">Key:</span> `←` <br />
|
||||
<span class="caption">Action:</span> Show the previous project.
|
||||
|
||||
<span class="caption">Key:</span> `→` <br />
|
||||
<span class="caption">Action:</span> Show the next project.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next review in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous review in the list.
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
<span class="caption">Action:</span> Open the selected review in the browser.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
gerrit:
|
||||
colors:
|
||||
rows:
|
||||
even: "lightblue"
|
||||
odd: "white"
|
||||
domain: https://gerrit-review.googlesource.com
|
||||
enabled: true
|
||||
password: "mypassword"
|
||||
position:
|
||||
top: 2
|
||||
left: 3
|
||||
height: 2
|
||||
width: 2
|
||||
projects:
|
||||
- org/test-project"
|
||||
- dotfiles
|
||||
refreshInterval: 300
|
||||
username: "myname"
|
||||
verifyServerCertificate: false
|
||||
```
|
||||
|
||||
### 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 Gerrit corporate domain. <br />
|
||||
Values: A valid URI.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`password` <br />
|
||||
Value: Your <a href="https://gerrit-review.googlesource.com/Documentation/user-upload.html#http">Gerrit HTTP Password</a>.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`projects` <br />
|
||||
A list of Gerrit project names to fetch data for. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`username` <br />
|
||||
Your Gerrit username.
|
||||
|
||||
`verifyServerCertificate` <br />
|
||||
_Optional_ <br />
|
||||
Determines whether or not the server's certificate chain and host name are verified. <br />
|
||||
Values: `true`, `false`.
|
||||
@ -1,94 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
#### Branch
|
||||
|
||||
The name of the currently-active git branch.
|
||||
|
||||
#### Changed Files
|
||||
|
||||
A list of all the files that have changed since the last
|
||||
commit, and their status.
|
||||
|
||||
#### Recent Commits
|
||||
|
||||
A list of `n` recent commits, who committed it, and when.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/git/
|
||||
```
|
||||
|
||||
## 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
|
||||
commitFormat: "[forestgreen]%h [grey]%cd [white]%s [grey]%an[white]"
|
||||
dateFormat: "%H:%M %d %b %y"
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 3
|
||||
height: 2
|
||||
width: 2
|
||||
refreshInterval: 8
|
||||
repositories:
|
||||
- "/Users/chris/go/src/github.com/senorprogrammer/wtf"
|
||||
- "/Users/user/fakeapp"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`commitCount` <br />
|
||||
The number of past commits to display. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`commitFormat` <br />
|
||||
_Optional_ The string format for the commit message. <br />
|
||||
|
||||
`dateFormat` <br />
|
||||
_Optional_ The string format for the date/time in the commit message.
|
||||
<br />
|
||||
|
||||
`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.
|
||||
@ -1,104 +0,0 @@
|
||||
---
|
||||
title: "GitHub"
|
||||
date: 2018-05-09T19:20:20-07:00
|
||||
draft: false
|
||||
weight: 90
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/github.png" width="480" height="288" alt="github screenshot" />
|
||||
|
||||
Displays information about your git repositories hosted on GitHub:
|
||||
|
||||
#### Open Review Requests
|
||||
|
||||
All open code review requests assigned to you.
|
||||
|
||||
#### Open Pull Requests
|
||||
|
||||
All open pull requests created by you.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/github/
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
<span class="caption">Key:</span> `Return` <br />
|
||||
<span class="caption">Action:</span> Open the selected repository in a browser.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
github:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
baseURL: ""
|
||||
enabled: true
|
||||
enableStatus: true
|
||||
position:
|
||||
top: 2
|
||||
left: 3
|
||||
height: 2
|
||||
width: 2
|
||||
refreshInterval: 300
|
||||
repositories:
|
||||
wesker-api: "UmbrellaCorp"
|
||||
wtf: "senorprogrammer"
|
||||
uploadURL: ""
|
||||
username: "senorprogrammer"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://blog.github.com/2013-05-16-personal-api-tokens/">GitHub API</a> token.
|
||||
|
||||
`baseURL` <br />
|
||||
_Optional_ <br />
|
||||
Value: Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> API URL.
|
||||
|
||||
`enabled` <br />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`enableStatus` <br />
|
||||
Display pull request mergeability status ('dirty', 'clean', 'unstable',
|
||||
'blocked').<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 />
|
||||
A list of key/value pairs each describing a GitHub repository to fetch data
|
||||
for. <br />
|
||||
<span class="caption">Key:</span> The name of the repository. <br />
|
||||
<span class="caption">Value:</span> The name of the account or organization that owns the repository.
|
||||
|
||||
`uploadURL` <br />
|
||||
_Optional_ <br />
|
||||
Value: Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> upload URL (often the same as API URL).
|
||||
|
||||
`username` <br />
|
||||
Your GitHub username. Used to figure out which review requests you've
|
||||
been added to.
|
||||
@ -1,90 +0,0 @@
|
||||
---
|
||||
title: "GitLab"
|
||||
date: 2018-06-08T13:14:11-07:00
|
||||
draft: false
|
||||
weight: 100
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/gitlab.png" width="640" height="390" alt="gitlab screenshot" />
|
||||
|
||||
Added in `v0.0.8`.
|
||||
|
||||
Displays information about your projects hosted on GitLab:
|
||||
|
||||
#### Open Approval Requests
|
||||
|
||||
All open merge requests that are requesting your approval.
|
||||
|
||||
#### Open Merge Requests
|
||||
|
||||
All open merge requests created by you.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/gitlab/
|
||||
```
|
||||
|
||||
## 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 project.
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Show the next project.
|
||||
|
||||
<span class="caption">Key:</span> `←` <br />
|
||||
<span class="caption">Action:</span> Show the previous project.
|
||||
|
||||
<span class="caption">Key:</span> `→` <br />
|
||||
<span class="caption">Action:</span> Show the next project.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
gitlab:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 2
|
||||
left: 3
|
||||
height: 2
|
||||
width: 2
|
||||
refreshInterval: 300
|
||||
projects:
|
||||
tasks: "gitlab-org/release"
|
||||
gitlab-ce: "gitlab-org"
|
||||
username: "senorprogrammer"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: A <a href="https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html">GitLab personal access token</a>. Requires at least `api` access.
|
||||
|
||||
`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`.
|
||||
|
||||
`domain` <br />
|
||||
_Optional_. Your GitLab corporate domain. <br />
|
||||
Values: A valid URI.
|
||||
|
||||
`projects` <br />
|
||||
A list of key/value pairs each describing a GitLab project to fetch data
|
||||
for. <br />
|
||||
<span class="caption">Key:</span> The name of the project. <br />
|
||||
<span class="caption">Value:</span> The namespace of the project.
|
||||
|
||||
`username` <br />
|
||||
Your GitLab username. Used to figure out which requests require your approval
|
||||
@ -1,76 +0,0 @@
|
||||
---
|
||||
title: "Gitter"
|
||||
date: 2018-08-02T12:36:08-04:00
|
||||
draft: false
|
||||
weight: 110
|
||||
---
|
||||
|
||||
Added in `v0.2.1`.
|
||||
|
||||
Displays chat messages from Gitter.
|
||||
|
||||
<img src="/imgs/modules/gitter.png" width="847" height="160" alt="gitter screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/gitter/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next message in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous message in the list.
|
||||
|
||||
<span class="caption">Key:</span> `r` <br />
|
||||
<span class="caption">Action:</span> Refresh the data.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next message in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous message in the list.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
gitter:
|
||||
apiToken: "ab345546asdfasb465234fgjgh068f39a35c3e4139ee383f7"
|
||||
enabled: true
|
||||
numberOfMessages: 10
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 4
|
||||
roomUri: wtfutil/Lobby
|
||||
refreshInterval: 300
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiToken` <br />
|
||||
Value: Your <a href="https://developer.gitter.im/apps">Gitter</a>Personal Access Token.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`numberOfMessages` <br />
|
||||
_Optional_ <br />
|
||||
Maximum number of _(newest)_ messages to be displayed. Default is `10`<br />
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`roomUri` <br />
|
||||
_Optional_ <br /
|
||||
URI of the room you would like to see the chat messages from. Default is `wtfutil/Lobby`<br />
|
||||
Values: `new`, `top`, `job`, `ask`
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
title: "Google Apps"
|
||||
date: 2018-08-14T01:39:58-07:00
|
||||
draft: false
|
||||
weight: 120
|
||||
---
|
||||
|
||||
Google Apps.
|
||||
|
||||
{{% children %}}
|
||||
@ -1,125 +0,0 @@
|
||||
---
|
||||
title: "Google Calendar"
|
||||
date: 2018-05-10T08:25:33-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
<img class="screenshot" 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.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/gcal/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
gcal:
|
||||
colors:
|
||||
title: "red"
|
||||
description: "lightblue"
|
||||
highlights:
|
||||
- ['1on1|1\/11', 'green']
|
||||
- ['apple|google|aws', 'blue']
|
||||
- ['interview|meet', 'magenta']
|
||||
- ['lunch', 'yellow']
|
||||
past: "gray"
|
||||
conflictIcon: "🚨"
|
||||
currentIcon: "💥"
|
||||
displayResponseStatus: true
|
||||
email: "chriscummer@me.com"
|
||||
enabled: true
|
||||
eventCount: 12
|
||||
multiCalendar: true
|
||||
position:
|
||||
top: 0
|
||||
left: 0
|
||||
height: 4
|
||||
width: 1
|
||||
refreshInterval: 300
|
||||
secretFile: "~/.config/wtf/gcal/client_secret.json"
|
||||
showDeclined: true
|
||||
withLocation: true
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.title` <br />
|
||||
The default colour for calendar event titles. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.description` <br />
|
||||
The default color for calendar event descriptions. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.highlights` <br />
|
||||
A list of arrays that define a regular expression pattern and a color.
|
||||
If a calendar event title matches a regular expression, the title will
|
||||
be drawn in that colour. Over-rides the default title colour. <br />
|
||||
Values: [a valid regular expression, any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.]
|
||||
|
||||
`colors.past` <br />
|
||||
The color for calendar events that have passed. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`conflictIcon` <br />
|
||||
The icon displayed beside calendar events that have conflicting times
|
||||
(they intersect or overlap in some way). <br />
|
||||
Values: Any displayable unicode character.
|
||||
|
||||
`currentIcon` <br />
|
||||
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`.
|
||||
|
||||
`eventCount` <br />
|
||||
The number of calendar events to display. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`multiCalendar` <br />
|
||||
Whether or not to display your primary calendar or all calendars you
|
||||
have access to. <br />
|
||||
Values: `true`, or `false`
|
||||
|
||||
`position` <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 />
|
||||
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.
|
||||
|
||||
`showDeclined` <br />
|
||||
_Optional_. Whether or not to display events you've declined to attend. <br />
|
||||
Values: `true`, or `false`
|
||||
|
||||
`withLocation` <br />
|
||||
Whether or not to show the location of the appointment. <br />
|
||||
Values: `true`, or `false`
|
||||
@ -1,63 +0,0 @@
|
||||
---
|
||||
title: "Google Spreadsheets"
|
||||
date: 2018-06-10T18:26:26-04:00
|
||||
draft: false
|
||||
weight: 50
|
||||
---
|
||||
|
||||
Added in `v0.0.7`.
|
||||
|
||||
Display information from cells in a Google Spreadsheet.
|
||||
|
||||
```bash
|
||||
wtf/gspreadsheets/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
gspreadsheets:
|
||||
colors:
|
||||
values: "green"
|
||||
cells:
|
||||
names:
|
||||
- "Cell 1 name"
|
||||
- "Cell 2 name"
|
||||
addresses:
|
||||
- "A1"
|
||||
- "A2"
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 0
|
||||
width: 1
|
||||
height: 1
|
||||
refreshInterval: "300"
|
||||
secretFile: "~/.config/wtf/gspreadsheets/client_secret.json"
|
||||
sheetId: "id_of_google_spreadsheet"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.values` <br />
|
||||
The color to display the cell values in. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`cells.names` <br />
|
||||
|
||||
`cells.addresses` <br />
|
||||
|
||||
`enabled` <br />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <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 />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`secretFile` <br />
|
||||
Your <a href="https://developers.google.com/sheets/api/quickstart/go">Google client secret</a> JSON file. <br />
|
||||
Values: A string representing a file path to the JSON secret file.
|
||||
@ -1,75 +0,0 @@
|
||||
---
|
||||
title: "Hacker News"
|
||||
date: 2018-08-02T16:36:08-04:00
|
||||
draft: false
|
||||
weight: 123
|
||||
---
|
||||
|
||||
Added in `v0.1.2`.
|
||||
|
||||
Displays stories from Hacker News.
|
||||
|
||||
<img src="/imgs/modules/hackernews.png" width="843" height="201" alt="hackernews screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/hackernews/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
<span class="caption">Action:</span> Open the selected story in the browser.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next story in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous story in the list.
|
||||
|
||||
<span class="caption">Key:</span> `r` <br />
|
||||
<span class="caption">Action:</span> Refresh the data.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next story in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous story in the list.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
hackernews:
|
||||
enabled: true
|
||||
numberOfStories: 10
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
storyType: top
|
||||
refreshInterval: 900
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`numberOfStories` <br />
|
||||
_Optional_ <br />
|
||||
Defines number of stories to be displayed. Default is `10`<br />
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`storyType` <br />
|
||||
_Optional_ <br /
|
||||
Defines type of stories to be displayed. Default is `top` stories<br />
|
||||
Values: `new`, `top`, `job`, `ask`
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
title: "IP Addresses"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 125
|
||||
---
|
||||
|
||||
For all modules IP address-related.
|
||||
|
||||
{{% children %}}
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
title: "IP-API"
|
||||
date: 2018-06-10T19:41:52-04:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Added in `v0.0.7`.
|
||||
|
||||
Displays your current IP address information, from [IP-APIcom](http://ip-api.com).
|
||||
|
||||
**Note:** IP-API.com has a free-plan rate limit of 120 requests per
|
||||
minute.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/ipapi/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
ipinfo:
|
||||
colors:
|
||||
name: red
|
||||
value: white
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 150
|
||||
```
|
||||
### Attributes
|
||||
|
||||
`colors.name` <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.value` <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`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`.
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/ipinfo/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
ipinfo:
|
||||
colors:
|
||||
name: red
|
||||
value: white
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 150
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.name` <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.value` <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`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`.
|
||||
@ -1,83 +0,0 @@
|
||||
---
|
||||
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
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/jenkins/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
<span class="caption">Action:</span> Open the selected job in the browser.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next job in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous job in the list.
|
||||
|
||||
<span class="caption">Key:</span> `r` <br />
|
||||
<span class="caption">Action:</span> Refresh the data.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next job in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous job in the list.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
jenkins:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 2
|
||||
left: 3
|
||||
height: 2
|
||||
width: 3
|
||||
refreshInterval: 300
|
||||
url: "https://jenkins.domain.com/jenkins/view_url"
|
||||
user: "username"
|
||||
verifyServerCertificate: true
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://wiki.jenkins.io/display/JENKINS/Remote+access+API">Jenkins API</a> key.
|
||||
|
||||
`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.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`user` <br />
|
||||
Your Jenkins username. <br />
|
||||
|
||||
`url` <br />
|
||||
The url to your Jenkins project or view. <br />
|
||||
Values: A valid URI.
|
||||
|
||||
`verifyServerCertificate` <br />
|
||||
_Optional_ <br />
|
||||
Determines whether or not the server's certificate chain and host name are verified. <br />
|
||||
Values: `true`, `false`.
|
||||
@ -1,136 +0,0 @@
|
||||
---
|
||||
title: "Jira"
|
||||
date: 2018-05-10T10:44:35-07:00
|
||||
draft: false
|
||||
weight: 140
|
||||
---
|
||||
|
||||
<img class="screenshot" 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
|
||||
|
||||
```bash
|
||||
wtf/jira/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
<span class="caption">Action:</span> Open the selected issue in the browser.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous item in the list.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Single Jira Project
|
||||
|
||||
```yaml
|
||||
jira:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
colors:
|
||||
rows:
|
||||
even: "lightblue"
|
||||
odd: "white"
|
||||
domain: "https://umbrellacorp.atlassian.net"
|
||||
email: "chriscummer@me.com"
|
||||
enabled: true
|
||||
jql: "issueType = Story"
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
project: "ProjectA"
|
||||
refreshInterval: 900
|
||||
username: "chris.cummer"
|
||||
verifyServerCertificate: true
|
||||
```
|
||||
|
||||
### Multiple Jira Projects
|
||||
|
||||
If you want to monitor multiple Jira projects, use the following
|
||||
configuration (note the difference in `project`):
|
||||
|
||||
```yaml
|
||||
jira:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
colors:
|
||||
rows:
|
||||
even: "lightblue"
|
||||
odd: "white"
|
||||
domain: "https://umbrellacorp.atlassian.net"
|
||||
email: "chriscummer@me.com"
|
||||
enabled: true
|
||||
jql: "issueType = Story"
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
project: ["ProjectA", "ProjectB"]
|
||||
refreshInterval: 900
|
||||
username: "chris.cummer"
|
||||
verifyServerCertificate: true
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://confluence.atlassian.com/cloud/api-tokens-938839638.html">Jira API</a> key.
|
||||
|
||||
`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 />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`jql` <br />
|
||||
_Optional_ <br />
|
||||
Custom JQL to be appended to the search query. <br />
|
||||
Values: See <a href="https://confluence.atlassian.com/jiracore/blog/2015/07/search-jira-like-a-boss-with-jql">Search Jira like a boss with JQL</a> for details.
|
||||
|
||||
`position` <br />
|
||||
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 />
|
||||
|
||||
`verifyServerCertificate` <br />
|
||||
_Optional_ <br />
|
||||
Determines whether or not the server's certificate chain and host name are verified. <br />
|
||||
Values: `true`, `false`.
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
title: "Logger"
|
||||
date: 2018-06-16T14:22:18-07:00
|
||||
draft: false
|
||||
weight: 150
|
||||
---
|
||||
|
||||
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")
|
||||
```
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/logger/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
Arrow keys scroll through the log file.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
enabled: true
|
||||
position:
|
||||
top: 5
|
||||
left: 4
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 1
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
**Note:** If you're using logging and logging is _disabled_, your logs
|
||||
will still be written to file, the widget just won't be shown onscreen.
|
||||
If you have `logger.Log` calls in your code, regardless of this setting,
|
||||
they will be written out. <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`.
|
||||
@ -1,58 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/newrelic/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
newrelic:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
applicationId: 10549735
|
||||
deployCount: 6
|
||||
enabled: true
|
||||
position:
|
||||
top: 4
|
||||
left: 3
|
||||
height: 1
|
||||
width: 2
|
||||
refreshInterval: 900
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://docs.newrelic.com/docs/apis/getting-started/intro-apis/access-rest-api-keys">New Relic API</a> token.
|
||||
|
||||
`applicationId` <br />
|
||||
The integer ID of the New Relic application you wish to report on. <br
|
||||
/>
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`deployCount` <br />
|
||||
The number of past deploys to display on screen. <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`.
|
||||
@ -1,52 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/opsgenie/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
opsgenie:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
displayEmpty: false
|
||||
enabled: true
|
||||
position:
|
||||
top: 2
|
||||
left: 1
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 21600
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` < br />
|
||||
Value: Your <a href="https://docs.opsgenie.com/docs/api-integration">OpsGenie API</a> token.
|
||||
|
||||
`displayEmpty` <br />
|
||||
Whether schedules with no assigned person on-call should be displayed. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`enabled` <br />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <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 />
|
||||
Values: A positive integer, `0..n`.
|
||||
@ -1,44 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## Source Code
|
||||
```bash
|
||||
wtf/power/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
power:
|
||||
enabled: true
|
||||
position:
|
||||
top: 5
|
||||
left: 0
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 15
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`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`.
|
||||
@ -1,70 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
#### Wifi Network
|
||||
|
||||
<ul class="list-ornate">
|
||||
<li>The name of the current network</li>
|
||||
<li>Whether or not the network uses <a href="https://www.howtogeek.com/167783/htg-explains-the-difference-between-wep-wpa-and-wpa2-wireless-encryption-and-why-it-matters/">encryption</a> and if so, what flavour</li>
|
||||
</ul>
|
||||
|
||||
#### Firewall
|
||||
|
||||
<ul class="list-ornate">
|
||||
<li>Whether or not the <a href="https://support.apple.com/en-ca/HT201642">firewall</a> is enabled</li>
|
||||
<li>Whether or not <a href="https://support.apple.com/en-ca/HT201642">Stealth Mode</a> is enabled</li>
|
||||
</ul>
|
||||
|
||||
#### DNS
|
||||
|
||||
<ul class="list-ornate">
|
||||
<li>Which <a hre="https://developers.cloudflare.com/1.1.1.1/what-is-1.1.1.1/">DNS resolvers</a> (servers) the machine is configured to use</li>
|
||||
</ul>
|
||||
|
||||
#### Users
|
||||
|
||||
<ul class="list-ornate">
|
||||
<li> Which users are logged into the machine. Note: Does not yet
|
||||
show hidden users.</li>
|
||||
</ul>
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/security/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
security:
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 3600
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`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`.
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
title: "Spotify"
|
||||
date: 2018-10-02T17:13:11-07:00
|
||||
draft: false
|
||||
weight: 205
|
||||
---
|
||||
|
||||
Control the Spotify client.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/spotify/
|
||||
```
|
||||
|
||||
## 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> `space` <br />
|
||||
<span class="caption">Action:</span> Play/pause the currently-selected
|
||||
track
|
||||
|
||||
<span class="caption">Key:</span> `h` <br />
|
||||
<span class="caption">Action:</span> Play previous song
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Play next song
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
spotify:
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 0
|
||||
```
|
||||
|
||||
## Attributes
|
||||
|
||||
`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`.
|
||||
@ -1,69 +0,0 @@
|
||||
---
|
||||
title: "Textfile"
|
||||
date: 2018-05-09T11:13:11-07:00
|
||||
draft: false
|
||||
weight: 210
|
||||
---
|
||||
|
||||
<img class="screenshot" 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
|
||||
|
||||
```bash
|
||||
wtf/textfile/
|
||||
```
|
||||
|
||||
## 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> `o` <br />
|
||||
<span class="caption">Action:</span> Opens the text file in whichever text editor is associated with that file type.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
textfile:
|
||||
enabled: true
|
||||
filePaths:
|
||||
- "~/Desktop/notes.md"
|
||||
- "~/.config/wtf/config.yml"
|
||||
format: true
|
||||
formatStyle: "dracula"
|
||||
position:
|
||||
top: 5
|
||||
left: 4
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 15
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`filePaths` <br />
|
||||
An array of paths to the files to be displayed in the widget. <br />
|
||||
|
||||
`format` <br />
|
||||
Whether or not to try and format and syntax highlight the displayedtext. <br />
|
||||
Values: `true`, `false`. <br />
|
||||
Default: `false`.
|
||||
|
||||
`formatStyle` <br />
|
||||
The style of syntax highlighting to format the text with. <br />
|
||||
Values: See [Chroma styles](https://github.com/alecthomas/chroma/tree/master/styles) for all
|
||||
valid options. <br />
|
||||
Default: `vim`.
|
||||
|
||||
`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`.
|
||||
@ -1,112 +0,0 @@
|
||||
---
|
||||
title: "Todo"
|
||||
date: 2018-05-10T12:41:50-07:00
|
||||
draft: false
|
||||
weight: 220
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" />
|
||||
|
||||
An interactive todo list.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/todo/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
<span class="caption">Action:</span> Edit the selected item. <br />
|
||||
<span class="caption">Action:</span> Close the modal item dialog and save changes. <br />
|
||||
|
||||
<span class="caption">Key:</span> `[esc]` <br />
|
||||
<span class="caption">Action:</span> Remove focus from the selected item. <br />
|
||||
<span class="caption">Action:</span> Close the modal item dialog without saving changes.
|
||||
|
||||
<span class="caption">Key:</span> `[space]` <br />
|
||||
<span class="caption">Action:</span> Check/uncheck the selected item.
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
<span class="caption">Action:</span> Open/close the widget's help window.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `n` <br />
|
||||
<span class="caption">Action:</span> Create a new list item.
|
||||
|
||||
<span class="caption">Key:</span> `o` <br />
|
||||
<span class="caption">Action:</span> Opens the todo list file in
|
||||
whichever text editor is associated with that file type.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `Ctrl-d` <br />
|
||||
<span class="caption">Action:</span> Delete the selected item.
|
||||
|
||||
<span class="caption">Key:</span> `Ctrl-J` <br />
|
||||
<span class="caption">Action:</span> Move the selected item down the list.
|
||||
|
||||
<span class="caption">Key:</span> `Ctrl-K` <br />
|
||||
<span class="caption">Action:</span> Move the selected item up the list.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
todo:
|
||||
checkedIcon: "X"
|
||||
colors:
|
||||
checked: gray
|
||||
highlight:
|
||||
fore: "black"
|
||||
back: "orange"
|
||||
enabled: true
|
||||
filename: "todo.yml"
|
||||
position:
|
||||
top: 2
|
||||
left: 2
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 3600
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`checkedIcon` <br />
|
||||
The icon used to denote a "checked" todo item. <br />
|
||||
Values: Any displayable unicode character.
|
||||
|
||||
`colors.checked` <br />
|
||||
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 />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`filename` <br />
|
||||
The name for the todo file. <br />
|
||||
Values: Any valid filename, ideally ending in `yml`.
|
||||
|
||||
`position` <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 />
|
||||
Values: A positive integer, `0..n`.
|
||||
@ -1,89 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/todoist/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `h` <br />
|
||||
<span class="caption">Action:</span> Show the previous project.
|
||||
|
||||
<span class="caption">Key:</span> `←` <br />
|
||||
<span class="caption">Action:</span> Show the previous project.
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Show the next project.
|
||||
|
||||
<span class="caption">Key:</span> `→` <br />
|
||||
<span class="caption">Action:</span> Show the next project.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `c` <br />
|
||||
<span class="caption">Action:</span> Close current item.
|
||||
|
||||
<span class="caption">Key:</span> `d` <br />
|
||||
<span class="caption">Action:</span> Delete current item.
|
||||
|
||||
<span class="caption">Key:</span> `r` <br />
|
||||
<span class="caption">Action:</span> Reload all projects.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
todoist:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
projects:
|
||||
- 122247497
|
||||
refreshInterval: 3600
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://developer.todoist.com/sync/v7/">Todoist API</a> token.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`projects` <br />
|
||||
The todoist projects to fetch items from. <br />
|
||||
Values: The integer ID of the project.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@ -1,73 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/travisci/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
<span class="caption">Action:</span> Open the selected build in the browser.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next build in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous build in the list.
|
||||
|
||||
<span class="caption">Key:</span> `r` <br />
|
||||
<span class="caption">Action:</span> Refresh the data.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Select the next build in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Select the previous build in the list.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
travisci:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 4
|
||||
left: 1
|
||||
height: 1
|
||||
width: 2
|
||||
pro: false
|
||||
refreshInterval: 900
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your <a href="https://developer.travis-ci.org/authentication">Travis CI API</a> access token.
|
||||
|
||||
`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 />
|
||||
|
||||
`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`.
|
||||
@ -1,85 +0,0 @@
|
||||
---
|
||||
title: "Trello"
|
||||
date: 2018-05-10T10:44:35-07:00
|
||||
draft: false
|
||||
weight: 250
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/trello.png" width="640" height="197" alt="trello screenshot" />
|
||||
|
||||
Displays all Trello cards on specified lists.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/trello/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### Single Trello List
|
||||
|
||||
```yaml
|
||||
trello:
|
||||
accessToken: "7b8b14f8743a408a93276d7155dd9ee2"
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
board: Main
|
||||
enabled: true
|
||||
list: "Todo"
|
||||
position:
|
||||
height: 1
|
||||
left: 2
|
||||
top: 0
|
||||
width: 1
|
||||
refreshInterval: 3600
|
||||
username: myname
|
||||
```
|
||||
|
||||
### Multiple Trello Lists
|
||||
|
||||
If you want to monitor multiple Trello lists, use the following
|
||||
configuration (note the difference in `list`):
|
||||
|
||||
```yaml
|
||||
trello:
|
||||
accessToken: "7b8b14f8743a408a93276d7155dd9ee2"
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
board: Main
|
||||
enabled: true
|
||||
list: ["Todo", "Done"]
|
||||
position:
|
||||
height: 1
|
||||
left: 2
|
||||
top: 0
|
||||
width: 1
|
||||
refreshInterval: 3600
|
||||
username: myname
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`accessToken` <br />
|
||||
Value: Your Trello access token.
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your Trello API key.
|
||||
|
||||
`board` <br />
|
||||
The name of the Trello board. <br />
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`list` <br />
|
||||
The Trello lists to fetch cards from. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`username` <br />
|
||||
Your Trello username. <br />
|
||||
|
||||
`position` <br />
|
||||
Where in the grid this module's widget will be displayed. <br />
|
||||
@ -1,61 +0,0 @@
|
||||
---
|
||||
title: "Twitter"
|
||||
date: 2018-07-31T20:21:37-07:00
|
||||
draft: false
|
||||
weight: 260
|
||||
---
|
||||
|
||||
Added in `v0.2.0`.
|
||||
|
||||
Connects to the Twitter API and displays a single user's tweets.
|
||||
|
||||
NOTE: This only works for single-application developer accounts for now.
|
||||
|
||||
To make this work, you'll need a couple of things:
|
||||
|
||||
1. A [Twitter developer account](https://developer.twitter.com/content/developer-twitter/en.html)
|
||||
2. A [Twitter bearer token](https://developer.twitter.com/en/docs/basics/authentication/overview/application-only).
|
||||
|
||||
Once you have your developer account, a relatively painless way to get a
|
||||
bearer token is to use [TBT](https://github.com/Trinergy/twitter_bearer_token).
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/twitter/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
twitter:
|
||||
bearerToken: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 1
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 20000
|
||||
screenName: "wtfutil"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`bearerToken` <br />
|
||||
Value: Your <a href="https://developer.twitter.com/en/docs/basics/authentication/overview/application-only.html">Twitter single-application Bearer Token</a>
|
||||
|
||||
`enabled` <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 />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: Any positive integer, `0..n`.
|
||||
|
||||
`screenName` <br />
|
||||
The screen name of the Twitter user who's tweets you want to follow. <br />
|
||||
Values: Any valid Twitter user's screen name.
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
title: "Weather Services"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 270
|
||||
---
|
||||
|
||||
For all modules weather-related.
|
||||
|
||||
{{% children %}}
|
||||
@ -1,66 +0,0 @@
|
||||
---
|
||||
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).
|
||||
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/prettyweather/
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
prettyweather:
|
||||
enabled: true
|
||||
city: "tehran"
|
||||
position:
|
||||
top: 3
|
||||
left: 5
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 300
|
||||
unit: "c"
|
||||
view: 0
|
||||
language: "en"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`city` <br />
|
||||
_Optional_. It will grab the current location from your IP address if
|
||||
omitted.<br />
|
||||
Values: The name of any city supported by [Wttr.in](http://wttr.in).
|
||||
|
||||
`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`.
|
||||
|
||||
`unit` <br />
|
||||
_Optional_. It will use metric if you are out of US and imperial for US.<br />
|
||||
The temperature scale in which to display temperature values. <br />
|
||||
Values: `F` for Fahrenheit, `C` for Celcius.
|
||||
|
||||
`view` <br />
|
||||
_Optional_ Wttr.in view configuration. <br />
|
||||
Values: See `curl wttr.in/:help` for more details.
|
||||
|
||||
`language` <br />
|
||||
_Optional_ Wttr.in language configuration. <br />
|
||||
Values: See `curl wttr.in/:translation` for more details.
|
||||
@ -1,94 +0,0 @@
|
||||
---
|
||||
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.
|
||||
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/weather/
|
||||
```
|
||||
|
||||
## 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 weather location.
|
||||
|
||||
<span class="caption">Key:</span> `l` <br />
|
||||
<span class="caption">Action:</span> Show the next weather location.
|
||||
|
||||
<span class="caption">Key:</span> `←` <br />
|
||||
<span class="caption">Action:</span> Show the previous weather location.
|
||||
|
||||
<span class="caption">Key:</span> `→` <br />
|
||||
<span class="caption">Action:</span> Show the next weather location.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
weather:
|
||||
apiKey: "2dfb3e3650a1950adddb6badf5ba1aaa"
|
||||
# From http://openweathermap.org/help/city_list.txt
|
||||
cityids:
|
||||
- 6173331
|
||||
- 3128760
|
||||
- 6167865
|
||||
- 6176823
|
||||
colors:
|
||||
current: "lightblue"
|
||||
enabled: true
|
||||
language: "EN"
|
||||
position:
|
||||
top: 0
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 900
|
||||
tempUnit: "C"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key.
|
||||
|
||||
`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.
|
||||
@ -1,73 +0,0 @@
|
||||
---
|
||||
title: "Zendesk"
|
||||
date: 2018-07-23T18:55:37-08:00
|
||||
draft: false
|
||||
weight: 280
|
||||
---
|
||||
|
||||
Added in `v0.1.0`.
|
||||
|
||||
Displays tickets in the "New" status - i.e. have not yet been assigned.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/zendesk/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
<span class="caption">Action:</span> Open the selected ticket in the browser.
|
||||
|
||||
<span class="caption">Key:</span> `j` <br />
|
||||
<span class="caption">Action:</span> Select the next item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `k` <br />
|
||||
<span class="caption">Action:</span> Select the previous item in the list.
|
||||
|
||||
<span class="caption">Key:</span> `↓` <br />
|
||||
<span class="caption">Action:</span> Scroll down the list.
|
||||
|
||||
<span class="caption">Key:</span> `↑` <br />
|
||||
<span class="caption">Action:</span> Scroll up the list.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
zendesk:
|
||||
apiKey: "3276d7155dd9ee27b8b14f8743a408a9"
|
||||
enabled: true
|
||||
position:
|
||||
top: 0
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
status: "new"
|
||||
subdomain: "your_domain"
|
||||
username: "your_email@acme.com"
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Value: Your Zendesk API token.
|
||||
|
||||
`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 />
|
||||
|
||||
`status` <br />
|
||||
The status of tickets you want to retrieve.
|
||||
Values: `new`, `open`, `pending`, `hold`.
|
||||
|
||||
`subdomain` <br />
|
||||
Value: Your Zendesk subdomain.
|
||||
|
||||
`username` <br />
|
||||
Your Zendesk username
|
||||
Values: A valid Zendesk username (usually an email address).
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 242 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 87 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 47 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 60 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 63 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 48 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 129 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 106 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 74 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 72 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 89 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 47 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 42 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 109 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 426 KiB |
@ -1,22 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2014 Grav
|
||||
Copyright (c) 2016 MATHIEU CORNIC
|
||||
Copyright (c) 2017 Valere JEANTET
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@ -1,129 +0,0 @@
|
||||
# Hugo docDock Theme
|
||||
|
||||
This repository contains a theme for [Hugo](https://gohugo.io/), based on
|
||||
|
||||
* [Matcornic Learn theme](https://github.com/matcornic/hugo-theme-learn/).
|
||||
* [facette.io](https://facette.io/)'s documentation style css (Facette is a great time series data visualization software)
|
||||
|
||||
Visit the [theme documentation](http://docdock.netlify.com/) to see what is going on. It is actually built with this theme.
|
||||
|
||||
# Main features
|
||||
|
||||
- Search
|
||||
- **Unlimited menu levels**
|
||||
- RevealJS presentation from markdown (embededed or fullscreen page)
|
||||
- Attachments files
|
||||
- List child pages
|
||||
- Include segment of content from one page in another (Excerpt)
|
||||
- Automatic next/prev buttons to navigate through menu entries
|
||||
- Mermaid diagram
|
||||
- Icons, Buttons, Alerts, Panels, Tip/Note/Info/Warning boxes
|
||||
- Image resizing, shadow...
|
||||
- Customizable look and feel
|
||||
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Check that your Hugo version is minimum `0.30` with `hugo version`. We assume that all changes to Hugo content and customizations are going to be tracked by git (GitHub, Bitbucket etc.). Develop locally, build on remote system.
|
||||
|
||||
To start real work:
|
||||
|
||||
1. Initialize Hugo
|
||||
2. Install DocDock theme
|
||||
3. Configure DocDock and Hugo
|
||||
|
||||
### Prepare empty Hugo site
|
||||
|
||||
Create empty directory, which will be root of your Hugo project. Navigate there and let Hugo to create minimal required directory structure:
|
||||
```
|
||||
$ hugo new site .
|
||||
```
|
||||
AFTER that, initialize this as git directory where to track further changes
|
||||
```
|
||||
$ git init
|
||||
```
|
||||
|
||||
Next, there are at least three ways to install DocDock (first recommended):
|
||||
|
||||
1. **As git submodule**
|
||||
2. As git clone
|
||||
3. As direct copy (from ZIP)
|
||||
|
||||
Navigate to your themes folder in your Hugo site and use perform one of following scenarios.
|
||||
|
||||
### 1. Install DocDock as git submodule
|
||||
DocDock will be added like a dependency repo to original project. When using CI tools like Netlify, Jenkins etc., submodule method is required, or you will get `theme not found` issues. Same applies when building site on remote server trough SSH.
|
||||
|
||||
If submodule is no-go, use 3rd option.
|
||||
|
||||
On your root of Hugo execute:
|
||||
|
||||
```
|
||||
$ git submodule add https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
|
||||
```
|
||||
Next initialize submodule for parent git repo:
|
||||
|
||||
```
|
||||
$ git submodule init
|
||||
$ git submodule update
|
||||
```
|
||||
|
||||
Now you are ready to add content and customize looks. Do not change any file inside theme directory.
|
||||
|
||||
If you want to freeze changes to DocDock theme itself and use still submodules, fork private copy of DocDock and use that as submodule. When you are ready to update theme, just pull changes from origin to your private fork.
|
||||
|
||||
### 2. Install DocDock simply as git clone
|
||||
This method results that files are checked out locally, but won't be visible from parent git repo. Probably you will build site locally with `hugo` command and use result from `public/` on your own.
|
||||
|
||||
```
|
||||
$ git clone https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
|
||||
```
|
||||
|
||||
|
||||
### 3. Install DocDock from ZIP
|
||||
|
||||
All files from theme will be tracked inside parent repo, to update it, have to override files in theme. Download following zip and extract inside `themes/`.
|
||||
|
||||
```
|
||||
https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip
|
||||
```
|
||||
Name of theme in next step will be `hugo-theme-docdock-master`, can rename as you wish.
|
||||
|
||||
## Configure
|
||||
|
||||
Import sample config from sample site to Hugo root.
|
||||
|
||||
```
|
||||
$ cp themes/docdock/exampleSite/config.toml .
|
||||
```
|
||||
|
||||
Change following `config.toml` line as needed, depending on method above:
|
||||
```
|
||||
theme = "<hugo-theme-docdock-dir-name>"
|
||||
```
|
||||
Comment out following line, so default `themes/` will be used:
|
||||
|
||||
```
|
||||
# themesdir = "../.."
|
||||
```
|
||||
|
||||
#### (Bonus)
|
||||
Create empty file `.gitkeep` inside `public/` and add following to `.gitignore`. This way it will keep repo smaller and won't bring build result files and errors to remote checkout places:
|
||||
```
|
||||
/public/*
|
||||
!/public/.gitkeep
|
||||
```
|
||||
|
||||
### Preview site
|
||||
```
|
||||
$ hugo server
|
||||
```
|
||||
to browse site on http://localhost:1313
|
||||
|
||||
## Usage
|
||||
|
||||
- [Visit the documentation](http://docdock.netlify.com/)
|
||||
- [Hugo docs](https://gohugo.io/getting-started/configuration/)
|
||||
- [Git submodules](https://git-scm.com/docs/git-submodule)
|
||||
@ -1,4 +0,0 @@
|
||||
prose:
|
||||
rooturl: 'exampleSite/content'
|
||||
siteurl: 'https://docdock.netlify.com/'
|
||||
media: 'exampleSite/static'
|
||||
@ -1,9 +0,0 @@
|
||||
+++
|
||||
title= "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date= {{ .Date }}
|
||||
description = ""
|
||||
draft= true
|
||||
+++
|
||||
|
||||
Lorem Ipsum.
|
||||
Notice `draft` is set to true.
|
||||
@ -1,46 +0,0 @@
|
||||
+++
|
||||
title = "Slide title"
|
||||
type="slide"
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= true
|
||||
center= true
|
||||
+++
|
||||
|
||||
# Slide 1
|
||||
|
||||
___
|
||||
|
||||
## Slide 1.1
|
||||
|
||||
- Turn off alarm
|
||||
- Get out of bed
|
||||
|
||||
___
|
||||
|
||||
## Slide 1.2
|
||||
|
||||
- Eat eggs
|
||||
- Drink coffee
|
||||
|
||||
---
|
||||
|
||||
# Slide 2
|
||||
|
||||
___
|
||||
|
||||
## Slide 2.1
|
||||
|
||||
- Eat spaghetti
|
||||
- Drink wine
|
||||
|
||||
___
|
||||
|
||||
## Slide 2.2
|
||||
|
||||
- Get in bed
|
||||
- Count sheep
|
||||
@ -1,68 +0,0 @@
|
||||
baseURL = "/"
|
||||
|
||||
languageCode = "en-us"
|
||||
DefaultContentLanguage = "en"
|
||||
title = "DocDock Documentation"
|
||||
theme = "hugo-theme-docdock"
|
||||
themesdir = "../.."
|
||||
pygmentsCodeFences = true
|
||||
pygmentsStyle = "monokailight"
|
||||
|
||||
defaultContentLanguage = "en"
|
||||
defaultContentLanguageInSubdir= false
|
||||
enableMissingTranslationPlaceholders = false
|
||||
|
||||
|
||||
# [Languages]
|
||||
# [Languages.en]
|
||||
# title = "Documentation for Hugo docDock"
|
||||
# weight = 1
|
||||
# languageName = "English"
|
||||
#
|
||||
# [Languages.fr]
|
||||
# title = "Documentation du thème docDock"
|
||||
# weight = 2
|
||||
# languageName = "Français"
|
||||
|
||||
|
||||
|
||||
|
||||
[params]
|
||||
editURL = "https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/"
|
||||
showVisitedLinks = true # default is false
|
||||
themeStyle = "flex" # "original" or "flex" # default "flex"
|
||||
themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default)
|
||||
ordersectionsby = "weight" # ordersectionsby = "title"
|
||||
disableHomeIcon = false # default is false
|
||||
disableSearch = false # default is false
|
||||
disableNavChevron = false # set true to hide next/prev chevron, default is false
|
||||
highlightClientSide = false # set true to use highlight.pack.js instead of the default hugo chroma highlighter
|
||||
menushortcutsnewtab = false # set true to open shortcuts links to a new tab/window
|
||||
enableGitInfo = true
|
||||
|
||||
[outputs]
|
||||
home = [ "HTML", "RSS", "JSON"]
|
||||
|
||||
|
||||
[[menu.shortcuts]]
|
||||
pre = "<h3>More</h3>"
|
||||
name = "<i class='fa fa-github'></i> <label>Github repo</label>"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/vjeantet/hugo-theme-docdock"
|
||||
weight = 10
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-cloud-download'></i> <label>Download</label>"
|
||||
url = "https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip"
|
||||
weight = 11
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-bookmark'></i> <label>Hugo Documentation</label>"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 20
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-bullhorn'></i> <label>Credits</label>"
|
||||
url = "/credits"
|
||||
weight = 30
|
||||
@ -1,50 +0,0 @@
|
||||
+++
|
||||
title = "DocDock Theme for Hugo"
|
||||
description = ""
|
||||
+++
|
||||
|
||||
# Hugo docDock theme
|
||||
[Hugo-theme-docdock {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docdock) is a theme for Hugo, a fast and modern static website engine written in Go. Hugo is often used for blogs, **this theme is fully designed for documentation.**
|
||||
|
||||
This theme is a partial porting of the [Learn theme of matcornic {{%icon fa-github%}}](https://github.com/matcornic/hugo-theme-learn). and its default style "flex" comes from [facette.io](https://github.com/facette)'s documentation.
|
||||
|
||||
{{%panel%}}docDock works with a "page tree structure" to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "content-organisation/_index.md"%}}) {{%/panel%}}
|
||||
|
||||
## Main features
|
||||
|
||||
* [Automatic Search]({{%relref "search/_index.md" %}})
|
||||
* **Unlimited menu levels**
|
||||
* [Generate RevealJS presentation]({{%relref "page-slide.md"%}}) from markdown (embededed or fullscreen page)
|
||||
* Automatic next/prev buttons to navigate through menu entries
|
||||
* [Image resizing, shadow...]({{%relref "create-page/page-images.md" %}})
|
||||
* [Attachments files]({{%relref "shortcodes/attachments.md" %}})
|
||||
* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
|
||||
* [Excerpt]({{%relref "shortcodes/excerpt.md"%}}) ! Include segment of content from one page in another
|
||||
* [Mermaid diagram]({{%relref "shortcodes/mermaid.md" %}}) (flowchart, sequence, gantt)
|
||||
* [Icons]({{%relref "shortcodes/icon.md" %}}), [Buttons]({{%relref "shortcodes/button.md" %}}), [Alerts]({{%relref "shortcodes/alert.md" %}}), [Panels]({{%relref "shortcodes/panel.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.md" %}}), [Expand]({{%relref "shortcodes/expand.md" %}})
|
||||
* [customizable look and feel]({{%relref "content-organisation/customize-style/_index.md"%}}), [theme style]({{%relref "content-organisation/customize-style/themestyle.md"%}}), [theme variants]({{%relref "content-organisation/customize-style/theme-variants.md"%}})
|
||||
|
||||
|
||||
|
||||
Style "Flex" (default)
|
||||
|
||||
|
||||
|
||||
Style "Original"
|
||||
|
||||
|
||||
|
||||
## Contribute to this documentation
|
||||
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
|
||||
{{%alert%}}Your modification will be deployed automatically when merged.{{%/alert%}}
|
||||
|
||||
|
||||
## Documentation website
|
||||
This current documentation has been statically generated with Hugo with a simple command : `hugo -t docdock` -- source code is [available here at GitHub {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docDock)
|
||||
|
||||
{{% panel theme="success" header="Automated deployments" footer="Netlify builds, deploys, and hosts frontends." %}}
|
||||
Automatically published and hosted thanks to [Netlify](https://www.netlify.com/).
|
||||
|
||||
Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)
|
||||
{{% /panel %}}
|
||||
|
||||
@ -1,138 +0,0 @@
|
||||
+++
|
||||
title = "Content Organisation"
|
||||
description = ""
|
||||
weight = 20
|
||||
+++
|
||||
|
||||
With **Hugo**, pages are the core of your site. Organize your site like any other Hugo project. **Magic occurs with the nested sections implemention done in v0.22 of hugo (congrats @bep)**.
|
||||
|
||||
With docdock, **Each content page composes the menu**, they shape the structure of your website.
|
||||
|
||||
To link pages to each other, place them in a folders hierarchy
|
||||
|
||||
```
|
||||
content
|
||||
├── level-one
|
||||
│ ├── level-two
|
||||
│ │ ├── level-three
|
||||
│ │ │ ├── level-four
|
||||
│ │ │ │ ├── _index.md
|
||||
│ │ │ │ ├── page-4-a.md
|
||||
│ │ │ │ ├── page-4-b.md
|
||||
│ │ │ │ └── page-4-c.md
|
||||
│ │ │ ├── _index.md
|
||||
│ │ │ ├── page-3-a.md
|
||||
│ │ │ ├── page-3-b.md
|
||||
│ │ │ └── page-3-c.md
|
||||
│ │ ├── _index.md
|
||||
│ │ ├── page-2-a.md
|
||||
│ │ ├── page-2-b.md
|
||||
│ │ └── page-2-c.md
|
||||
│ ├── _index.md
|
||||
│ ├── page-1-a.md
|
||||
│ ├── page-1-b.md
|
||||
│ └── page-1-c.md
|
||||
├── _index.md
|
||||
└── page-top.md
|
||||
```
|
||||
|
||||
|
||||
{{%alert info %}} **_index.md** is required in each folder, it's your "folder home page"{{%/alert%}}
|
||||
|
||||
### Add header to a menu entry
|
||||
|
||||
in the page frontmatter, add a `head` param to insert any HTML code before the menu entry:
|
||||
|
||||
example to display a "Hello"
|
||||
|
||||
+++
|
||||
title = "Github repo"
|
||||
head ="<label>Hello</label> "
|
||||
+++
|
||||
|
||||
|
||||
|
||||
### Add icon to a menu entry
|
||||
|
||||
in the page frontmatter, add a `pre` param to insert any HTML code before the menu label:
|
||||
|
||||
example to display a github icon
|
||||
|
||||
+++
|
||||
title = "Github repo"
|
||||
pre ="<i class='fa fa-github'></i> "
|
||||
+++
|
||||
|
||||
|
||||
|
||||
<!-- ### Customize menu entry label
|
||||
|
||||
Add a `name` param next to `[menu.main]`
|
||||
|
||||
+++
|
||||
[menu.main]
|
||||
parent = ""
|
||||
identifier = "repo"
|
||||
pre ="<i class='fa fa-github'></i> "
|
||||
name = "Github repo"
|
||||
+++ -->
|
||||
|
||||
<!-- ### Create a page redirector
|
||||
Add a `url` param next to `[menu.main]`
|
||||
|
||||
+++
|
||||
[menu.main]
|
||||
parent = "page"
|
||||
identifier = "page-images"
|
||||
weight = 23
|
||||
url = "/shortcode/image/"
|
||||
+++
|
||||
|
||||
{{%alert info%}}Look at the menu "Create Page/About images" which redirects to "Shortcodes/image{{%/alert%}}
|
||||
-->
|
||||
### Order sibling menu/page entries
|
||||
|
||||
in your frontmatter add `weight` param with a number to order.
|
||||
|
||||
+++
|
||||
title="My page"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
{{%info%}}add `ordersectionsby = "title"` in your config.toml to order menu entries by title{{%/info%}}
|
||||
|
||||
|
||||
### Hide a menu entry
|
||||
|
||||
in your frontmatter add `hidden=true` param.
|
||||
|
||||
+++
|
||||
title="My page"
|
||||
hidden = true
|
||||
+++
|
||||
|
||||
|
||||
### Unfolded menu entry by default
|
||||
|
||||
One or more menuentries can be displayed unfolded by default. (like the "Getting start" menu entry in this website)
|
||||
|
||||
in your frontmatter add `alwaysopen=true` param.
|
||||
example :
|
||||
|
||||
```
|
||||
title = "Getting start"
|
||||
description = ""
|
||||
weight = 1
|
||||
alwaysopen = true
|
||||
```
|
||||
|
||||
### Folder structure and file name
|
||||
|
||||
Content organization **is** your `content` folder structure.
|
||||
|
||||
### Homepage
|
||||
|
||||
Find out how to [customize homepage]({{%relref "homepage.md"%}})
|
||||
|
||||
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
+++
|
||||
title = "Customize website look and feel"
|
||||
Weight=3
|
||||
+++
|
||||
|
||||
You can change the style and behavior of the theme without touching it.
|
||||
|
||||
* inject your own html, css or js into the page
|
||||
* overide existing css or js with your own files
|
||||
|
||||
{{%notice note %}}
|
||||
No needs to copy the entire theme to customize some parts
|
||||
Bellow are solutions to avoid copying the entire theme into your own codebase.
|
||||
{{%/notice%}}
|
||||
|
||||
## Add custom CSS and JS or HTML into the \<head\> part of each page :
|
||||
|
||||
Create a custom header partial `layouts/partials/custom-head.html`
|
||||
|
||||
> * content/
|
||||
> * layouts/
|
||||
> * partials/
|
||||
> * custom-head.html
|
||||
|
||||
write your own content like (an example from @nzbart):
|
||||
```html
|
||||
<link rel="stylesheet" href="/css/custom.css">
|
||||
<script src="/js/custom.js"></script>
|
||||
```
|
||||
|
||||
Then overrode the style your want to change in `static/css/custom.css` (in this case, to avoid altering the casing of titles):
|
||||
```css
|
||||
h2 {
|
||||
text-transform: none;
|
||||
}
|
||||
```
|
||||
|
||||
And executed some additional JavaScript from `static/js/custom.js` (note that jQuery is already loaded by the theme):
|
||||
```javascript
|
||||
function tweakPage() {
|
||||
// make some changes here
|
||||
}
|
||||
|
||||
$(tweakPage)
|
||||
```
|
||||
|
||||
|
||||
now feel free to add the JS, CSS, HTML code you want :)
|
||||
|
||||
## Add custom HTML at the end of the body part of each page :
|
||||
|
||||
Create a `custom-footer.html` into a `layouts/partials` folder next to the content folder
|
||||
|
||||
> * content/
|
||||
> * layouts/
|
||||
> * partials/
|
||||
> * custom-footer.html
|
||||
|
||||
now feel free to add the JS, CSS, HTML code you want :)
|
||||
|
||||
## Overide existing CSS or JS
|
||||
|
||||
Create the matching file in your static folder, hugo will use yours instead of the theme's one.
|
||||
Example :
|
||||
|
||||
create a theme.css and place it into `static/css/` to fully overide docdock's theme.css
|
||||
@ -1,24 +0,0 @@
|
||||
+++
|
||||
title = "Disable features"
|
||||
+++
|
||||
|
||||
You can disable feature in docdock by changing some params in `config.toml`
|
||||
|
||||
|
||||
## hide Next / Prev Chevrons
|
||||
```
|
||||
[params]
|
||||
disableNavChevron = true
|
||||
```
|
||||
|
||||
## hide Search box in side menu
|
||||
```
|
||||
[params]
|
||||
disableSearch = true
|
||||
```
|
||||
|
||||
## hide the {{%icon fa-home%}} icon in side bar
|
||||
```
|
||||
[params]
|
||||
disableHomeIcon = true
|
||||
```
|
||||
@ -1,35 +0,0 @@
|
||||
+++
|
||||
title = "Theme variants"
|
||||
description = "change theme style/colors"
|
||||
+++
|
||||
|
||||
In site configuration file, you can set a variant name of this theme to load a specific css, with different color specifications.
|
||||
|
||||
add a param `themeVariant = "VARIANT_NAME"` in the `[params]` part of config.toml file.
|
||||
|
||||
{{%info%}}Available variants change only colors at this moment{{%/info%}}
|
||||
|
||||
|
||||
## Variant "gray"
|
||||
```
|
||||
[params]
|
||||
themeVariant = "gray"
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Variant "gold"
|
||||
```
|
||||
[params]
|
||||
themeVariant = "gold"
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Variant "green"
|
||||
```
|
||||
[params]
|
||||
themeVariant = "green"`
|
||||
```
|
||||
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
+++
|
||||
title = "Theme styles"
|
||||
description = "change theme style"
|
||||
+++
|
||||
|
||||
In site configuration file, you can set a subtheme name of this theme to load a specific css.
|
||||
|
||||
add a param `themeStyle = "STYLE_NAME"` in the `[params]` part of config.toml file.
|
||||
|
||||
|
||||
## Style "original"
|
||||
```
|
||||
[params]
|
||||
themeStyle = "original"
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Style "flex" (work in progress)
|
||||
```
|
||||
[params]
|
||||
themeStyle = "flex"
|
||||
```
|
||||
|
||||
|
||||
@ -1,28 +0,0 @@
|
||||
+++
|
||||
title = "Extra menu entries"
|
||||
date = "2017-04-29T18:36:24+02:00"
|
||||
Weight=2
|
||||
+++
|
||||
|
||||
You can define additional menu entries in the navigation menu without any link to content.
|
||||
|
||||
Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
|
||||
|
||||
|
||||
Example from the current website, **note the `pre` param** which allows you to insert HTML code and used here to separate content's menu from this "static" menu
|
||||
|
||||
[[menu.shortcuts]]
|
||||
pre = "<h3>More</h3>"
|
||||
name = "<i class='fa fa-github'></i> Github repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/vjeantet/hugo-theme-docdock"
|
||||
weight = 1
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 2
|
||||
|
||||
|
||||
[{{%icon circle-arrow-right%}} Read more about hugo and menu here](https://gohugo.io/extras/menus/)
|
||||
@ -1,12 +0,0 @@
|
||||
+++
|
||||
title = "Logo placeholder"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
Weight=1
|
||||
+++
|
||||
|
||||
Create a `_header.md` page in content folder. Its content is what you get in the logo placeholder (top left of the screen).
|
||||
|
||||
{{%alert info%}}**Tip :** you can add a image, a combobox with links to other documentation....{{%/alert%}}
|
||||
|
||||
{{%alert info%}}**Tip 2 :** look at [ extra static menu]({{%relref "extramenu.md"%}}) if you want to add links to other website in this sidebar{{%/alert%}}
|
||||
@ -1,54 +0,0 @@
|
||||
+++
|
||||
title = "Create Page"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
creatordisplayname = "Valere JEANTET"
|
||||
creatoremail = "valere.jeantet@gmail.com"
|
||||
lastmodifierdisplayname = "Valere JEANTET"
|
||||
lastmodifieremail = "valere.jeantet@gmail.com"
|
||||
tags = ["tag1","tag2"]
|
||||
weight = 10
|
||||
pre ="<i class='fa fa-edit' ></i> "
|
||||
|
||||
+++
|
||||
|
||||
|
||||
Hugo-theme-docdock defines two types of pages. _Default_ and _Slide_.
|
||||
|
||||
* **Default** is the common page like the current one you are reading.
|
||||
* **Slide** is a page that use the full screen to display its markdown content as a [reveals.js presentation](http://lab.hakim.se/reveal-js/).
|
||||
* **HomePage** is a special content that will be displayed as home page content.
|
||||
|
||||
To tell Hugo-theme-docdock to consider a page as a slide, just add a `type="slide"`in then frontmatter of your file. [{{%icon circle-arrow-right%}}read more on page as slide]({{%relref "page-slide.md"%}})
|
||||
|
||||
|
||||
Hugo-theme-docdock provides archetypes to help you create this kind of pages.
|
||||
|
||||
|
||||
## Front Matter
|
||||
Each Hugo page has to define a Front Matter in yaml, toml or json.
|
||||
|
||||
Hugo-theme-docdock uses the following parameters on top of the existing ones :
|
||||
|
||||
+++
|
||||
# Type of content, set "slide" to display it fullscreen with reveal.js
|
||||
type="page"
|
||||
|
||||
# Creator's Display name
|
||||
creatordisplayname = "Valere JEANTET"
|
||||
# Creator's Email
|
||||
creatoremail = "valere.jeantet@gmail.com"
|
||||
# LastModifier's Display name
|
||||
lastmodifierdisplayname = "Valere JEANTET"
|
||||
# LastModifier's Email
|
||||
lastmodifieremail = "valere.jeantet@gmail.com"
|
||||
+++
|
||||
|
||||
|
||||
## Ordering
|
||||
|
||||
Hugo provides a flexible way to handle order for your pages.
|
||||
|
||||
The simplest way is to use `weight` parameter in the front matter of your page.
|
||||
|
||||
[{{%icon circle-arrow-right%}}Read more on content organization]({{%relref "content-organisation/_index.md"%}})
|
||||
@ -1,8 +0,0 @@
|
||||
+++
|
||||
title = "Home page"
|
||||
description = ""
|
||||
date = "2017-04-28T18:36:24+02:00"
|
||||
tags = ["tag1","tag2"]
|
||||
+++
|
||||
|
||||
To tell Hugo-theme-docdock to consider a page as homepage's content, just create a content file named `_index.md` in content folder.
|
||||
@ -1,48 +0,0 @@
|
||||
+++
|
||||
title = "My Slide ! fullscreen"
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
type="slide"
|
||||
hidden=true
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= false
|
||||
center= true
|
||||
+++
|
||||
|
||||
# In the morning
|
||||
|
||||
___
|
||||
|
||||
## Getting up
|
||||
|
||||
- Turn off alarm
|
||||
- Get out of bed
|
||||
|
||||
___
|
||||
|
||||
## Breakfast
|
||||
|
||||
- Eat eggs
|
||||
- Drink coffee
|
||||
|
||||
---
|
||||
|
||||
# In the evening
|
||||
|
||||
___
|
||||
|
||||
## Dinner
|
||||
|
||||
- Eat spaghetti
|
||||
- Drink wine
|
||||
|
||||
___
|
||||
|
||||
## Going to sleep
|
||||
|
||||
- Get in bed
|
||||
- Count sheep
|
||||
@ -1,28 +0,0 @@
|
||||
+++
|
||||
title = "About images"
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
+++
|
||||
|
||||
Images have a similar syntax to links but include a preceding exclamation point.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Resizing image
|
||||
|
||||
Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Add CSS classes
|
||||
|
||||
Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow` and `border` are available but you could define other ones.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,114 +0,0 @@
|
||||
+++
|
||||
title = "Present a Slide"
|
||||
description = ""
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
+++
|
||||
|
||||
A basic md content page can be rendered as a reveal.js presentation full screen.
|
||||
|
||||
{{%alert info%}}You can, also, **embed presentation in a page** as a small box, using the [revealjs]({{% relref "shortcodes/revealjs.md"%}}) shortcode in your md file.{{%/alert%}}
|
||||
|
||||
|
||||
## Formating
|
||||
Use your common Markdown syntax you use in Hugo, don't forget, you can put html tags too.
|
||||
|
||||
{{%notice info %}} Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.
|
||||
{{%/notice%}}
|
||||
|
||||
Please read the [{{%icon book%}} doc from hakimel](https://github.com/hakimel/reveal.js/#instructions)
|
||||
|
||||
|
||||
## Options
|
||||
In the frontmatter of your page file, set **type** and **revealOptions** params
|
||||
|
||||
Your content will be served as a fullscreen revealjs presentation and revealOptions will be used to ajust its behaviour.
|
||||
|
||||
+++
|
||||
title = "Test slide"
|
||||
type="slide"
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= true
|
||||
center= true
|
||||
+++
|
||||
|
||||
[read more about reveal options here](https://github.com/hakimel/reveal.js/#configuration)
|
||||
|
||||
|
||||
## Slide Delimiters
|
||||
When creating the content for your slideshow presentation within content markdown file you need to be able to distinguish between one slide and the next. This is achieved very simply using a convention within Markdown that indicates the start of each new slide.
|
||||
|
||||
As both horizontal and vertical slides are supported by reveal.js each has it's own unique delimiter.
|
||||
|
||||
To denote the start of a horizontal slide simply add the following delimiter in your Markdown:
|
||||
|
||||
---
|
||||
|
||||
|
||||
To denote the start of a vertical slide simply add the following delimiter in your Markdown:
|
||||
|
||||
___
|
||||
|
||||
By using a combination of horizontal and vertical slides you can customize the navigation within your slideshow presentation. Typically vertical slides are used to present information below a top-level horizontal slide.
|
||||
|
||||
|
||||
|
||||
For example, a very simple slideshow presentation can be created as follows
|
||||
|
||||
```
|
||||
+++
|
||||
|
||||
title = "test"
|
||||
date = "2017-04-24T18:36:24+02:00"
|
||||
type="slide"
|
||||
|
||||
theme = "league"
|
||||
[revealOptions]
|
||||
transition= 'concave'
|
||||
controls= true
|
||||
progress= true
|
||||
history= true
|
||||
center= true
|
||||
+++
|
||||
|
||||
# In the morning
|
||||
|
||||
___
|
||||
|
||||
## Getting up
|
||||
|
||||
- Turn off alarm
|
||||
- Get out of bed
|
||||
|
||||
___
|
||||
|
||||
## Breakfast
|
||||
|
||||
- Eat eggs
|
||||
- Drink coffee
|
||||
|
||||
---
|
||||
|
||||
# In the evening
|
||||
|
||||
___
|
||||
|
||||
## Dinner
|
||||
|
||||
- Eat spaghetti
|
||||
- Drink wine
|
||||
|
||||
___
|
||||
|
||||
## Going to sleep
|
||||
|
||||
- Get in bed
|
||||
- Count sheep
|
||||
|
||||
```
|
||||
|
||||
[{{%icon expand%}}click here to view this page rendered]({{%relref "myslide.md"%}})
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user