mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
First pass at new site template
This commit is contained in:
Chris Cummer
Chris Cummer
parent
215c7e571f
commit
d872a28cf7
1
Makefile
1
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
|
||||
|
||||
|
||||
@ -12,7 +12,6 @@ defaultContentLanguage = "en"
|
||||
defaultContentLanguageInSubdir= false
|
||||
enableMissingTranslationPlaceholders = false
|
||||
|
||||
|
||||
# [Languages]
|
||||
# [Languages.en]
|
||||
# title = "Documentation for WTF"
|
||||
|
||||
0
_site/content/_footer.md
Normal file
0
_site/content/_footer.md
Normal file
@ -2,6 +2,7 @@
|
||||
title: "Configuration"
|
||||
date: 2018-04-15T21:17:16-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
## Index
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: "Configuration: Attributes"
|
||||
title: "Attributes"
|
||||
date: 2018-05-16T21:51:23-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
The following top-level attributes are configurable in `config.yml`.
|
||||
@ -12,7 +13,7 @@ wtf:
|
||||
colors:
|
||||
background: "red"
|
||||
border:
|
||||
Focusable: "darkslateblue"
|
||||
focusable: "darkslateblue"
|
||||
focused: "orange"
|
||||
normal: "gray"
|
||||
grid:
|
||||
@ -23,9 +24,8 @@ wtf:
|
||||
# How _high_ the rows are, in terminal lines. In this case we have five rows
|
||||
# that support ten line of text, one of three lines, and one of four
|
||||
rows: [10, 10, 10, 10, 10, 3, 4]
|
||||
# The app redraws itself once a second
|
||||
openFileUtil: open
|
||||
refreshInterval: 1
|
||||
openFileUtil: open # the name of the utility to call to open files
|
||||
refreshInterval: 1 # the app refreshes once per second
|
||||
term: "xterm-256color"
|
||||
```
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: "Configuration: iTerm2"
|
||||
title: "iTerm2"
|
||||
date: 2018-05-24T09:57:40-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Many terminal apps don't properly display multibyte emoji characters
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: "Overview"
|
||||
title: "Getting Started"
|
||||
date: 2018-05-21T16:11:58-07:00
|
||||
draft: false
|
||||
weight: 1
|
||||
---
|
||||
|
||||
<span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your terminal, developed for those who spend most of their day in the command line.
|
||||
@ -4,20 +4,6 @@ date: 2018-05-18T09:59:40-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
There are two ways to install WTF:
|
||||
|
||||
## From Source
|
||||
|
||||
Get this repo and install the dependencies:
|
||||
|
||||
```bash
|
||||
go get -u github.com/senorprogrammer/wtf
|
||||
cd $GOPATH/src/github.com/senorprogrammer/wtf
|
||||
make install
|
||||
make run
|
||||
```
|
||||
and that should probably do it.
|
||||
|
||||
## As a Binary
|
||||
|
||||
Grab the latest version from here:
|
||||
@ -33,3 +19,16 @@ expand it, and `cd` into the resulting directory. Then run:
|
||||
```
|
||||
|
||||
and that should also do it.
|
||||
|
||||
## From Source
|
||||
|
||||
Download the source code repo and install the dependencies:
|
||||
|
||||
```bash
|
||||
go get -u github.com/senorprogrammer/wtf
|
||||
cd $GOPATH/src/github.com/senorprogrammer/wtf
|
||||
go install -ldflags="-s -w"
|
||||
make run
|
||||
```
|
||||
and that should do it.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: "Modules"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
The heart of WTF is the modules. A module is a discreet unit of
|
||||
@ -2,6 +2,7 @@
|
||||
title: "BambooHR"
|
||||
date: 2018-05-07T20:17:37-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Connects to the BambooHR API and displays who will be Away today.
|
||||
@ -12,10 +13,6 @@ Connects to the BambooHR API and displays who will be Away today.
|
||||
wtf/bamboohr/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,13 +2,15 @@
|
||||
title: "CircleCI"
|
||||
date: 2018-06-10T19:26:08-04:00
|
||||
draft: false
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<img src="/imgs/modules/circleci.png" class="screenshot" width="609" height="150" alt="circleci screenshot" />
|
||||
|
||||
Added in `v0.0.7`.
|
||||
|
||||
Displays build information for your CircleCI account.
|
||||
|
||||
<img src="/imgs/modules/circleci.png" width="609" height="150" alt="circleci screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -16,10 +18,6 @@ Displays build information for your CircleCI account.
|
||||
wtf/circleci/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,11 +2,13 @@
|
||||
title: "Clocks"
|
||||
date: 2018-05-07T19:47:31-07:00
|
||||
draft: false
|
||||
weight: 30
|
||||
---
|
||||
|
||||
<img src="/imgs/modules/clocks.png" class="screenshot" width="320" height="191" alt="clocks screenshot" />
|
||||
|
||||
Displays a configurable list of world clocks, the local time, and date.
|
||||
|
||||
<img src="/imgs/modules/clocks.png" width="320" height="191" alt="clocks screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -14,14 +16,6 @@ Displays a configurable list of world clocks, the local time, and date.
|
||||
wtf/clocks/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,6 +2,7 @@
|
||||
title: "CmdRunner"
|
||||
date: 2018-05-17T17:17:10-07:00
|
||||
draft: false
|
||||
weight: 40
|
||||
---
|
||||
|
||||
Runs a terminal command on a schedule.
|
||||
@ -12,14 +13,6 @@ Runs a terminal command on a schedule.
|
||||
wtf/cmdrunner/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
8
_site/content/modules/cryptocurrencies/_index.md
Normal file
8
_site/content/modules/cryptocurrencies/_index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Crypo Currencies"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 50
|
||||
---
|
||||
|
||||
For all modules cryptocurrency-related.
|
||||
@ -2,28 +2,21 @@
|
||||
title: "Bittrex"
|
||||
date: 2018-06-04T20:06:40-07:00
|
||||
draft: false
|
||||
weight: 5
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/bittrex.png" width="320" height="412" alt="bittrex screenshot" />
|
||||
|
||||
Added in `v0.0.5`.
|
||||
|
||||
Get the last 24 hour summary of cryptocurrencies market using [Bittrex](https://bittrex.com).
|
||||
|
||||
<img src="/imgs/modules/bittrex.png" width="320" height="412" alt="bittrex screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/cryptoexchanges/bittrex/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,13 +2,15 @@
|
||||
title: "Blockfolio"
|
||||
date: 2018-06-13T09:29:59-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/blockfolio.png" width="320" height="185" alt="blockfolio screenshot" />
|
||||
|
||||
Added in `v0.0.8`.
|
||||
|
||||
Display your Blockfolio crypto holdings.
|
||||
|
||||
<img src="/imgs/modules/blockfolio.png" width="320" height="185" alt="blockfolio screenshot" />
|
||||
|
||||
## Source
|
||||
|
||||
@ -16,14 +18,6 @@ Display your Blockfolio crypto holdings.
|
||||
wtf/blockfolio/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,13 +2,15 @@
|
||||
title: "CryptoLive"
|
||||
date: 2018-06-03T20:06:40-07:00
|
||||
draft: false
|
||||
weight: 15
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/cryptolive.png" width="320" height="203" alt="cryptolive screenshot" />
|
||||
|
||||
Added in `v0.0.5`.
|
||||
|
||||
Compare crypto currencies using [CryptoCompare](https://cryptocompare.com).
|
||||
|
||||
<img src="/imgs/modules/cryptolive.png" width="320" height="203" alt="cryptolive screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -16,14 +18,6 @@ Compare crypto currencies using [CryptoCompare](https://cryptocompare.com).
|
||||
wtf/cryptoexchanges/cryptolive/
|
||||
```
|
||||
|
||||
## Required ENV Vars
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -33,12 +27,12 @@ cryptolive:
|
||||
top: 5
|
||||
left: 2
|
||||
height: 1
|
||||
width: 2
|
||||
width: 2
|
||||
updateInterval: 15
|
||||
currencies:
|
||||
currencies:
|
||||
BTC:
|
||||
displayName: Bitcoin
|
||||
to:
|
||||
to:
|
||||
- USD
|
||||
- EUR
|
||||
- ETH
|
||||
@ -46,7 +40,7 @@ cryptolive:
|
||||
- DOGE
|
||||
LTC:
|
||||
displayName: Ethereum
|
||||
to:
|
||||
to:
|
||||
- USD
|
||||
- EUR
|
||||
- BTC
|
||||
@ -56,7 +50,7 @@ cryptolive:
|
||||
limit: 5
|
||||
to:
|
||||
- USD
|
||||
colors:
|
||||
colors:
|
||||
from:
|
||||
name: coral
|
||||
displayName: grey
|
||||
@ -2,11 +2,12 @@
|
||||
title: "Google Calendar"
|
||||
date: 2018-05-10T08:25:33-07:00
|
||||
draft: false
|
||||
weight: 60
|
||||
---
|
||||
|
||||
Displays your upcoming Google calendar events.
|
||||
<img class="screenshot" src="/imgs/modules/gcal.png" width="320" height="389" alt="gcal screenshot" />
|
||||
|
||||
<img src="/imgs/modules/gcal.png" width="320" height="389" alt="gcal screenshot" />
|
||||
Displays your upcoming Google calendar events.
|
||||
|
||||
**Not:** Setting up access to Google Calendars for Go is a bit unobvious. Check out Google's [Go Quickstart](https://developers.google.com/calendar/quickstart/go)
|
||||
first and if you have problems, then take a look at this [comment by WesleydeSouza](https://github.com/senorprogrammer/wtf/issues/83#issuecomment-393665229) which offers a slightly different approach.
|
||||
@ -17,14 +18,6 @@ first and if you have problems, then take a look at this [comment by WesleydeSou
|
||||
wtf/gcal/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,8 +2,11 @@
|
||||
title: "Gerrit"
|
||||
date: 2018-06-27T15:55:42-07:00
|
||||
draft: false
|
||||
weight: 70
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/gerrit.png" width="640" height="167" alt="gerrit screenshot" />
|
||||
|
||||
Displays information about your projects hosted on Gerrit:
|
||||
|
||||
#### Open Incoming Reviews
|
||||
@ -14,8 +17,6 @@ All open reviews that are requesting your approval.
|
||||
|
||||
All open reviews created by you.
|
||||
|
||||
<img src="/imgs/modules/gerrit.png" width="640" height="167" alt="gerrit screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@ -2,13 +2,14 @@
|
||||
title: "Git"
|
||||
date: 2018-05-09T14:20:48-07:00
|
||||
draft: false
|
||||
weight: 80
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/git.png" width="720" height="292" alt="git screenshot" />
|
||||
|
||||
Displays information about local git repositories: branch, changed
|
||||
files, and recent commits.
|
||||
|
||||
<img src="/imgs/modules/git.png" width="720" height="292" alt="git screenshot" />
|
||||
|
||||
#### Branch
|
||||
|
||||
The name of the currently-active git branch.
|
||||
@ -28,10 +29,6 @@ A list of `n` recent commits, who committed it, and when.
|
||||
wtf/git/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
@ -2,10 +2,12 @@
|
||||
title: "GitHub"
|
||||
date: 2018-05-09T19:20:20-07:00
|
||||
draft: false
|
||||
weight: 90
|
||||
---
|
||||
|
||||
Displays information about your git repositories hosted on GitHub:
|
||||
<img class="screenshot" src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
||||
|
||||
Displays information about your git repositories hosted on GitHub:
|
||||
|
||||
#### Open Review Requests
|
||||
|
||||
@ -15,8 +17,6 @@ All open code review requests assigned to you.
|
||||
|
||||
All open pull requests created by you.
|
||||
|
||||
<img src="/imgs/modules/github.png" width="640" height="384" alt="github screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@ -2,11 +2,12 @@
|
||||
title: "GitLab"
|
||||
date: 2018-06-08T13:14:11-07:00
|
||||
draft: false
|
||||
weight: 100
|
||||
---
|
||||
|
||||
Added in `v0.0.8`.
|
||||
<img class="screenshot" src="/imgs/modules/gitlab.png" width="640" height="390" alt="gitlab screenshot" />
|
||||
|
||||
<img src="/imgs/modules/gitlab.png" width="640" height="384" alt="gitlab screenshot" />
|
||||
Added in `v0.0.8`.
|
||||
|
||||
Displays information about your projects hosted on GitLab:
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: "Google Spreadsheets"
|
||||
date: 2018-06-10T18:26:26-04:00
|
||||
draft: false
|
||||
weight: 110
|
||||
---
|
||||
|
||||
Added in `v0.0.7`.
|
||||
@ -12,14 +13,6 @@ Display information from cells in a Google Spreadsheet.
|
||||
wtf/gspreadsheets/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
9
_site/content/modules/ipaddress/_index.md
Normal file
9
_site/content/modules/ipaddress/_index.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: "IP Address"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 120
|
||||
---
|
||||
|
||||
For all modules IP address-related.
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
title: "IP-API"
|
||||
date: 2018-06-10T19:41:52-04:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Added in `v0.0.7`.
|
||||
@ -17,14 +18,6 @@ minute.
|
||||
wtf/ipapi/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,13 +2,15 @@
|
||||
title: "IPInfo"
|
||||
date: 2018-06-01T23:18:48-07:00
|
||||
draft: false
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/ipinfo.png" width="320" height="199" alt="ipinfo screenshot" />
|
||||
|
||||
Displays your current IP address information, from ipinfo.io.
|
||||
|
||||
**Note:** IPInfo.io has a free-plan rate limit of 1000 requests per day.
|
||||
|
||||
<img src="/imgs/modules/ipinfo.png" width="320" height="199" alt="ipinfo screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -16,14 +18,6 @@ Displays your current IP address information, from ipinfo.io.
|
||||
wtf/ipinfo/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -1,26 +1,22 @@
|
||||
---
|
||||
title: "Modules: Jenkins"
|
||||
title: "Jenkins"
|
||||
date: 2018-06-09T20:53:35-07:00
|
||||
draft: false
|
||||
weight: 130
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/jenkins.png" alt="jenkins screenshot" width="320" height="68" />
|
||||
|
||||
Added in `v0.0.8`.
|
||||
|
||||
Displays jenkins status of given builds in a project or view
|
||||
|
||||
<img src="/imgs/modules/jenkins.png" alt="jenkins screenshot",
|
||||
width="320" height="68" alt="jenkins screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/jenkins/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,11 +2,12 @@
|
||||
title: "Jira"
|
||||
date: 2018-05-10T10:44:35-07:00
|
||||
draft: false
|
||||
weight: 140
|
||||
---
|
||||
|
||||
Displays all Jira issues assigned to you for the specified project.
|
||||
<img class="screenshot" src="/imgs/modules/jira.png" width="640" height="188" alt="jira screenshot" />
|
||||
|
||||
<img src="/imgs/modules/jira.png" width="640" height="188" alt="jira screenshot" />
|
||||
Displays all Jira issues assigned to you for the specified project.
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -2,15 +2,16 @@
|
||||
title: "Logger"
|
||||
date: 2018-06-16T14:22:18-07:00
|
||||
draft: false
|
||||
weight: 150
|
||||
---
|
||||
|
||||
Displays the contents of the WTF log file.
|
||||
Displays the contents of the WTF log file. The log file is located at `~/.config/wtf/log.txt`.
|
||||
|
||||
To log to this file in your own modules:
|
||||
|
||||
```golang
|
||||
require "github.com/senorprogrammer/wtf/logger"
|
||||
logger.Log("This is a log entry")
|
||||
logger.Log("This is a log entry")
|
||||
```
|
||||
|
||||
## Source Code
|
||||
@ -19,10 +20,6 @@ require "github.com/senorprogrammer/wtf/logger"
|
||||
wtf/logger/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
Arrow keys scroll through the log file.
|
||||
@ -2,23 +2,20 @@
|
||||
title: "New Relic"
|
||||
date: 2018-05-09T09:01:14-07:00
|
||||
draft: false
|
||||
weight: 160
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/newrelic.png" width="640" height="189" alt="newrelic screenshot" />
|
||||
|
||||
Connects to the New Relic API and displays the last n deploys of the
|
||||
monitored application: deploy ID, deploy time, and who deployed it.
|
||||
|
||||
<img src="/imgs/modules/newrelic.png" width="640" height="189" alt="newrelic screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/newrelic/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,23 +2,20 @@
|
||||
title: "OpsGenie"
|
||||
date: 2018-05-08T20:53:40-07:00
|
||||
draft: false
|
||||
weight: 170
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" />
|
||||
|
||||
Connects to the OpsGenie API and displays all your scheduled rotations
|
||||
and who's currently on call.
|
||||
|
||||
<img src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/opsgenie/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,28 +2,21 @@
|
||||
title: "Power"
|
||||
date: 2018-05-26T19:26:23-07:00
|
||||
draft: false
|
||||
weight: 180
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/power.png" width="320" height="129" alt="power screenshot" />
|
||||
|
||||
Displays information about the current power source.
|
||||
|
||||
For battery, also displays the current charge, estimated time remaining,
|
||||
and whether it is charging or discharging.
|
||||
|
||||
<img src="/imgs/modules/power.png" width="320" height="129" alt="power screenshot" />
|
||||
|
||||
## Source Code
|
||||
```bash
|
||||
wtf/power/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,13 +2,14 @@
|
||||
title: "Security"
|
||||
date: 2018-05-08T20:33:28-07:00
|
||||
draft: false
|
||||
weight: 200
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/security.png" width="320" height="192" alt="security screenshot" />
|
||||
|
||||
Displays some general information about the state of the machine's wifi
|
||||
connection, firewall, DNS settings, and logged-in users.
|
||||
|
||||
<img src="/imgs/modules/security.png" width="320" height="192" alt="security screenshot" />
|
||||
|
||||
#### Wifi Network
|
||||
|
||||
<ul class="list-ornate">
|
||||
@ -42,14 +43,6 @@ show hidden users.</li>
|
||||
wtf/security/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,11 +2,12 @@
|
||||
title: "Textfile"
|
||||
date: 2018-05-09T11:13:11-07:00
|
||||
draft: false
|
||||
weight: 210
|
||||
---
|
||||
|
||||
Displays the contents of the specified text file in the widget.
|
||||
<img class="screenshot" src="/imgs/modules/textfile.png" width="320" height="133" alt="textfile screenshot" />
|
||||
|
||||
<img src="/imgs/modules/textfile.png" width="320" height="133" alt="textfile screenshot" />
|
||||
Displays the contents of the specified text file in the widget.
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -14,10 +15,6 @@ Displays the contents of the specified text file in the widget.
|
||||
wtf/textfile/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
@ -2,11 +2,12 @@
|
||||
title: "Todo"
|
||||
date: 2018-05-10T12:41:50-07:00
|
||||
draft: false
|
||||
weight: 220
|
||||
---
|
||||
|
||||
An interactive todo list.
|
||||
<img class="screenshot" src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" />
|
||||
|
||||
<img src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" />
|
||||
An interactive todo list.
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -14,10 +15,6 @@ An interactive todo list.
|
||||
wtf/todo/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `[return]` <br />
|
||||
@ -2,14 +2,15 @@
|
||||
title: "Todoist"
|
||||
date: 2018-07-05T22:55:55-03:00
|
||||
draft: false
|
||||
weight: 230
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/todoist.png" alt="todoist screenshot" />
|
||||
|
||||
Added in `v0.0.11`.
|
||||
|
||||
Displays all items on specified project.
|
||||
|
||||
<img src="/imgs/modules/todoist.png" alt="todoist screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@ -2,14 +2,15 @@
|
||||
title: "TravisCI"
|
||||
date: 2018-07-18T14:36:08-04:00
|
||||
draft: false
|
||||
weight: 240
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/travisci.png" width="640" height="187" alt="travisci screenshot" />
|
||||
|
||||
Added in `v0.0.12`.
|
||||
|
||||
Displays build information for your Travis CI account.
|
||||
|
||||
<img src="/imgs/modules/travisci.png" width="609" height="150" alt="travisci screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
@ -63,10 +64,10 @@ Values: `true`, `false`.
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`pro` <br />
|
||||
Determines whether or not this module will use the Pro version of Travis CI.<br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@ -2,11 +2,12 @@
|
||||
title: "Trello"
|
||||
date: 2018-05-10T10:44:35-07:00
|
||||
draft: false
|
||||
weight: 250
|
||||
---
|
||||
|
||||
Displays all Trello cards on specified lists.
|
||||
<img class="screenshot" src="/imgs/modules/trello.png" width="640" height="197" alt="trello screenshot" />
|
||||
|
||||
<img src="/imgs/modules/trello.png" width="640" height="188" alt="trello screenshot" />
|
||||
Displays all Trello cards on specified lists.
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -14,10 +15,6 @@ Displays all Trello cards on specified lists.
|
||||
wtf/trello/
|
||||
```
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Single Trello List
|
||||
@ -2,9 +2,10 @@
|
||||
title: "Twitter"
|
||||
date: 2018-07-31T20:21:37-07:00
|
||||
draft: false
|
||||
weight: 260
|
||||
---
|
||||
|
||||
Added in `v0.1.2`.
|
||||
Added in `v0.2.0`.
|
||||
|
||||
Connects to the Twitter API and displays a single user's tweets.
|
||||
|
||||
8
_site/content/modules/weather_services/_index.md
Normal file
8
_site/content/modules/weather_services/_index.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Weather Services"
|
||||
date: 2018-05-07T18:04:58-07:00
|
||||
draft: false
|
||||
weight: 270
|
||||
---
|
||||
|
||||
For all modules weather-related.
|
||||
@ -2,12 +2,14 @@
|
||||
title: "Pretty Weather"
|
||||
date: 2018-06-02T05:32:04-07:00
|
||||
draft: false
|
||||
weight: 10
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/prettyweather.png" width="320" height="191" alt="prettyweather screenshot" />
|
||||
|
||||
Displays weather information as ASCII art from
|
||||
[Wttr.in](http://wttr.in).
|
||||
|
||||
<img src="/imgs/modules/prettyweather.png" width="320" height="191" alt="prettyweather screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -15,14 +17,6 @@ Displays weather information as ASCII art from
|
||||
wtf/prettyweather/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
@ -2,12 +2,14 @@
|
||||
title: "Weather"
|
||||
date: 2018-05-09T11:44:13-07:00
|
||||
draft: false
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<img class="screenshot" src="/imgs/modules/weather.png" width="320" height="187" alt="weather screenshot" />
|
||||
|
||||
Displays a configurable list of current weather report, including
|
||||
current temperature, sunrise time, and sunset time.
|
||||
|
||||
<img src="/imgs/modules/weather.png" width="320" height="187" alt="weather screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
@ -15,14 +17,6 @@ current temperature, sunrise time, and sunset time.
|
||||
wtf/weather/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
|
||||
|
||||
<span class="caption">Key:</span> `WTF_OWM_API_KEY` <br />
|
||||
<span class="caption">Action:</span> Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key. <br />
|
||||
<span class="caption">Note:</span> DEPRECATED. See the `apiKey` config value, below.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
<span class="caption">Key:</span> `/` <br />
|
||||
@ -2,6 +2,7 @@
|
||||
title: "Zendesk"
|
||||
date: 2018-07-23T18:55:37-08:00
|
||||
draft: false
|
||||
weight: 280
|
||||
---
|
||||
|
||||
Added in `v0.1.0`.
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 109 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 27 KiB |
22
_site/themes/docdock/LICENSE.md
Normal file
22
_site/themes/docdock/LICENSE.md
Normal file
@ -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.
|
||||
129
_site/themes/docdock/README.md
Normal file
129
_site/themes/docdock/README.md
Normal file
@ -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 = "<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)
|
||||
4
_site/themes/docdock/_prose.yml
Normal file
4
_site/themes/docdock/_prose.yml
Normal file
@ -0,0 +1,4 @@
|
||||
prose:
|
||||
rooturl: 'exampleSite/content'
|
||||
siteurl: 'https://docdock.netlify.com/'
|
||||
media: 'exampleSite/static'
|
||||
9
_site/themes/docdock/archetypes/default.md
Normal file
9
_site/themes/docdock/archetypes/default.md
Normal file
@ -0,0 +1,9 @@
|
||||
+++
|
||||
title= "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date= {{ .Date }}
|
||||
description = ""
|
||||
draft= true
|
||||
+++
|
||||
|
||||
Lorem Ipsum.
|
||||
Notice `draft` is set to true.
|
||||
46
_site/themes/docdock/archetypes/slide.md
Normal file
46
_site/themes/docdock/archetypes/slide.md
Normal file
@ -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
|
||||
68
_site/themes/docdock/exampleSite/config.toml
Normal file
68
_site/themes/docdock/exampleSite/config.toml
Normal file
@ -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 = "<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
|
||||
50
_site/themes/docdock/exampleSite/content/_index.md
Normal file
50
_site/themes/docdock/exampleSite/content/_index.md
Normal file
@ -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 %}}
|
||||
|
||||
@ -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 ="<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"%}})
|
||||
|
||||
|
||||
|
||||
@ -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 \<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
|
||||
@ -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
|
||||
```
|
||||
@ -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"`
|
||||
```
|
||||
|
||||
|
||||
@ -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"
|
||||
```
|
||||
|
||||
|
||||
@ -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 = "<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/)
|
||||
@ -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%}}
|
||||
@ -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 ="<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"%}})
|
||||
@ -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.
|
||||
@ -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
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -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"%}})
|
||||
44
_site/themes/docdock/exampleSite/content/credits.md
Normal file
44
_site/themes/docdock/exampleSite/content/credits.md
Normal file
@ -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
|
||||
<div class="ghContributors">
|
||||
|
||||
<div>
|
||||
<img src="https://avatars2.githubusercontent.com/u/394382?v=3" class="inline" width="32" height="32" style="height: 32px;height: 32px;margin-bottom:.25em; vertical-align:middle; ">
|
||||
<label>@<a href="https://github.com/bep">bep</a></label>
|
||||
<span class="contributions">supports and advices</span>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<img src="https://avatars1.githubusercontent.com/u/959400?s=200&v=4" class="inline" width="32" height="32" style="height: 32px;height: 32px;margin-bottom:.25em; vertical-align:middle; ">
|
||||
<label>@<a href="https://github.com/facette">facette.io</a></label>
|
||||
<span class="contributions">Flex style based on facette documentation theme, <br>Thanks to @vbatoufflet</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
## 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"%}}
|
||||
@ -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"%}}
|
||||
@ -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.
|
||||
<!--more-->
|
||||
|
||||
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 = "../.."
|
||||
```
|
||||
|
||||
|
||||
{{%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.
|
||||
@ -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/).
|
||||
<!--more-->
|
||||
|
||||
## 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"%}})
|
||||
13
_site/themes/docdock/exampleSite/content/search/_index.md
Normal file
13
_site/themes/docdock/exampleSite/content/search/_index.md
Normal file
@ -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. <br/>When you build the site with `hugo server`, hugo generates it internally and of course it don't show up in the filesystem{{%/note%}}
|
||||
@ -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" %}}
|
||||
30
_site/themes/docdock/exampleSite/content/shortcodes/alert.md
Normal file
30
_site/themes/docdock/exampleSite/content/shortcodes/alert.md
Normal file
@ -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 %}}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
@ -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. <br/><br/>{{%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)"/%}}
|
||||
|
||||
@ -0,0 +1,37 @@
|
||||
+++
|
||||
title = "button"
|
||||
description = "Display an actionable button in your page."
|
||||
+++
|
||||
|
||||
Display an actionable button in your page.
|
||||
|
||||
{{<button align="center" href="#" theme="warning" >}} This is a warning button {{< /button >}}
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| href | "" | The location href to link to |
|
||||
| align | "center" | horizontal align button on page |
|
||||
| theme | `primary` | `default`, `primary` , `success`,`info`,`warning`,`danger` |
|
||||
|
||||
The inner text you place in short code will be displayed as the _button text_
|
||||
|
||||
## Demo
|
||||
|
||||
{{</* button href="https://google.com" */>}} go to google {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="success" */>}} Success {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="info" */>}} Info {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="warning" */>}} Warning {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="danger" */>}} Danger ! {{</* /button */>}}
|
||||
{{</* button href="https://google.com" theme="default" */>}} Danger ! {{</* /button */>}}
|
||||
|
||||
{{<button href="https://google.com" >}} go to google {{< /button >}}
|
||||
{{<button href="https://google.com" theme="success">}} Success {{< /button >}}
|
||||
{{<button href="https://google.com" theme="info">}} Info {{< /button >}}
|
||||
{{<button href="https://google.com" theme="warning">}} Warning {{< /button >}}
|
||||
{{<button href="https://google.com" theme="danger">}} Danger ! {{< /button >}}
|
||||
{{<button href="https://google.com" theme="default">}} Danger ! {{< /button >}}
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,46 @@
|
||||
+++
|
||||
title = "children"
|
||||
description = "List the child pages of a page"
|
||||
+++
|
||||
|
||||
|
||||
Use the children shortcode to list the child pages of a page and the further descendants (children's children). By default, the shortcode displays links to the child pages.
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| page | _current_ | Specify the page name (section name) to display children for |
|
||||
| style | "li" | Choose the style used to display descendants. It could be any HTML tag name, use "card" to display children pages as cards |
|
||||
| showhidden | "false" | When true, child pages hidden from the menu will be displayed |
|
||||
| description | "false" | Allows you to include a short text under each page in the list.<br/>when no description exists for the page, children shortcode takes the first 70 words of your content. [read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/) |
|
||||
| depth | 1 | Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages. {{%alert success%}}**Tips:** set 999 to get all descendants{{%/alert%}}|
|
||||
| sort | none | Sort Children By<br><li><strong>Weight</strong> - to sort on menu order</li><li><strong>Name</strong> - to sort alphabetically on menu label</li><li><strong>Identifier</strong> - to sort alphabetically on identifier set in frontmatter</li><li><strong>URL</strong> - URL</li> |
|
||||
|
||||
|
||||
|
||||
## Demo
|
||||
|
||||
{{%/* children */%}}
|
||||
|
||||
{{%children %}}
|
||||
|
||||
{{%/* children description="true" */%}}
|
||||
|
||||
{{%children description="true" %}}
|
||||
|
||||
{{%/* children depth="3" showhidden="true" */%}}
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
|
||||
{{%/* children style="h2" depth="3" description="true" */%}}
|
||||
|
||||
{{% children style="h2" depth="3" description="true" %}}
|
||||
|
||||
{{%/* children style="div" depth="999" */%}}
|
||||
|
||||
{{% children style="div" depth="999" %}}
|
||||
|
||||
{{%/* children style="card" depth="2" description="true" */%}}
|
||||
|
||||
{{% children style="card" depth="2" description="true" %}}
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page 1"
|
||||
description = "This is a demo child page"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page 1-1"
|
||||
description = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page 1-1-1"
|
||||
description = "This is a demo child page"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page 1-1-1-1"
|
||||
description = "This is a demo child page"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page 1-1-1-1-1"
|
||||
description = "This is a demo child page"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
@ -0,0 +1,11 @@
|
||||
+++
|
||||
title = "page 2"
|
||||
description = ""
|
||||
+++
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page test 3"
|
||||
description = "This is a page test"
|
||||
+++
|
||||
|
||||
This is a test 3 demo child page
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page 3"
|
||||
description = "This is a demo child page"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
@ -0,0 +1,7 @@
|
||||
+++
|
||||
title = "page 4"
|
||||
description = "This is a demo child page"
|
||||
hidden=true
|
||||
+++
|
||||
|
||||
This is a demo child page, not displayed in the menu
|
||||
@ -0,0 +1,6 @@
|
||||
+++
|
||||
title = "page test"
|
||||
description = "This is a page test"
|
||||
+++
|
||||
|
||||
This is a test demo child page
|
||||
@ -0,0 +1,25 @@
|
||||
+++
|
||||
title = "excerpt-include"
|
||||
description = ""
|
||||
+++
|
||||
|
||||
The Excerpt Include shortcode is used to display 'excerpted' (that is, a segment of) content from one page in another.
|
||||
Before you can use this shortcode, the excerpt must have been defined using the Excerpt shortcode. {{%alert info%}}Note that you can have more than one Excerpt Include shortcode on a page (although you can have only one Excerpt shortcode on a page).{{%/alert%}}
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| filename | **required** | Type the filename of the page that contains the excerpt to be displayed.<br/>Path is relative to the content folder|
|
||||
| panel | none | Determines whether docDock will display a panel around the excerpted content. The panel includes the given panel's value and the border of the panel. By default, the panel and title are not shown.|
|
||||
|
||||
## Demo
|
||||
The paragraph below shows an example of an Excerpt Include shortcode, containing content from an excerpt which we have defined on the Excerpt shortcode page. On the Excerpt Include shortcode below, we have set the options to show both the title of the page and the panel surrounding the content.
|
||||
|
||||
{{%/*excerpt-include filename="shortcodes/excerpt.md" panel="From excerpt page" /*/%}}
|
||||
|
||||
{{%excerpt-include filename="shortcodes/excerpt.md" panel="From excerpt page" /%}}
|
||||
|
||||
> Don't create an excerpt file in the ```/layouts/shortcodes/``` folder.
|
||||
> In this example, ```shortcodes/filename.md``` is part of the ```exampleSite/content``` folder, and ```shortcodes``` is just a path in the ```/content```.
|
||||
@ -0,0 +1,39 @@
|
||||
+++
|
||||
title = "excerpt"
|
||||
description = "The Excerpt shortcode is used to mark a part of a page's content for re-use."
|
||||
+++
|
||||
|
||||
The Excerpt shortcode is used to mark a part of a page's content for re-use. Defining an excerpt enables other shortcodes, such as the excerpt-include shortcode, to display the marked content elsewhere.
|
||||
|
||||
{{%alert warning%}}You can only define one excerpt per page. In other words, you can only add the Excerpt shortcode once to a page.{{%/alert%}}
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| hidden | "false" | Controls whether the page content contained in the Excerpt shortcode placeholder is displayed on the page.{{%alert warning%}}Note that this option affects only the page that contains the Excerpt shortcode. It does not affect any pages where the content is reused.{{%/alert%}} |
|
||||
|
||||
## Demo
|
||||
|
||||
{{%/*excerpt*/%}}
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation **ullamco** laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in _reprehenderit in voluptate_
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
{{%/* /excerpt*/%}}
|
||||
|
||||
{{%excerpt%}}
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation **ullamco** laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in _reprehenderit in voluptate_
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
{{% /excerpt%}}
|
||||
|
||||
|
||||
|
||||
{{%alert info%}}See re use example with [excerpt-include shortcode]({{%relref "shortcodes/excerpt-include.md"%}}){{%/alert%}}
|
||||
@ -0,0 +1,41 @@
|
||||
+++
|
||||
title = "expand"
|
||||
description = "Displays an expandable/collapsible section of text on your page"
|
||||
+++
|
||||
|
||||
The Expand shortcode displays an expandable/collapsible section of text on your page.
|
||||
Here is an example
|
||||
|
||||
{{%expand%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{%/expand%}}
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
this shortcode takes exactly one optional parameter to define the text that appears next to the expand/collapse icon. (default is "Expand me...")
|
||||
|
||||
{{%/*expand "Is this docdock theme rocks ?" */%}}Yes !.{{%/* /expand*/%}}
|
||||
|
||||
{{%expand "Is this docdock theme rocks ?" %}}Yes !{{% /expand%}}
|
||||
|
||||
# Demo
|
||||
|
||||
{{%/*expand*/%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{%/* /expand*/%}}
|
||||
|
||||
|
||||
{{%expand%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{% /expand%}}
|
||||
1254
_site/themes/docdock/exampleSite/content/shortcodes/icon.md
Normal file
1254
_site/themes/docdock/exampleSite/content/shortcodes/icon.md
Normal file
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,98 @@
|
||||
+++
|
||||
title = "mermaid"
|
||||
description = ""
|
||||
+++
|
||||
|
||||
## Flowchart example
|
||||
{{%expand "Show code ..."%}}
|
||||
{{</*mermaid align="left"*/>}}
|
||||
graph LR;
|
||||
A[Hard edge] -->|Link text| B(Round edge)
|
||||
B --> C{Decision}
|
||||
C -->|One| D[Result one]
|
||||
C -->|Two| E[Result two]
|
||||
{{</* /mermaid */>}}
|
||||
{{%/expand%}}
|
||||
|
||||
{{<mermaid align="left">}}
|
||||
graph LR;
|
||||
A[Hard edge] -->|Link text| B(Round edge)
|
||||
B --> C{Decision}
|
||||
C -->|One| D[Result one]
|
||||
C -->|Two| E[Result two]
|
||||
{{< /mermaid >}}
|
||||
|
||||
## Sequence example
|
||||
{{%expand "Show code ..."%}}
|
||||
{{</*mermaid*/>}}
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->>John: Hello John, how are you?
|
||||
loop Healthcheck
|
||||
John->John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail...
|
||||
John-->Alice: Great!
|
||||
John->Bob: How about you?
|
||||
Bob-->John: Jolly good!
|
||||
{{</* /mermaid */>}}
|
||||
{{%/expand%}}
|
||||
|
||||
{{<mermaid>}}
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->>John: Hello John, how are you?
|
||||
loop Healthcheck
|
||||
John->John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail...
|
||||
John-->Alice: Great!
|
||||
John->Bob: How about you?
|
||||
Bob-->John: Jolly good!
|
||||
{{< /mermaid >}}
|
||||
|
||||
|
||||
|
||||
## GANTT Example
|
||||
{{%expand "Show code ..."%}}
|
||||
{{</*mermaid*/>}}
|
||||
gantt
|
||||
dateFormat YYYY-MM-DD
|
||||
title Adding GANTT diagram functionality to mermaid
|
||||
section A section
|
||||
Completed task :done, des1, 2014-01-06,2014-01-08
|
||||
Active task :active, des2, 2014-01-09, 3d
|
||||
Future task : des3, after des2, 5d
|
||||
Future task2 : des4, after des3, 5d
|
||||
section Critical tasks
|
||||
Completed task in the critical line :crit, done, 2014-01-06,24h
|
||||
Implement parser and jison :crit, done, after des1, 2d
|
||||
Create tests for parser :crit, active, 3d
|
||||
Future task in critical line :crit, 5d
|
||||
Create tests for renderer :2d
|
||||
Add to mermaid :1d
|
||||
{{</* /mermaid */>}}
|
||||
{{%/expand%}}
|
||||
|
||||
{{<mermaid>}}
|
||||
gantt
|
||||
dateFormat YYYY-MM-DD
|
||||
title Adding GANTT diagram functionality to mermaid
|
||||
section A section
|
||||
Completed task :done, des1, 2014-01-06,2014-01-08
|
||||
Active task :active, des2, 2014-01-09, 3d
|
||||
Future task : des3, after des2, 5d
|
||||
Future task2 : des4, after des3, 5d
|
||||
section Critical tasks
|
||||
Completed task in the critical line :crit, done, 2014-01-06,24h
|
||||
Implement parser and jison :crit, done, after des1, 2d
|
||||
Create tests for parser :crit, active, 3d
|
||||
Future task in critical line :crit, 5d
|
||||
Create tests for renderer :2d
|
||||
Add to mermaid :1d
|
||||
{{</mermaid>}}
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,61 @@
|
||||
+++
|
||||
title = "notice"
|
||||
description = "Disclaimers to help you structure your page"
|
||||
+++
|
||||
|
||||
The notice shortcode shows 4 types of disclaimers to help you structure your page.
|
||||
|
||||
|
||||
## Note
|
||||
|
||||
{{%/* notice note */%}}
|
||||
A notice disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice note %}}
|
||||
A notice disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
## Info
|
||||
|
||||
{{%/* notice info */%}}
|
||||
An information disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice info %}}
|
||||
An information disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
|
||||
## Tip
|
||||
|
||||
{{%/* notice tip */%}}
|
||||
A tip disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice tip %}}
|
||||
A tip disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
|
||||
## Warning
|
||||
|
||||
{{%/* notice warning */%}}
|
||||
An warning disclaimer
|
||||
{{%/* /notice */%}}
|
||||
|
||||
renders as
|
||||
|
||||
{{% notice warning %}}
|
||||
An warning disclaimer
|
||||
{{% /notice %}}
|
||||
|
||||
60
_site/themes/docdock/exampleSite/content/shortcodes/panel.md
Normal file
60
_site/themes/docdock/exampleSite/content/shortcodes/panel.md
Normal file
@ -0,0 +1,60 @@
|
||||
+++
|
||||
title = "panel"
|
||||
description = "Allow you to highlight information or put it in a box."
|
||||
+++
|
||||
|
||||
|
||||
|
||||
{{% panel theme="success" header="The panel shortcode" %}}Allow you to highlight information or put it in a box. They create a colored box surrounding your text{{% /panel %}}
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|:--|:--|:--|
|
||||
| header | none | The title of the panel. If specified, this title will be displayed in its own header row. |
|
||||
| footer | none | the footer of the panel. If specified, this text will be displayed in its own row |
|
||||
| theme | `primary` | `default`,`primary`,`info`,`success`,`warning`,`danger` |
|
||||
|
||||
## Basic example
|
||||
|
||||
By default :
|
||||
|
||||
{{%/* panel */%}}this is a panel text{{%/* /panel */%}}
|
||||
|
||||
{{%panel%}}this is a panel text{{%/panel%}}
|
||||
|
||||
## Panel with heading
|
||||
|
||||
Easily add a heading container to your panel with `header` parameter. You may apply any theme.
|
||||
|
||||
{{%/* panel theme="danger" header="panel title" */%}}this is a panel text{{%/* /panel */%}}
|
||||
|
||||
{{% panel theme="danger" header="panel title" %}}this is a panel text{{% /panel %}}
|
||||
|
||||
{{%/* panel theme="success" header="panel title" */%}}this is a panel text{{%/* /panel */%}}
|
||||
|
||||
{{% panel theme="success" header="panel title" %}}this is a panel text{{% /panel %}}
|
||||
|
||||
## Panel with footer
|
||||
Wrap a secondary text in footer.
|
||||
|
||||
{{%/* panel footer="panel footer" */%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{%/* /panel */%}}
|
||||
|
||||
{{% panel footer="panel footer" %}}
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
{{% /panel %}}
|
||||
|
||||
## Themes
|
||||
|
||||
{{% panel theme="success" header="Success theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="default" header="default theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="primary" header="primary theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="info" header="info theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="warning" header="warning theme" %}}this is a panel text{{% /panel %}}
|
||||
{{% panel theme="danger" header="danger theme" %}}this is a panel text{{% /panel %}}
|
||||
119
_site/themes/docdock/exampleSite/content/shortcodes/revealjs.md
Normal file
119
_site/themes/docdock/exampleSite/content/shortcodes/revealjs.md
Normal file
@ -0,0 +1,119 @@
|
||||
+++
|
||||
title = "revealjs"
|
||||
slug = "revealjs"
|
||||
description = "present content as a reveal.js slide"
|
||||
+++
|
||||
|
||||
This shortcode will format the enclosed markdow to render it with [reveal.js](http://lab.hakim.se/reveal-js/) at runtime (client-side)
|
||||
|
||||
Read more on [revealjs github repo](https://github.com/hakimel/reveal.js/#markdown).
|
||||
|
||||
## Usage
|
||||
|
||||
`revealjs` can use the following named parameters :
|
||||
|
||||
* theme
|
||||
* transition
|
||||
* controls
|
||||
* progress
|
||||
* history
|
||||
* center
|
||||
|
||||
|
||||
{{%warning title="Important" %}}Even if the enclosed content is a mardown, use `<` shortcode notation instead of the `%` notation {{%/warning %}}
|
||||
|
||||
### Content formating and slide delimiters
|
||||
|
||||
[read more on this here]({{% relref "page-slide.md"%}})
|
||||
|
||||
## Demo
|
||||
|
||||
|
||||
{{<revealjs theme="moon" progress="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
|
||||
|
||||
{{</revealjs>}}
|
||||
|
||||
## Source :
|
||||
|
||||
{{%expand "Show code ..."%}}
|
||||
|
||||
```
|
||||
{{</*revealjs theme="moon" progress="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
|
||||
|
||||
{{</*revealjs*/>}}
|
||||
|
||||
```
|
||||
|
||||
{{%/expand%}}
|
||||
|
||||
* [{{%icon "sunglasses" %}} click here to view raw content](https://raw.githubusercontent.com/vjeantet/hugo-theme-docdock/master/exampleSite/content/shortcodes/revealjs.md)
|
||||
15
_site/themes/docdock/exampleSite/content/showcase.md
Normal file
15
_site/themes/docdock/exampleSite/content/showcase.md
Normal file
@ -0,0 +1,15 @@
|
||||
+++
|
||||
title = "Docdock-built Sites"
|
||||
description = "Hugo-built Sites with docdock theme"
|
||||
+++
|
||||
|
||||
|
||||
|
||||
|
||||
#### [https://invincible.site/](https://invincible.site/) by [@shazic](https://github.com/shazic)
|
||||
|
||||
|
||||
|
||||
#### [https://bitfan.io/](https://bitfan.io) by [@vjeantet](https://github.com/vjeantet)
|
||||
|
||||
|
||||
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