diff --git a/Makefile b/Makefile
index dfa59a84..2785dc1d 100644
--- a/Makefile
+++ b/Makefile
@@ -8,6 +8,7 @@ contrib_check:
install:
go clean
+make installd
go install -ldflags="-s -w -X main.version=$(shell git describe --always --abbrev=6) -X main.date=$(shell date +%FT%T%z)"
which wtf
diff --git a/_site/config.toml b/_site/config.toml
index 60465521..c99807c1 100644
--- a/_site/config.toml
+++ b/_site/config.toml
@@ -12,7 +12,6 @@ defaultContentLanguage = "en"
defaultContentLanguageInSubdir= false
enableMissingTranslationPlaceholders = false
-
# [Languages]
# [Languages.en]
# title = "Documentation for WTF"
diff --git a/_site/content/_footer.md b/_site/content/_footer.md
new file mode 100644
index 00000000..e69de29b
diff --git a/_site/content/posts/configuration.md b/_site/content/configuration/_index.md
similarity index 99%
rename from _site/content/posts/configuration.md
rename to _site/content/configuration/_index.md
index c2956af8..84405e0e 100644
--- a/_site/content/posts/configuration.md
+++ b/_site/content/configuration/_index.md
@@ -2,6 +2,7 @@
title: "Configuration"
date: 2018-04-15T21:17:16-07:00
draft: false
+weight: 5
---
## Index
diff --git a/_site/content/posts/configuration/attributes.md b/_site/content/configuration/attributes.md
similarity index 93%
rename from _site/content/posts/configuration/attributes.md
rename to _site/content/configuration/attributes.md
index 1f4a8a96..881b9e96 100644
--- a/_site/content/posts/configuration/attributes.md
+++ b/_site/content/configuration/attributes.md
@@ -1,7 +1,8 @@
---
-title: "Configuration: Attributes"
+title: "Attributes"
date: 2018-05-16T21:51:23-07:00
draft: false
+weight: 5
---
The following top-level attributes are configurable in `config.yml`.
@@ -12,7 +13,7 @@ wtf:
colors:
background: "red"
border:
- Focusable: "darkslateblue"
+ focusable: "darkslateblue"
focused: "orange"
normal: "gray"
grid:
@@ -23,9 +24,8 @@ wtf:
# How _high_ the rows are, in terminal lines. In this case we have five rows
# that support ten line of text, one of three lines, and one of four
rows: [10, 10, 10, 10, 10, 3, 4]
- # The app redraws itself once a second
- openFileUtil: open
- refreshInterval: 1
+ openFileUtil: open # the name of the utility to call to open files
+ refreshInterval: 1 # the app refreshes once per second
term: "xterm-256color"
```
diff --git a/_site/content/posts/configuration/iterm2.md b/_site/content/configuration/iterm2.md
similarity index 96%
rename from _site/content/posts/configuration/iterm2.md
rename to _site/content/configuration/iterm2.md
index d42a99b1..ba981d6d 100644
--- a/_site/content/posts/configuration/iterm2.md
+++ b/_site/content/configuration/iterm2.md
@@ -1,7 +1,8 @@
---
-title: "Configuration: iTerm2"
+title: "iTerm2"
date: 2018-05-24T09:57:40-07:00
draft: false
+weight: 10
---
Many terminal apps don't properly display multibyte emoji characters
diff --git a/_site/content/posts/overview.md b/_site/content/getting_started/_index.md
similarity index 98%
rename from _site/content/posts/overview.md
rename to _site/content/getting_started/_index.md
index 126715d7..1366be24 100644
--- a/_site/content/posts/overview.md
+++ b/_site/content/getting_started/_index.md
@@ -1,7 +1,8 @@
---
-title: "Overview"
+title: "Getting Started"
date: 2018-05-21T16:11:58-07:00
draft: false
+weight: 1
---
WTF is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.
diff --git a/_site/content/posts/glossary.md b/_site/content/getting_started/glossary.md
similarity index 100%
rename from _site/content/posts/glossary.md
rename to _site/content/getting_started/glossary.md
diff --git a/_site/content/posts/installation.md b/_site/content/getting_started/installation.md
similarity index 77%
rename from _site/content/posts/installation.md
rename to _site/content/getting_started/installation.md
index dcc4aafa..1b78b771 100644
--- a/_site/content/posts/installation.md
+++ b/_site/content/getting_started/installation.md
@@ -4,20 +4,6 @@ date: 2018-05-18T09:59:40-07:00
draft: false
---
-There are two ways to install WTF:
-
-## From Source
-
-Get this repo and install the dependencies:
-
-```bash
-go get -u github.com/senorprogrammer/wtf
-cd $GOPATH/src/github.com/senorprogrammer/wtf
-make install
-make run
-```
-and that should probably do it.
-
## As a Binary
Grab the latest version from here:
@@ -33,3 +19,16 @@ expand it, and `cd` into the resulting directory. Then run:
```
and that should also do it.
+
+## From Source
+
+Download the source code repo and install the dependencies:
+
+```bash
+go get -u github.com/senorprogrammer/wtf
+cd $GOPATH/src/github.com/senorprogrammer/wtf
+go install -ldflags="-s -w"
+make run
+```
+and that should do it.
+
diff --git a/_site/content/posts/modules.md b/_site/content/modules/_index.md
similarity index 98%
rename from _site/content/posts/modules.md
rename to _site/content/modules/_index.md
index 6dc676b3..8ca1d61b 100644
--- a/_site/content/posts/modules.md
+++ b/_site/content/modules/_index.md
@@ -2,6 +2,7 @@
title: "Modules"
date: 2018-05-07T18:04:58-07:00
draft: false
+weight: 10
---
The heart of WTF is the modules. A module is a discreet unit of
diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/modules/bamboohr.md
similarity index 97%
rename from _site/content/posts/modules/bamboohr.md
rename to _site/content/modules/bamboohr.md
index 6d75f242..9734caf5 100644
--- a/_site/content/posts/modules/bamboohr.md
+++ b/_site/content/modules/bamboohr.md
@@ -2,6 +2,7 @@
title: "BambooHR"
date: 2018-05-07T20:17:37-07:00
draft: false
+weight: 10
---
Connects to the BambooHR API and displays who will be Away today.
@@ -12,10 +13,6 @@ Connects to the BambooHR API and displays who will be Away today.
wtf/bamboohr/
```
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/circleci.md b/_site/content/modules/circleci.md
similarity index 87%
rename from _site/content/posts/modules/circleci.md
rename to _site/content/modules/circleci.md
index 351a54de..6994ec53 100644
--- a/_site/content/posts/modules/circleci.md
+++ b/_site/content/modules/circleci.md
@@ -2,13 +2,15 @@
title: "CircleCI"
date: 2018-06-10T19:26:08-04:00
draft: false
+weight: 20
---
+
+
Added in `v0.0.7`.
Displays build information for your CircleCI account.
-
## Source Code
@@ -16,10 +18,6 @@ Displays build information for your CircleCI account.
wtf/circleci/
```
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/clocks.md b/_site/content/modules/clocks.md
similarity index 92%
rename from _site/content/posts/modules/clocks.md
rename to _site/content/modules/clocks.md
index 53864796..7eced25d 100644
--- a/_site/content/posts/modules/clocks.md
+++ b/_site/content/modules/clocks.md
@@ -2,11 +2,13 @@
title: "Clocks"
date: 2018-05-07T19:47:31-07:00
draft: false
+weight: 30
---
+
+
Displays a configurable list of world clocks, the local time, and date.
-
## Source Code
@@ -14,14 +16,6 @@ Displays a configurable list of world clocks, the local time, and date.
wtf/clocks/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/cmdrunner.md b/_site/content/modules/cmdrunner.md
similarity index 93%
rename from _site/content/posts/modules/cmdrunner.md
rename to _site/content/modules/cmdrunner.md
index 856984bf..d198555e 100644
--- a/_site/content/posts/modules/cmdrunner.md
+++ b/_site/content/modules/cmdrunner.md
@@ -2,6 +2,7 @@
title: "CmdRunner"
date: 2018-05-17T17:17:10-07:00
draft: false
+weight: 40
---
Runs a terminal command on a schedule.
@@ -12,14 +13,6 @@ Runs a terminal command on a schedule.
wtf/cmdrunner/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/modules/cryptocurrencies/_index.md b/_site/content/modules/cryptocurrencies/_index.md
new file mode 100644
index 00000000..add5c26a
--- /dev/null
+++ b/_site/content/modules/cryptocurrencies/_index.md
@@ -0,0 +1,8 @@
+---
+title: "Crypo Currencies"
+date: 2018-05-07T18:04:58-07:00
+draft: false
+weight: 50
+---
+
+For all modules cryptocurrency-related.
diff --git a/_site/content/posts/modules/cryptocurrencies/bittrex.md b/_site/content/modules/cryptocurrencies/bittrex.md
similarity index 91%
rename from _site/content/posts/modules/cryptocurrencies/bittrex.md
rename to _site/content/modules/cryptocurrencies/bittrex.md
index 8ee4ad37..e8cd9123 100644
--- a/_site/content/posts/modules/cryptocurrencies/bittrex.md
+++ b/_site/content/modules/cryptocurrencies/bittrex.md
@@ -2,28 +2,21 @@
title: "Bittrex"
date: 2018-06-04T20:06:40-07:00
draft: false
+weight: 5
---
+
+
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/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/cryptocurrencies/blockfolio.md b/_site/content/modules/cryptocurrencies/blockfolio.md
similarity index 89%
rename from _site/content/posts/modules/cryptocurrencies/blockfolio.md
rename to _site/content/modules/cryptocurrencies/blockfolio.md
index 06df64cc..b04ec30f 100644
--- a/_site/content/posts/modules/cryptocurrencies/blockfolio.md
+++ b/_site/content/modules/cryptocurrencies/blockfolio.md
@@ -2,13 +2,15 @@
title: "Blockfolio"
date: 2018-06-13T09:29:59-07:00
draft: false
+weight: 10
---
+
+
Added in `v0.0.8`.
Display your Blockfolio crypto holdings.
-
## Source
@@ -16,14 +18,6 @@ Display your Blockfolio crypto holdings.
wtf/blockfolio/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/cryptocurrencies/cryptolive.md b/_site/content/modules/cryptocurrencies/cryptolive.md
similarity index 88%
rename from _site/content/posts/modules/cryptocurrencies/cryptolive.md
rename to _site/content/modules/cryptocurrencies/cryptolive.md
index 2fd27310..1eb77e00 100644
--- a/_site/content/posts/modules/cryptocurrencies/cryptolive.md
+++ b/_site/content/modules/cryptocurrencies/cryptolive.md
@@ -2,13 +2,15 @@
title: "CryptoLive"
date: 2018-06-03T20:06:40-07:00
draft: false
+weight: 15
---
+
+
Added in `v0.0.5`.
Compare crypto currencies using [CryptoCompare](https://cryptocompare.com).
-
## Source Code
@@ -16,14 +18,6 @@ Compare crypto currencies using [CryptoCompare](https://cryptocompare.com).
wtf/cryptoexchanges/cryptolive/
```
-## Required ENV Vars
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
@@ -33,12 +27,12 @@ cryptolive:
top: 5
left: 2
height: 1
- width: 2
+ width: 2
updateInterval: 15
- currencies:
+ currencies:
BTC:
displayName: Bitcoin
- to:
+ to:
- USD
- EUR
- ETH
@@ -46,7 +40,7 @@ cryptolive:
- DOGE
LTC:
displayName: Ethereum
- to:
+ to:
- USD
- EUR
- BTC
@@ -56,7 +50,7 @@ cryptolive:
limit: 5
to:
- USD
- colors:
+ colors:
from:
name: coral
displayName: grey
diff --git a/_site/content/posts/modules/gcal.md b/_site/content/modules/gcal.md
similarity index 96%
rename from _site/content/posts/modules/gcal.md
rename to _site/content/modules/gcal.md
index 6e4ec060..e087a502 100644
--- a/_site/content/posts/modules/gcal.md
+++ b/_site/content/modules/gcal.md
@@ -2,11 +2,12 @@
title: "Google Calendar"
date: 2018-05-10T08:25:33-07:00
draft: false
+weight: 60
---
-Displays your upcoming Google calendar events.
+
-
+Displays your upcoming Google calendar events.
**Not:** Setting up access to Google Calendars for Go is a bit unobvious. Check out Google's [Go Quickstart](https://developers.google.com/calendar/quickstart/go)
first and if you have problems, then take a look at this [comment by WesleydeSouza](https://github.com/senorprogrammer/wtf/issues/83#issuecomment-393665229) which offers a slightly different approach.
@@ -17,14 +18,6 @@ first and if you have problems, then take a look at this [comment by WesleydeSou
wtf/gcal/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/gerrit.md b/_site/content/modules/gerrit.md
similarity index 96%
rename from _site/content/posts/modules/gerrit.md
rename to _site/content/modules/gerrit.md
index 26d912a5..6d3c83f6 100644
--- a/_site/content/posts/modules/gerrit.md
+++ b/_site/content/modules/gerrit.md
@@ -2,8 +2,11 @@
title: "Gerrit"
date: 2018-06-27T15:55:42-07:00
draft: false
+weight: 70
---
+
+
Displays information about your projects hosted on Gerrit:
#### Open Incoming Reviews
@@ -14,8 +17,6 @@ All open reviews that are requesting your approval.
All open reviews created by you.
-
-
## Source Code
```bash
diff --git a/_site/content/posts/modules/git.md b/_site/content/modules/git.md
similarity index 95%
rename from _site/content/posts/modules/git.md
rename to _site/content/modules/git.md
index b601bfdd..49f86990 100644
--- a/_site/content/posts/modules/git.md
+++ b/_site/content/modules/git.md
@@ -2,13 +2,14 @@
title: "Git"
date: 2018-05-09T14:20:48-07:00
draft: false
+weight: 80
---
+
+
Displays information about local git repositories: branch, changed
files, and recent commits.
-
-
#### Branch
The name of the currently-active git branch.
@@ -28,10 +29,6 @@ A list of `n` recent commits, who committed it, and when.
wtf/git/
```
-## Required ENV Variables
-
-None.
-
## Keyboard Commands
Key: `/`
diff --git a/_site/content/posts/modules/github.md b/_site/content/modules/github.md
similarity index 95%
rename from _site/content/posts/modules/github.md
rename to _site/content/modules/github.md
index bc80f930..449ebab8 100644
--- a/_site/content/posts/modules/github.md
+++ b/_site/content/modules/github.md
@@ -2,10 +2,12 @@
title: "GitHub"
date: 2018-05-09T19:20:20-07:00
draft: false
+weight: 90
---
-Displays information about your git repositories hosted on GitHub:
+
+Displays information about your git repositories hosted on GitHub:
#### Open Review Requests
@@ -15,8 +17,6 @@ All open code review requests assigned to you.
All open pull requests created by you.
-
-
## Source Code
```bash
diff --git a/_site/content/posts/modules/gitlab.md b/_site/content/modules/gitlab.md
similarity index 94%
rename from _site/content/posts/modules/gitlab.md
rename to _site/content/modules/gitlab.md
index 671dfe74..64d6fef8 100644
--- a/_site/content/posts/modules/gitlab.md
+++ b/_site/content/modules/gitlab.md
@@ -2,11 +2,12 @@
title: "GitLab"
date: 2018-06-08T13:14:11-07:00
draft: false
+weight: 100
---
-Added in `v0.0.8`.
+
-
+Added in `v0.0.8`.
Displays information about your projects hosted on GitLab:
diff --git a/_site/content/posts/modules/gspreadsheet.md b/_site/content/modules/gspreadsheet.md
similarity index 95%
rename from _site/content/posts/modules/gspreadsheet.md
rename to _site/content/modules/gspreadsheet.md
index aaea2384..2d4425f6 100644
--- a/_site/content/posts/modules/gspreadsheet.md
+++ b/_site/content/modules/gspreadsheet.md
@@ -2,6 +2,7 @@
title: "Google Spreadsheets"
date: 2018-06-10T18:26:26-04:00
draft: false
+weight: 110
---
Added in `v0.0.7`.
@@ -12,14 +13,6 @@ Display information from cells in a Google Spreadsheet.
wtf/gspreadsheets/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/modules/ipaddress/_index.md b/_site/content/modules/ipaddress/_index.md
new file mode 100644
index 00000000..20034597
--- /dev/null
+++ b/_site/content/modules/ipaddress/_index.md
@@ -0,0 +1,9 @@
+---
+title: "IP Address"
+date: 2018-05-07T18:04:58-07:00
+draft: false
+weight: 120
+---
+
+For all modules IP address-related.
+
diff --git a/_site/content/posts/modules/ipapi.md b/_site/content/modules/ipaddress/ipapi.md
similarity index 94%
rename from _site/content/posts/modules/ipapi.md
rename to _site/content/modules/ipaddress/ipapi.md
index 986aa172..d1666d85 100644
--- a/_site/content/posts/modules/ipapi.md
+++ b/_site/content/modules/ipaddress/ipapi.md
@@ -2,6 +2,7 @@
title: "IP-API"
date: 2018-06-10T19:41:52-04:00
draft: false
+weight: 10
---
Added in `v0.0.7`.
@@ -17,14 +18,6 @@ minute.
wtf/ipapi/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/ipinfo.md b/_site/content/modules/ipaddress/ipinfo.md
similarity index 88%
rename from _site/content/posts/modules/ipinfo.md
rename to _site/content/modules/ipaddress/ipinfo.md
index 93b8edb2..1d32b022 100644
--- a/_site/content/posts/modules/ipinfo.md
+++ b/_site/content/modules/ipaddress/ipinfo.md
@@ -2,13 +2,15 @@
title: "IPInfo"
date: 2018-06-01T23:18:48-07:00
draft: false
+weight: 20
---
+
+
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
@@ -16,14 +18,6 @@ Displays your current IP address information, from ipinfo.io.
wtf/ipinfo/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/jenkins.md b/_site/content/modules/jenkins.md
similarity index 87%
rename from _site/content/posts/modules/jenkins.md
rename to _site/content/modules/jenkins.md
index d2577979..055fbd58 100644
--- a/_site/content/posts/modules/jenkins.md
+++ b/_site/content/modules/jenkins.md
@@ -1,26 +1,22 @@
---
-title: "Modules: Jenkins"
+title: "Jenkins"
date: 2018-06-09T20:53:35-07:00
draft: false
+weight: 130
---
+
+
Added in `v0.0.8`.
Displays jenkins status of given builds in a project or view
-
-
## Source Code
```bash
wtf/jenkins/
```
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/jira.md b/_site/content/modules/jira.md
similarity index 96%
rename from _site/content/posts/modules/jira.md
rename to _site/content/modules/jira.md
index 71a6f988..864d7bf6 100644
--- a/_site/content/posts/modules/jira.md
+++ b/_site/content/modules/jira.md
@@ -2,11 +2,12 @@
title: "Jira"
date: 2018-05-10T10:44:35-07:00
draft: false
+weight: 140
---
-Displays all Jira issues assigned to you for the specified project.
+
-
+Displays all Jira issues assigned to you for the specified project.
## Source Code
diff --git a/_site/content/posts/modules/logger.md b/_site/content/modules/logger.md
similarity index 88%
rename from _site/content/posts/modules/logger.md
rename to _site/content/modules/logger.md
index 23280a4b..68fecb78 100644
--- a/_site/content/posts/modules/logger.md
+++ b/_site/content/modules/logger.md
@@ -2,15 +2,16 @@
title: "Logger"
date: 2018-06-16T14:22:18-07:00
draft: false
+weight: 150
---
-Displays the contents of the WTF log file.
+Displays the contents of the WTF log file. The log file is located at `~/.config/wtf/log.txt`.
To log to this file in your own modules:
```golang
require "github.com/senorprogrammer/wtf/logger"
- logger.Log("This is a log entry")
+logger.Log("This is a log entry")
```
## Source Code
@@ -19,10 +20,6 @@ require "github.com/senorprogrammer/wtf/logger"
wtf/logger/
```
-## Required ENV Variables
-
-None.
-
## Keyboard Commands
Arrow keys scroll through the log file.
diff --git a/_site/content/posts/modules/newrelic.md b/_site/content/modules/newrelic.md
similarity index 91%
rename from _site/content/posts/modules/newrelic.md
rename to _site/content/modules/newrelic.md
index 9d2881d3..8295178d 100644
--- a/_site/content/posts/modules/newrelic.md
+++ b/_site/content/modules/newrelic.md
@@ -2,23 +2,20 @@
title: "New Relic"
date: 2018-05-09T09:01:14-07:00
draft: false
+weight: 160
---
+
+
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/
```
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/opsgenie.md b/_site/content/modules/opsgenie.md
similarity index 89%
rename from _site/content/posts/modules/opsgenie.md
rename to _site/content/modules/opsgenie.md
index ac18411b..d5d166fb 100644
--- a/_site/content/posts/modules/opsgenie.md
+++ b/_site/content/modules/opsgenie.md
@@ -2,23 +2,20 @@
title: "OpsGenie"
date: 2018-05-08T20:53:40-07:00
draft: false
+weight: 170
---
+
+
Connects to the OpsGenie API and displays all your scheduled rotations
and who's currently on call.
-
-
## Source Code
```bash
wtf/opsgenie/
```
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/power.md b/_site/content/modules/power.md
similarity index 84%
rename from _site/content/posts/modules/power.md
rename to _site/content/modules/power.md
index 7ecc728d..25d110b8 100644
--- a/_site/content/posts/modules/power.md
+++ b/_site/content/modules/power.md
@@ -2,28 +2,21 @@
title: "Power"
date: 2018-05-26T19:26:23-07:00
draft: false
+weight: 180
---
+
+
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/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/security.md b/_site/content/modules/security.md
similarity index 91%
rename from _site/content/posts/modules/security.md
rename to _site/content/modules/security.md
index c9800121..720c1ded 100644
--- a/_site/content/posts/modules/security.md
+++ b/_site/content/modules/security.md
@@ -2,13 +2,14 @@
title: "Security"
date: 2018-05-08T20:33:28-07:00
draft: false
+weight: 200
---
+
+
Displays some general information about the state of the machine's wifi
connection, firewall, DNS settings, and logged-in users.
-
-
#### Wifi Network
@@ -42,14 +43,6 @@ show hidden users.
wtf/security/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/textfile.md b/_site/content/modules/textfile.md
similarity index 89%
rename from _site/content/posts/modules/textfile.md
rename to _site/content/modules/textfile.md
index 9db3bd4d..47a0de6e 100644
--- a/_site/content/posts/modules/textfile.md
+++ b/_site/content/modules/textfile.md
@@ -2,11 +2,12 @@
title: "Textfile"
date: 2018-05-09T11:13:11-07:00
draft: false
+weight: 210
---
-Displays the contents of the specified text file in the widget.
+
-
+Displays the contents of the specified text file in the widget.
## Source Code
@@ -14,10 +15,6 @@ Displays the contents of the specified text file in the widget.
wtf/textfile/
```
-## Required ENV Variables
-
-None.
-
## Keyboard Commands
Key: `/`
diff --git a/_site/content/posts/modules/todo.md b/_site/content/modules/todo.md
similarity index 96%
rename from _site/content/posts/modules/todo.md
rename to _site/content/modules/todo.md
index b738b67d..81020b2a 100644
--- a/_site/content/posts/modules/todo.md
+++ b/_site/content/modules/todo.md
@@ -2,11 +2,12 @@
title: "Todo"
date: 2018-05-10T12:41:50-07:00
draft: false
+weight: 220
---
-An interactive todo list.
+
-
+An interactive todo list.
## Source Code
@@ -14,10 +15,6 @@ An interactive todo list.
wtf/todo/
```
-## Required ENV Variables
-
-None.
-
## Keyboard Commands
Key: `[return]`
diff --git a/_site/content/posts/modules/todoist.md b/_site/content/modules/todoist.md
similarity index 95%
rename from _site/content/posts/modules/todoist.md
rename to _site/content/modules/todoist.md
index 9326313d..7bac313b 100644
--- a/_site/content/posts/modules/todoist.md
+++ b/_site/content/modules/todoist.md
@@ -2,14 +2,15 @@
title: "Todoist"
date: 2018-07-05T22:55:55-03:00
draft: false
+weight: 230
---
+
+
Added in `v0.0.11`.
Displays all items on specified project.
-
-
## Source Code
```bash
diff --git a/_site/content/posts/modules/travisci.md b/_site/content/modules/travisci.md
similarity index 93%
rename from _site/content/posts/modules/travisci.md
rename to _site/content/modules/travisci.md
index 437a4d79..5ad75f13 100644
--- a/_site/content/posts/modules/travisci.md
+++ b/_site/content/modules/travisci.md
@@ -2,14 +2,15 @@
title: "TravisCI"
date: 2018-07-18T14:36:08-04:00
draft: false
+weight: 240
---
+
+
Added in `v0.0.12`.
Displays build information for your Travis CI account.
-
-
## Source Code
```bash
@@ -63,10 +64,10 @@ Values: `true`, `false`.
`position`
Defines where in the grid this module's widget will be displayed.
-`refreshInterval`
-How often, in seconds, this module will update its data.
-Values: A positive integer, `0..n`.
-
`pro`
Determines whether or not this module will use the Pro version of Travis CI.
Values: `true`, `false`.
+
+`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`.
diff --git a/_site/content/posts/modules/trello.md b/_site/content/modules/trello.md
similarity index 92%
rename from _site/content/posts/modules/trello.md
rename to _site/content/modules/trello.md
index 88ec787d..0a4ade6d 100644
--- a/_site/content/posts/modules/trello.md
+++ b/_site/content/modules/trello.md
@@ -2,11 +2,12 @@
title: "Trello"
date: 2018-05-10T10:44:35-07:00
draft: false
+weight: 250
---
-Displays all Trello cards on specified lists.
+
-
+Displays all Trello cards on specified lists.
## Source Code
@@ -14,10 +15,6 @@ Displays all Trello cards on specified lists.
wtf/trello/
```
-## Keyboard Commands
-
-None.
-
## Configuration
### Single Trello List
diff --git a/_site/content/posts/modules/twitter.md b/_site/content/modules/twitter.md
similarity index 96%
rename from _site/content/posts/modules/twitter.md
rename to _site/content/modules/twitter.md
index 883f3f54..f28af0d2 100644
--- a/_site/content/posts/modules/twitter.md
+++ b/_site/content/modules/twitter.md
@@ -2,9 +2,10 @@
title: "Twitter"
date: 2018-07-31T20:21:37-07:00
draft: false
+weight: 260
---
-Added in `v0.1.2`.
+Added in `v0.2.0`.
Connects to the Twitter API and displays a single user's tweets.
diff --git a/_site/content/modules/weather_services/_index.md b/_site/content/modules/weather_services/_index.md
new file mode 100644
index 00000000..1c17db66
--- /dev/null
+++ b/_site/content/modules/weather_services/_index.md
@@ -0,0 +1,8 @@
+---
+title: "Weather Services"
+date: 2018-05-07T18:04:58-07:00
+draft: false
+weight: 270
+---
+
+For all modules weather-related.
diff --git a/_site/content/posts/modules/prettyweather.md b/_site/content/modules/weather_services/prettyweather.md
similarity index 89%
rename from _site/content/posts/modules/prettyweather.md
rename to _site/content/modules/weather_services/prettyweather.md
index 24c0c4ca..8a9f9d3f 100644
--- a/_site/content/posts/modules/prettyweather.md
+++ b/_site/content/modules/weather_services/prettyweather.md
@@ -2,12 +2,14 @@
title: "Pretty Weather"
date: 2018-06-02T05:32:04-07:00
draft: false
+weight: 10
---
+
+
Displays weather information as ASCII art from
[Wttr.in](http://wttr.in).
-
## Source Code
@@ -15,14 +17,6 @@ Displays weather information as ASCII art from
wtf/prettyweather/
```
-## Required ENV Variables
-
-None.
-
-## Keyboard Commands
-
-None.
-
## Configuration
```yaml
diff --git a/_site/content/posts/modules/weather.md b/_site/content/modules/weather_services/weather.md
similarity index 86%
rename from _site/content/posts/modules/weather.md
rename to _site/content/modules/weather_services/weather.md
index a6fff7de..d38ca9f3 100644
--- a/_site/content/posts/modules/weather.md
+++ b/_site/content/modules/weather_services/weather.md
@@ -2,12 +2,14 @@
title: "Weather"
date: 2018-05-09T11:44:13-07:00
draft: false
+weight: 20
---
+
+
Displays a configurable list of current weather report, including
current temperature, sunrise time, and sunset time.
-
## Source Code
@@ -15,14 +17,6 @@ current temperature, sunrise time, and sunset time.
wtf/weather/
```
-## Required ENV Variables
-
-
-
-Key: `WTF_OWM_API_KEY`
-Action: Your OpenWeatherMap API key.
-Note: DEPRECATED. See the `apiKey` config value, below.
-
## Keyboard Commands
Key: `/`
diff --git a/_site/content/posts/modules/zendesk.md b/_site/content/modules/zendesk.md
similarity index 99%
rename from _site/content/posts/modules/zendesk.md
rename to _site/content/modules/zendesk.md
index b7e9ea16..2b330a5c 100644
--- a/_site/content/posts/modules/zendesk.md
+++ b/_site/content/modules/zendesk.md
@@ -2,6 +2,7 @@
title: "Zendesk"
date: 2018-07-23T18:55:37-08:00
draft: false
+weight: 280
---
Added in `v0.1.0`.
diff --git a/_site/static/imgs/modules/gitlab.png b/_site/static/imgs/modules/gitlab.png
index 6e806a41..e72042d6 100644
Binary files a/_site/static/imgs/modules/gitlab.png and b/_site/static/imgs/modules/gitlab.png differ
diff --git a/_site/static/imgs/modules/travisci.png b/_site/static/imgs/modules/travisci.png
index eb423fa9..45b037cd 100644
Binary files a/_site/static/imgs/modules/travisci.png and b/_site/static/imgs/modules/travisci.png differ
diff --git a/_site/static/imgs/modules/trello.png b/_site/static/imgs/modules/trello.png
index 79fa6965..4a440dd8 100644
Binary files a/_site/static/imgs/modules/trello.png and b/_site/static/imgs/modules/trello.png differ
diff --git a/_site/themes/docdock/LICENSE.md b/_site/themes/docdock/LICENSE.md
new file mode 100644
index 00000000..0cf9fcb4
--- /dev/null
+++ b/_site/themes/docdock/LICENSE.md
@@ -0,0 +1,22 @@
+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.
diff --git a/_site/themes/docdock/README.md b/_site/themes/docdock/README.md
new file mode 100644
index 00000000..6c9aa1a6
--- /dev/null
+++ b/_site/themes/docdock/README.md
@@ -0,0 +1,129 @@
+# 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 = ""
+```
+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)
diff --git a/_site/themes/docdock/_prose.yml b/_site/themes/docdock/_prose.yml
new file mode 100644
index 00000000..1dcbb977
--- /dev/null
+++ b/_site/themes/docdock/_prose.yml
@@ -0,0 +1,4 @@
+prose:
+ rooturl: 'exampleSite/content'
+ siteurl: 'https://docdock.netlify.com/'
+ media: 'exampleSite/static'
diff --git a/_site/themes/docdock/archetypes/default.md b/_site/themes/docdock/archetypes/default.md
new file mode 100644
index 00000000..dd9d7941
--- /dev/null
+++ b/_site/themes/docdock/archetypes/default.md
@@ -0,0 +1,9 @@
++++
+title= "{{ replace .TranslationBaseName "-" " " | title }}"
+date= {{ .Date }}
+description = ""
+draft= true
++++
+
+Lorem Ipsum.
+Notice `draft` is set to true.
diff --git a/_site/themes/docdock/archetypes/slide.md b/_site/themes/docdock/archetypes/slide.md
new file mode 100644
index 00000000..e40a913d
--- /dev/null
+++ b/_site/themes/docdock/archetypes/slide.md
@@ -0,0 +1,46 @@
++++
+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
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/config.toml b/_site/themes/docdock/exampleSite/config.toml
new file mode 100644
index 00000000..91783d29
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/config.toml
@@ -0,0 +1,68 @@
+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 = "
More
"
+name = " "
+identifier = "ds"
+url = "https://github.com/vjeantet/hugo-theme-docdock"
+weight = 10
+
+[[menu.shortcuts]]
+name = " "
+url = "https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip"
+weight = 11
+
+[[menu.shortcuts]]
+name = " "
+identifier = "hugodoc"
+url = "https://gohugo.io/"
+weight = 20
+
+[[menu.shortcuts]]
+name = " "
+url = "/credits"
+weight = 30
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/_index.md b/_site/themes/docdock/exampleSite/content/_index.md
new file mode 100644
index 00000000..aa299129
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/_index.md
@@ -0,0 +1,50 @@
++++
+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 %}}
+
diff --git a/_site/themes/docdock/exampleSite/content/content-organisation/_index.md b/_site/themes/docdock/exampleSite/content/content-organisation/_index.md
new file mode 100644
index 00000000..df428154
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/content-organisation/_index.md
@@ -0,0 +1,138 @@
++++
+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 =" "
+ +++
+
+
+
+### 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 =" "
+ +++
+
+
+
+
+
+
+### 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"%}})
+
+
+
diff --git a/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/_index.md b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/_index.md
new file mode 100644
index 00000000..fe604ae8
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/_index.md
@@ -0,0 +1,66 @@
++++
+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 \ 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
+
+
+```
+
+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
diff --git a/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/disable.md b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/disable.md
new file mode 100644
index 00000000..4d53173a
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/disable.md
@@ -0,0 +1,24 @@
++++
+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
+```
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/theme-variants.md b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/theme-variants.md
new file mode 100644
index 00000000..23e76199
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/theme-variants.md
@@ -0,0 +1,35 @@
++++
+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"`
+```
+
+
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/themestyle.md b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/themestyle.md
new file mode 100644
index 00000000..2dc1f746
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/content-organisation/customize-style/themestyle.md
@@ -0,0 +1,25 @@
++++
+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"
+```
+
+
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/content-organisation/extramenu.md b/_site/themes/docdock/exampleSite/content/content-organisation/extramenu.md
new file mode 100644
index 00000000..0dd06987
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/content-organisation/extramenu.md
@@ -0,0 +1,28 @@
++++
+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 = "
More
"
+ name = " Github repo"
+ identifier = "ds"
+ url = "https://github.com/vjeantet/hugo-theme-docdock"
+ weight = 1
+
+ [[menu.shortcuts]]
+ name = " 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/)
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/content-organisation/logo.md b/_site/themes/docdock/exampleSite/content/content-organisation/logo.md
new file mode 100644
index 00000000..aeb18c6b
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/content-organisation/logo.md
@@ -0,0 +1,12 @@
++++
+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%}}
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/create-page/_index.md b/_site/themes/docdock/exampleSite/content/create-page/_index.md
new file mode 100644
index 00000000..8ffe4bec
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/create-page/_index.md
@@ -0,0 +1,54 @@
++++
+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 =" "
+
++++
+
+
+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"%}})
diff --git a/_site/themes/docdock/exampleSite/content/create-page/homepage.md b/_site/themes/docdock/exampleSite/content/create-page/homepage.md
new file mode 100644
index 00000000..ed0b5bc0
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/create-page/homepage.md
@@ -0,0 +1,8 @@
++++
+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.
diff --git a/_site/themes/docdock/exampleSite/content/create-page/myslide.md b/_site/themes/docdock/exampleSite/content/create-page/myslide.md
new file mode 100644
index 00000000..1f611bc6
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/create-page/myslide.md
@@ -0,0 +1,48 @@
++++
+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
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/create-page/page-images.md b/_site/themes/docdock/exampleSite/content/create-page/page-images.md
new file mode 100644
index 00000000..a395844b
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/create-page/page-images.md
@@ -0,0 +1,28 @@
++++
+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.
+
+ 
+
+
diff --git a/_site/themes/docdock/exampleSite/content/create-page/page-slide.md b/_site/themes/docdock/exampleSite/content/create-page/page-slide.md
new file mode 100644
index 00000000..5c3c351e
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/create-page/page-slide.md
@@ -0,0 +1,114 @@
++++
+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"%}})
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/credits.md b/_site/themes/docdock/exampleSite/content/credits.md
new file mode 100644
index 00000000..8d382596
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/credits.md
@@ -0,0 +1,44 @@
++++
+title = "Credits"
+description = "contributors and packages used by hugo-theme-docdock"
++++
+
+
+## github contributors
+{{%ghcontributors "https://api.github.com/repos/vjeantet/hugo-theme-docdock/contributors?per_page=100" %}}
+
+### Other contribution
+
+
+
+
+
+supports and advices
+
+
+
+
+
+Flex style based on facette documentation theme, Thanks to @vbatoufflet
+
+
+
+
+
+
+## Packages and libraries
+* [Bootstrap](http://getbootstrap.com) - front-end framework
+* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
+* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework
+* [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library
+* [lunr](https://lunrjs.com) - Lunr enables you to provide a great search experience without the need for external, server-side, search services...
+* [JavaScript-autoComplete](https://github.com/Pixabay/JavaScript-autoComplete) - An extremely lightweight and powerful vanilla JavaScript completion suggester.
+* [clipboard.js](https://zenorocha.github.io/clipboard.js) - copy text to clipboard
+* [highlight.js](https://highlightjs.org) - Javascript syntax highlighter
+* [modernizr](https://modernizr.com) - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don't support
+* [reveal-js](http://lab.hakim.se/reveal-js) - The HTML Presentation Framework
+
+## Tooling
+
+* [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation
+* [Hugo](https://gohugo.io/) {{%icon "fa-smile-o"%}}
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/getting-start/_index.md b/_site/themes/docdock/exampleSite/content/getting-start/_index.md
new file mode 100644
index 00000000..cdfdca31
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/getting-start/_index.md
@@ -0,0 +1,12 @@
++++
+title = "Getting started"
+description = ""
+weight = 1
+alwaysopen = true
++++
+
+## Requirements
+
+Download [Hugo binary](https://gohugo.io/overview/installing/) for your OS (Windows, Linux, Mac) : it’s that simple
+
+{{%children style="h2" description="true"%}}
diff --git a/_site/themes/docdock/exampleSite/content/getting-start/configuration.md b/_site/themes/docdock/exampleSite/content/getting-start/configuration.md
new file mode 100644
index 00000000..0943c8db
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/getting-start/configuration.md
@@ -0,0 +1,56 @@
++++
+title = "Configuration"
+description = ""
+weight = 2
++++
+
+When building the website, you can set a theme by using `--theme` option. We suggest you to edit your configuration file and set the theme by default. Example with `config.toml` format.
+
+
+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 = ""
+```
+Comment out following line, so default `themes/` will be used:
+
+```
+# themesdir = "../.."
+```
+
+
+{{%excerpt%}}
+## Activate search
+
+If not already present, add the follow lines to the `config.toml` file.
+
+```toml
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+```
+{{% /excerpt%}}
+
+
+LUNRJS search index file will be generated on content changes.
+
+#### (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
+
+## Your website's content
+
+Find out how to [create]({{%relref "create-page/_index.md"%}}) and [organize your content]({{%relref "content-organisation/_index.md"%}}) quickly and intuitively.
diff --git a/_site/themes/docdock/exampleSite/content/getting-start/installation.md b/_site/themes/docdock/exampleSite/content/getting-start/installation.md
new file mode 100644
index 00000000..53765fb5
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/getting-start/installation.md
@@ -0,0 +1,83 @@
++++
+title = "Installation"
+description = ""
+weight = 1
++++
+
+{{% alert theme="warning" %}}HUGO **v0.32** minimum required to use this theme{{%/alert%}}
+
+The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
+
+
+## Installation
+
+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.
+
+Before 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. [{{%icon download%}} download following zip](https://github.com/vjeantet/hugo-theme-docdock/archive/master.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.
+
+## Configuration
+
+[Follow instructions here]({{%relref "configuration.md"%}})
diff --git a/_site/themes/docdock/exampleSite/content/search/_index.md b/_site/themes/docdock/exampleSite/content/search/_index.md
new file mode 100644
index 00000000..f9a61b73
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/search/_index.md
@@ -0,0 +1,13 @@
++++
+title = "About the Search Engine"
+description = ""
+weight = 40
++++
+
+{{%excerpt-include filename="getting-start/configuration.md" /%}}
+
+
+Docdock theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
+
+
+{{%note%}}hugo generate lunrjs index.json at the root of `public` folder if the site only has one language or within each language subfolder. When you build the site with `hugo server`, hugo generates it internally and of course it don't show up in the filesystem{{%/note%}}
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/_index.md b/_site/themes/docdock/exampleSite/content/shortcodes/_index.md
new file mode 100644
index 00000000..2bbfa337
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/shortcodes/_index.md
@@ -0,0 +1,10 @@
++++
+title = "Shortcodes"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 30
++++
+
+A bunch of Shortcodes are available with this theme :
+
+{{%children style="card" description="true" %}}
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/alert.md b/_site/themes/docdock/exampleSite/content/shortcodes/alert.md
new file mode 100644
index 00000000..d69e3ddf
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/shortcodes/alert.md
@@ -0,0 +1,30 @@
++++
+title = "alert"
+description = "The alert shortcode allows you to highlight information in your page."
++++
+
+The `alert` shortcode allow you to highlight information in your page. They create a colored box surrounding your text, like this:
+
+{{%alert%}}**This is** an alert !{{%/alert%}}
+## Usage
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| theme | `info` | `success`, `info`,`warning`,`danger` |
+
+{{%alert info%}}
+**Tips :** setting only the theme as argument works too :
+`{{%/*alert warning*/%}}` instead of `{{%/*alert theme="warning"*/%}}`
+{{%/alert%}}
+
+## Basic examples
+
+ {{%/* alert theme="info" */%}}**this** is a text{{%/* /alert */%}}
+ {{%/* alert theme="success" */%}}**Yeahhh !** is a text{{%/* /alert */%}}
+ {{%/* alert theme="warning" */%}}**Be carefull** is a text{{%/* /alert */%}}
+ {{%/* alert theme="danger" */%}}**Beware !** is a text{{%/* /alert */%}}
+
+{{% alert theme="info"%}}**this** is an info{{% /alert %}}
+{{% alert theme="success" %}}**Yeahhh !** is an success{{% /alert %}}
+{{% alert theme="warning" %}}**Be carefull** is a warning{{% /alert %}}
+{{% alert theme="danger" %}}**Beware !** is a danger{{% /alert %}}
\ No newline at end of file
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/BachGavotteShort.mp3 b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/BachGavotteShort.mp3
new file mode 100644
index 00000000..94e3d0e5
Binary files /dev/null and b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/BachGavotteShort.mp3 differ
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/Carroll_AliceAuPaysDesMerveilles.pdf b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/Carroll_AliceAuPaysDesMerveilles.pdf
new file mode 100644
index 00000000..97377e99
Binary files /dev/null and b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/Carroll_AliceAuPaysDesMerveilles.pdf differ
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/adivorciarsetoca00cape.pdf b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/adivorciarsetoca00cape.pdf
new file mode 100644
index 00000000..e589c73e
Binary files /dev/null and b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/adivorciarsetoca00cape.pdf differ
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/hugo.png b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/hugo.png
new file mode 100644
index 00000000..48acf346
Binary files /dev/null and b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/hugo.png differ
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/movieselectricsheep-flock-244-32500-2.mp4 b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/movieselectricsheep-flock-244-32500-2.mp4
new file mode 100644
index 00000000..9f1fe564
Binary files /dev/null and b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.files/movieselectricsheep-flock-244-32500-2.mp4 differ
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/attachments.md b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.md
new file mode 100644
index 00000000..c684bb4e
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/shortcodes/attachments.md
@@ -0,0 +1,59 @@
++++
+title = "attachments"
+description = "The Attachments shortcode displays a list of files attached to a page."
++++
+
+The Attachments shortcode displays a list of files attached to a page.
+Example :
+{{%alert success%}}{{%attachments /%}}{{%/alert%}}
+
+## Usage
+
+The shortcurt lists files found in a **specific folder**.
+Currently, it support two implementations for pages
+
+1. If your page is a markdown file, attachements must be place in a **folder** named like your page and ending with **.files**.
+
+ > * content
+ > * _index.md
+ > * page.files
+ > * attachment.pdf
+ > * page.md
+
+2. If your page is a **folder**, attachements must be place in a nested **'files'** folder.
+
+ > * content
+ > * _index.md
+ > * page
+ > * index.md
+ > * files
+ > * attachment.pdf
+
+That's all !
+
+{{%alert info%}}**Tip** : Look at this documentation source code on github{{%/alert%}}
+
+### parameters
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| title | "Attachments" | List's title |
+| pattern | ".*" | A regular expressions, used to filter the attachments by file name.
{{%alert warning%}}The **pattern** parameter value must be [regular expressions](https://en.wikipedia.org/wiki/Regular_expression).
+
+For example:
+
+* To match a file suffix of 'jpg', use **.*jpg** (not *.jpg).
+* To match file names ending in 'jpg' or 'png', use **.*(jpg|png)**
+
+{{%/alert%}}|
+
+
+## Demo
+### List of attachments ending in pdf or mp4
+
+ {{%/*attachments title="Related files" pattern=".*(pdf|mp4)"/*/%}}
+
+renders as
+
+{{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
+
diff --git a/_site/themes/docdock/exampleSite/content/shortcodes/button.md b/_site/themes/docdock/exampleSite/content/shortcodes/button.md
new file mode 100644
index 00000000..59d498ff
--- /dev/null
+++ b/_site/themes/docdock/exampleSite/content/shortcodes/button.md
@@ -0,0 +1,37 @@
++++
+title = "button"
+description = "Display an actionable button in your page."
++++
+
+Display an actionable button in your page.
+
+{{
+
Added in `v0.0.7`.
Displays build information for your CircleCI account.
-
+
Displays a configurable list of world clocks, the local time, and date.
-
+
Added in `v0.0.5`.
Get the last 24 hour summary of cryptocurrencies market using [Bittrex](https://bittrex.com).
-
+
Added in `v0.0.8`.
Display your Blockfolio crypto holdings.
-
+
Added in `v0.0.5`.
Compare crypto currencies using [CryptoCompare](https://cryptocompare.com).
-
-
+
Displays information about your projects hosted on Gerrit:
#### Open Incoming Reviews
@@ -14,8 +17,6 @@ All open reviews that are requesting your approval.
All open reviews created by you.
-
+
Displays information about local git repositories: branch, changed
files, and recent commits.
-
+Displays information about your git repositories hosted on GitHub:
#### Open Review Requests
@@ -15,8 +17,6 @@ All open code review requests assigned to you.
All open pull requests created by you.
-
-
+
Displays your current IP address information, from ipinfo.io.
**Note:** IPInfo.io has a free-plan rate limit of 1000 requests per day.
-
+
Added in `v0.0.8`.
Displays jenkins status of given builds in a project or view
-
-
+
Connects to the New Relic API and displays the last n deploys of the
monitored application: deploy ID, deploy time, and who deployed it.
-
+
Connects to the OpsGenie API and displays all your scheduled rotations
and who's currently on call.
-
+
Displays information about the current power source.
For battery, also displays the current charge, estimated time remaining,
and whether it is charging or discharging.
-
+
Displays some general information about the state of the machine's wifi
connection, firewall, DNS settings, and logged-in users.
-
-
-
+
Added in `v0.0.11`.
Displays all items on specified project.
-
+
Added in `v0.0.12`.
Displays build information for your Travis CI account.
-
-
+
Displays weather information as ASCII art from
[Wttr.in](http://wttr.in).
-
+
Displays a configurable list of current weather report, including
current temperature, sunrise time, and sunset time.
-
+
+supports and advices
+
+
+Flex style based on facette documentation theme,