mirror of https://github.com/miguelmota/cointop
Add documentation hugo site
Miguel Mota
3 years ago
parent
0a0530de5a
commit
d27904a0fc
@ -0,0 +1 @@
|
||||
public
|
||||
@ -0,0 +1,6 @@
|
||||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
draft: true
|
||||
---
|
||||
|
||||
@ -0,0 +1,7 @@
|
||||
baseURL = "https://docs.cointop.sh/"
|
||||
languageCode = "en-us"
|
||||
title = "Cointop Documentation"
|
||||
theme = "hugo-book"
|
||||
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
@ -0,0 +1,35 @@
|
||||
---
|
||||
title: "Intro"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
[`cointop`](https://github.com/miguelmota/cointop) is a fast and lightweight interactive terminal based UI application for tracking and monitoring cryptocurrency coin stats in real-time.
|
||||
|
||||
The interface is inspired by [`htop`](https://en.wikipedia.org/wiki/Htop) and shortcut keys are inspired by [`vim`](https://en.wikipedia.org/wiki/Vim_(text_editor)).
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/168240/39569578-7ce9f3b6-4e7a-11e8-82a9-8a18b91b1bd5.png" alt="cointop screenshot" width="880" />
|
||||
|
||||
## Features
|
||||
|
||||
- Quick sort shortcuts
|
||||
- Custom key bindings configuration
|
||||
- Vim inspired shortcut keys
|
||||
- Fast pagination
|
||||
- Charts for coins and global market graphs
|
||||
- Quick chart date range change
|
||||
- Fuzzy searching for finding coins
|
||||
- Currency conversion
|
||||
- Save and view favorite coins
|
||||
- Portfolio tracking of holdings
|
||||
- 256-color support
|
||||
- Custom colorschemes
|
||||
- Help menu
|
||||
- Offline cache
|
||||
- Supports multiple coin stat APIs
|
||||
- Auto-refresh
|
||||
- Works on macOS, Linux, and Windows
|
||||
- It's very lightweight; can be left running indefinitely
|
||||
|
||||
## In action
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/168240/39569570-75b1547c-4e7a-11e8-8eac-552abaa431f0.gif" alt="screencast" width="880" />
|
||||
@ -0,0 +1,39 @@
|
||||
---
|
||||
title: "Colorschemes"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Colorschemes
|
||||
|
||||
cointop supports custom colorschemes (themes).
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/168240/59164231-165b9c80-8abf-11e9-98cf-915ee37407ff.gif" alt="cointop colorschemes" width="880" />
|
||||
|
||||
To use standard colorschemes, clone the [colors](https://github.com/cointop-sh/colors) repository into the config directory:
|
||||
|
||||
```bash
|
||||
$ cd ~/.config/cointop
|
||||
$ git clone git@github.com:cointop-sh/colors.git
|
||||
```
|
||||
|
||||
Then edit your config `~/.config/cointop/config.toml` and set the colorscheme you want to use:
|
||||
|
||||
```toml
|
||||
colorscheme = "<colorscheme>"
|
||||
```
|
||||
|
||||
The colorscheme name is the name of the colorscheme TOML file.
|
||||
|
||||
For example, if you have `matrix.toml` in `~/.cointop/colors/` then the `colorscheme` property should be set to:
|
||||
|
||||
```toml
|
||||
colorscheme = "matrix"
|
||||
```
|
||||
|
||||
Alternatively, you can run cointop with the `--colorscheme` flag to set the colorscheme:
|
||||
|
||||
```bash
|
||||
$ cointop --colorscheme matrix
|
||||
```
|
||||
|
||||
To create your own colorscheme; simply copy an existing [colorscheme](https://github.com/cointop-sh/colors/blob/master/cointop.toml), rename it, and customize the colors.
|
||||
@ -0,0 +1,176 @@
|
||||
---
|
||||
title: "Config"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Config
|
||||
|
||||
The first time you run cointop, it'll create a config file in:
|
||||
|
||||
```
|
||||
~/.config/cointop/config.toml
|
||||
```
|
||||
|
||||
You can then configure the actions you want for each key:
|
||||
|
||||
(default `~/.config/cointop/config.toml`)
|
||||
|
||||
```toml
|
||||
currency = "USD"
|
||||
default_view = ""
|
||||
api = "coingecko"
|
||||
colorscheme = "cointop"
|
||||
refresh_rate = 60
|
||||
|
||||
[shortcuts]
|
||||
"$" = "last_page"
|
||||
0 = "first_page"
|
||||
1 = "sort_column_1h_change"
|
||||
2 = "sort_column_24h_change"
|
||||
7 = "sort_column_7d_change"
|
||||
"?" = "help"
|
||||
"/" = "open_search"
|
||||
"[" = "previous_chart_range"
|
||||
"\\" = "toggle_table_fullscreen"
|
||||
"]" = "next_chart_range"
|
||||
"{" = "first_chart_range"
|
||||
"}" = "last_chart_range"
|
||||
"<" = "scroll_left"
|
||||
">" = "scroll_right"
|
||||
C = "show_currency_convert_menu"
|
||||
E = "show_portfolio_edit_menu"
|
||||
G = "move_to_page_last_row"
|
||||
H = "move_to_page_visible_first_row"
|
||||
L = "move_to_page_visible_last_row"
|
||||
M = "move_to_page_visible_middle_row"
|
||||
O = "open_link"
|
||||
P = "toggle_portfolio"
|
||||
a = "sort_column_available_supply"
|
||||
"alt+down" = "sort_column_desc"
|
||||
"alt+left" = "sort_left_column"
|
||||
"alt+right" = "sort_right_column"
|
||||
"alt+up" = "sort_column_asc"
|
||||
down = "move_down"
|
||||
left = "previous_page"
|
||||
right = "next_page"
|
||||
up = "move_up"
|
||||
c = "show_currency_convert_menu"
|
||||
b = "sort_column_balance"
|
||||
"ctrl+c" = "quit"
|
||||
"ctrl+d" = "page_down"
|
||||
"ctrl+f" = "open_search"
|
||||
"ctrl+j" = "enlarge_chart"
|
||||
"ctrl+k" = "shorten_chart"
|
||||
"ctrl+n" = "next_page"
|
||||
"ctrl+p" = "previous_page"
|
||||
"ctrl+r" = "refresh"
|
||||
"ctrl+s" = "save"
|
||||
"ctrl+u" = "page_up"
|
||||
e = "show_portfolio_edit_menu"
|
||||
end = "move_to_page_last_row"
|
||||
enter = "toggle_row_chart"
|
||||
esc = "quit"
|
||||
f = "toggle_favorite"
|
||||
F = "toggle_show_favorites"
|
||||
F1 = "help"
|
||||
g = "move_to_page_first_row"
|
||||
h = "previous_page"
|
||||
home = "move_to_page_first_row"
|
||||
j = "move_down"
|
||||
k = "move_up"
|
||||
l = "next_page"
|
||||
m = "sort_column_market_cap"
|
||||
n = "sort_column_name"
|
||||
o = "open_link"
|
||||
p = "sort_column_price"
|
||||
pagedown = "page_down"
|
||||
pageup = "page_up"
|
||||
q = "quit_view"
|
||||
Q = "quit_view"
|
||||
r = "sort_column_rank"
|
||||
s = "sort_column_symbol"
|
||||
space = "toggle_favorite"
|
||||
tab = "move_down_or_next_page"
|
||||
t = "sort_column_total_supply"
|
||||
u = "sort_column_last_updated"
|
||||
v = "sort_column_24h_volume"
|
||||
|
||||
[favorites]
|
||||
|
||||
[portfolio]
|
||||
|
||||
[coinmarketcap]
|
||||
pro_api_key = ""
|
||||
```
|
||||
|
||||
You may specify a different config file to use by using the `--config` flag:
|
||||
|
||||
```bash
|
||||
cointop --config="/path/to/config.toml"
|
||||
```
|
||||
|
||||
## List of actions
|
||||
|
||||
This are the action keywords you may use in the config file to change what the shortcut keys do.
|
||||
|
||||
Action|Description
|
||||
----|------|
|
||||
`first_chart_range`|Select first chart date range (e.g. 24H)
|
||||
`first_page`|Go to first page
|
||||
`enlarge_chart`|Increase chart height
|
||||
`help`|Show help
|
||||
`hide_currency_convert_menu`|Hide currency convert menu
|
||||
`last_chart_range`|Select last chart date range (e.g. All Time)
|
||||
`last_page`|Go to last page
|
||||
`move_to_page_first_row`|Move to first row on page
|
||||
`move_to_page_last_row`|Move to last row on page
|
||||
`move_to_page_visible_first_row`|Move to first visible row on page
|
||||
`move_to_page_visible_last_row`|Move to last visible row on page
|
||||
`move_to_page_visible_middle_row`|Move to middle visible row on page
|
||||
`move_up`|Move one row up
|
||||
`move_down`|Move one row down
|
||||
`move_down_or_next_page`|Move one row down or to next page if at last row
|
||||
`move_up_or_previous_page`|Move one row up or to previous page if at first row
|
||||
`next_chart_range`|Select next chart date range (e.g. 3D → 7D)
|
||||
`next_page`|Go to next page
|
||||
`open_link`|Open row link
|
||||
`open_search`|Open search field
|
||||
`page_down`|Move one row down
|
||||
`page_up`|Scroll one page up
|
||||
`previous_chart_range`|Select previous chart date range (e.g. 7D → 3D)
|
||||
`previous_page`|Go to previous page
|
||||
`quit`|Quit application
|
||||
`quit_view`|Quit view
|
||||
`refresh`|Do a manual refresh on the data
|
||||
`save`|Save config
|
||||
`scroll_left`|Scroll table to the left
|
||||
`scroll_right`|Scroll table to the right
|
||||
`shorten_chart`|Decrease chart height
|
||||
`show_currency_convert_menu`|Show currency convert menu
|
||||
`show_favorites`|Show favorites
|
||||
`sort_column_1h_change`|Sort table by column *1 hour change*
|
||||
`sort_column_24h_change`|Sort table by column *24 hour change*
|
||||
`sort_column_24h_volume`|Sort table by column *24 hour volume*
|
||||
`sort_column_7d_change`|Sort table by column *7 day change*
|
||||
`sort_column_asc`|Sort highlighted column by ascending order
|
||||
`sort_column_available_supply`|Sort table by column *available supply*
|
||||
`sort_column_balance`|Sort table by column *balance*
|
||||
`sort_column_desc`|Sort highlighted column by descending order
|
||||
`sort_column_holdings`|Sort table by column *holdings*
|
||||
`sort_column_last_updated`|Sort table by column *last updated*
|
||||
`sort_column_market_cap`|Sort table by column *market cap*
|
||||
`sort_column_name`|Sort table by column *name*
|
||||
`sort_column_price`|Sort table by column *price*
|
||||
`sort_column_rank`|Sort table by column *rank*
|
||||
`sort_column_symbol`|Sort table by column *symbol*
|
||||
`sort_column_total_supply`|Sort table by column *total supply*
|
||||
`sort_left_column`|Sort the column to the left of the highlighted column
|
||||
`sort_right_column`|Sort the column to the right of the highlighted column
|
||||
`toggle_row_chart`|Toggle the chart for the highlighted row
|
||||
`toggle_favorite`|Toggle coin as favorite
|
||||
`toggle_show_currency_convert_menu`|Toggle show currency convert menu
|
||||
`toggle_show_favorites`|Toggle show favorites
|
||||
`toggle_portfolio`|Toggle portfolio view
|
||||
`toggle_show_portfolio`|Toggle show portfolio view
|
||||
`show_portfolio_edit_menu`|Show portfolio edit holdings menu
|
||||
`toggle_table_fullscreen`|Toggle table fullscreen
|
||||
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: "Contributing"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Contributing
|
||||
|
||||
Pull requests are welcome!
|
||||
|
||||
For contributions please create a new branch and submit a pull request for review.
|
||||
|
||||
Huge thanks to all the [contributors](https://github.com/miguelmota/cointop/graphs/contributors) that have made cointop better.
|
||||
@ -0,0 +1,75 @@
|
||||
---
|
||||
title: "Development"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Development
|
||||
|
||||
## Go
|
||||
|
||||
Running cointop from source
|
||||
|
||||
```bash
|
||||
make run
|
||||
```
|
||||
|
||||
## Update vendor dependencies
|
||||
|
||||
```bash
|
||||
make deps
|
||||
```
|
||||
|
||||
## Homebrew
|
||||
|
||||
Installing from source
|
||||
|
||||
```bash
|
||||
make brew/build
|
||||
```
|
||||
|
||||
## Flatpak
|
||||
|
||||
Install the freedesktop runtime (if not done so already)
|
||||
|
||||
```bash
|
||||
sudo flatpak install flathub org.freedesktop.Platform//1.6 org.freedesktop.Sdk//1.6
|
||||
```
|
||||
|
||||
Install golang extension
|
||||
|
||||
```bash
|
||||
sudo flatpak install flathub org.freedesktop.Sdk.Extension.golang
|
||||
```
|
||||
|
||||
Building flatpak package
|
||||
|
||||
```bash
|
||||
make flatpak/build
|
||||
```
|
||||
|
||||
## Copr
|
||||
|
||||
Install dependencies
|
||||
|
||||
```bash
|
||||
make copr/install/cli
|
||||
make rpm/install/deps
|
||||
make rpm/dirs
|
||||
```
|
||||
|
||||
Build package
|
||||
|
||||
```bash
|
||||
make rpm/cp/specs
|
||||
make rpm/download
|
||||
make rpm/build
|
||||
make copr/build
|
||||
```
|
||||
|
||||
## Snap
|
||||
|
||||
Building snap
|
||||
|
||||
```bash
|
||||
make snap/build
|
||||
```
|
||||
@ -0,0 +1,401 @@
|
||||
---
|
||||
title: "Frequently asked questions"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Frequently asked questions
|
||||
|
||||
## Where is the data from?
|
||||
|
||||
By default, the data is from [CoinGecko](https://www.coingecko.com/). Data from [CoinMarketCap](https://coinmarketcap.com/) is another option.
|
||||
|
||||
## What APIs does it support?
|
||||
|
||||
APIs currently supported are [CoinMarketCap](https://coinmarketcap.com/) and [CoinGecko](https://www.coingecko.com/).
|
||||
|
||||
## What coins does this support?
|
||||
|
||||
This supports any coin supported by the API being used to fetch coin information.
|
||||
|
||||
## How do I set the API to use?
|
||||
|
||||
You can use the `--api` flag, eg. `--api coingecko`. You can also set the API choice in the config file.
|
||||
|
||||
```toml
|
||||
api = "coingecko"
|
||||
```
|
||||
|
||||
Options are: `coinmarketcap`, `coingecko`
|
||||
|
||||
## How do I change the colorscheme (theme)?
|
||||
|
||||
You can use the `--colorscheme` flag, eg. `--colorscheme matrix`. You can also set the colorscheme choice in the config file.
|
||||
|
||||
```toml
|
||||
colorscheme = "<colorscheme>"
|
||||
```
|
||||
|
||||
For more instructions, visit the [colors](https://github.com/cointop-sh/colors) repository.
|
||||
|
||||
## How do I create a custom colorscheme?
|
||||
|
||||
Copy an existing [colorscheme](https://github.com/cointop-sh/colors/blob/master/cointop.toml) to `~/.config/cointop/colors/` and customize the colors. Then run cointop with `--colorscheme <colorscheme>` to use the colorscheme.
|
||||
|
||||
## Where is the config file located?
|
||||
|
||||
The default configuration file is located under `~/.config/cointop/config.toml`
|
||||
|
||||
Note: Previous versions of cointop used `~/.cointop/config` or `~/.cointop/config.toml` as the default config filepath. Cointop will use those config filepaths respectively if they exist.
|
||||
|
||||
## What format is the configuration file in?
|
||||
|
||||
The configuration file is in [TOML](https://en.wikipedia.org/wiki/TOML) format.
|
||||
|
||||
## Will you be supporting more coin API's in the future?
|
||||
|
||||
Yes supporting more coin APIs is planned.
|
||||
|
||||
## How often is the data polled?
|
||||
|
||||
Data gets polled once 60 seconds by default. You can press <kbd>Ctrl</kbd>+<kbd>r</kbd> to force refresh. You can configure the refresh rate with the flag `--refresh-rate <seconds>`
|
||||
|
||||
## How can I change the refresh rate?
|
||||
|
||||
Run cointop with the flag `--refresh-rate 60` where the value is the number of seconds that it will fetch for data. You can also set the refresh rate in the config file:
|
||||
|
||||
```toml
|
||||
refresh_rate = 60
|
||||
```
|
||||
|
||||
## I ran cointop for the first time and don't see any data?
|
||||
|
||||
Running cointop for the first time will fetch the data and populate the cache which may take a few seconds.
|
||||
|
||||
## I'm no longer seeing any data!
|
||||
|
||||
Run cointop with the `--clean` flag to delete the cache. If you're still not seeing any data, then please [submit an issue](https://github.com/miguelmota/cointop/issues/new).
|
||||
|
||||
## How do I get a CoinMarketCap Pro API key?
|
||||
|
||||
Create an account on [CoinMarketCap](https://pro.coinmarketcap.com/signup) and visit the [Account](https://pro.coinmarketcap.com/account) page to copy your Pro API key.
|
||||
|
||||
## How do I add my CoinMarketCap Pro API key?
|
||||
|
||||
Add the API key in the cointop config file:
|
||||
|
||||
```toml
|
||||
[coinmarketcap]
|
||||
pro_api_key = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
||||
```
|
||||
|
||||
Alternatively, you can export the environment variable `CMC_PRO_API_KEY` containing the API key in your `~/.bashrc`
|
||||
|
||||
```bash
|
||||
export CMC_PRO_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
||||
```
|
||||
|
||||
You may also set the API key on start:
|
||||
|
||||
```bash
|
||||
cointop --coinmarketcap-api-key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
||||
```
|
||||
|
||||
## I can I add my own API to cointop?
|
||||
|
||||
Fork cointop and add the API that implements the API [interface](https://github.com/miguelmota/cointop/blob/master/cointop/common/api/interface.go) to [`cointop/cointop/common/api/impl/`](https://github.com/miguelmota/cointop/tree/master/cointop/common/api/impl). You can use the CoinGecko [implementation](https://github.com/miguelmota/cointop/blob/master/cointop/common/api/impl/coingecko/coingecko.go) as reference.
|
||||
|
||||
## I installed cointop without errors but the command is not found.
|
||||
|
||||
Make sure your `GOPATH` and `PATH` is set correctly.
|
||||
|
||||
```bash
|
||||
export GOPATH=$HOME/go
|
||||
export PATH=$PATH:$GOPATH/bin
|
||||
```
|
||||
|
||||
## How do I search?
|
||||
|
||||
The default key to open search is <kbd>/</kbd>. Type the search query after the `/` in the field and hit <kbd>Enter</kbd>.
|
||||
|
||||
## How do I exit search?
|
||||
|
||||
Press <kbd>ESC</kbd> to exit search.
|
||||
|
||||
## Does this work on the Raspberry Pi?
|
||||
|
||||
Yes, cointop works on the Rasperry Pi including the RPi Zero.
|
||||
|
||||
## How do I add/remove a favorite?
|
||||
|
||||
Press the <kbd>f</kbd> key to toggle a coin as a favorite.
|
||||
|
||||
## How do I view all my favorites?
|
||||
|
||||
Press <kbd>F</kbd> (Shift+f) to toggle view all your favorites.
|
||||
|
||||
## How do I save my favorites?
|
||||
|
||||
Favorites are autosaved when setting them. You can also press <kbd>ctrl</kbd>+<kbd>s</kbd> to manually save your favorites to the config file.
|
||||
|
||||
## What does the yellow asterisk in the row mean?
|
||||
|
||||
The yellow asterisk or star means that you've selected that coin to be a favorite.
|
||||
|
||||
## My favorites aren't being saved?
|
||||
|
||||
Try running cointop with `--clean` flag to clear the cache which might be causing the problem.
|
||||
|
||||
## How do I add a coin to my portfolio?
|
||||
|
||||
Press <kbd>e</kbd> on the highlighted coin to enter holdings and add to your portfolio.
|
||||
|
||||
## How do I edit the holdings of a coin in my portfolio?
|
||||
|
||||
Press <kbd>e</kbd> on the highlighted coin to edit the holdings.
|
||||
|
||||
## How do I remove a coin in my portfolio?
|
||||
|
||||
Press <kbd>e</kbd> on the highlighted coin to edit the holdings and set the value to any empty string (blank value). Set it to `0` if you want to keep the coin without a value.
|
||||
|
||||
## How do I view my portfolio?
|
||||
|
||||
Press <kbd>P</kbd> (Shift+p) to toggle view your portfolio.
|
||||
|
||||
## How do I save my portfolio?
|
||||
|
||||
Your portfolio is autosaved after you edit holdings. You can also press <kbd>ctrl</kbd>+<kbd>s</kbd> to manually save your portfolio holdings to the config file.
|
||||
|
||||
## I'm getting question marks or weird symbols instead of the correct characters.
|
||||
|
||||
Make sure that your terminal has the encoding set to UTF-8 and that your terminal font supports UTF-8.
|
||||
|
||||
You can also try running cointop with the following environment variables:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 TERM=xterm-256color cointop
|
||||
```
|
||||
|
||||
If you're on Windows (PowerShell, Command Prompt, or WSL), please see the [wiki](https://github.com/miguelmota/cointop/wiki/Windows-Command-Prompt-and-WSL-Font-Support) for font support instructions.
|
||||
|
||||
## How do I install Go on Ubuntu?
|
||||
|
||||
There's instructions on installing Go on Ubuntu in the [wiki](https://github.com/miguelmota/cointop/wiki/Installing-Go-on-Ubuntu).
|
||||
|
||||
## I'm getting errors installing the snap in Windows WSL.
|
||||
|
||||
Unfortunately Windows WSL doesn't support `snapd` which is required for snaps to run. See this [issue thread](https://forum.snapcraft.io/t/windows-subsystem-for-linux/216).
|
||||
|
||||
## How do I fix my GOPATH on Windows?
|
||||
|
||||
Go to Control Panel -> Under _System_ click _Edit the system environment variables_ -> then click the _Environment Variables..._ button -> check the `GOPATH` variable.
|
||||
|
||||
Check the environment variable in PowerShell:
|
||||
|
||||
```bash
|
||||
$ Get-ChildItem Env:GOPATH
|
||||
|
||||
Name Value
|
||||
---- -----
|
||||
GOPATH C:\Users\alice\go
|
||||
```
|
||||
|
||||
## How do I manually build the cointop executable on Windows?
|
||||
|
||||
Here's how to build the executable and run it:
|
||||
|
||||
```powershell
|
||||
> md C:\Users\Josem\go\src\github.com\miguelmota -ea 0
|
||||
> git clone https://github.com/miguelmota/cointop.git
|
||||
> go build -o cointop.exe main.go
|
||||
> cointop.exe
|
||||
```
|
||||
|
||||
## How do I show the help menu?
|
||||
|
||||
Press <kbd>?</kbd> to toggle the help menu. Press <kbd>q</kbd> to close help menu.
|
||||
|
||||
## I'm getting the error: `new gocui: termbox: error while reading terminfo data: EOF` or the error `termbox: error while reading terminfo data: termbox: unsupported terminal` when trying to run.
|
||||
|
||||
Try setting the environment variable `TERM=screen-256color` when starting cointop. E.g. `TERM=screen-256color cointop`
|
||||
|
||||
## Does cointop work inside an emacs shell?
|
||||
|
||||
Yes, but it's slightly buggy.
|
||||
|
||||
## My shortcut keys are messed or not correct.
|
||||
|
||||
Delete the cointop config directory and rerun cointop.
|
||||
|
||||
```bash
|
||||
rm -rf ~/.cointop
|
||||
```
|
||||
|
||||
## How do I display the chart for the highlighted coin?
|
||||
|
||||
Press <kbd>Enter</kbd> to toggle the chart for the highlighted coin.
|
||||
|
||||
## How do I change the chart date range?
|
||||
|
||||
Press <kbd>]</kbd> to cycle to the next date range.
|
||||
|
||||
Press <kbd>[</kbd> to cycle to the previous date range.
|
||||
|
||||
Press <kbd>{</kbd> to select the first date range.
|
||||
|
||||
Press <kbd>}</kbd> to selected the last date range.
|
||||
|
||||
## What chart date ranges are supported?
|
||||
|
||||
Supported date ranges are `All Time`, `YTD`, `1Y`, `6M`, `3M`, `1M`, `7D`, `3D`, `24H`.
|
||||
|
||||
<sup><sub>YTD = Year-to-date<sub></sup>
|
||||
|
||||
## How do I change the fiat currency?
|
||||
|
||||
Press <kbd>c</kbd> to show the currency convert menu, and press the corresponding key to select that as the fiat currency.
|
||||
|
||||
## Which currencies can I convert to?
|
||||
|
||||
The supported fiat currencies for conversion are `AUD`, `BRL`, `CAD`, `CFH`, `CLP`, `CNY`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `IDR`, `ILS`, `INR`, `JPY`, `KRW`, `MXN`, `MYR`, `NOK`, `NZD`, `PLN`, `PHP`, `PKR`, `RUB`, `SEK`, `SGD`, `THB`, `TRY`, `TWD`, `USD`, `VND`, and `ZAR`.
|
||||
|
||||
The supported crypto currencies for conversion are `BTC` and `ETH`.
|
||||
|
||||
Please note that some APIs may have limited support for certain conversion formats.
|
||||
|
||||
## How do I save the selected currency to convert to?
|
||||
|
||||
The selected currency conversion is autosaved. You can also press <kbd>ctrl</kbd>+<kbd>s</kbd> to manually save the selected currency conversion.
|
||||
|
||||
## What does saving do?
|
||||
|
||||
The save command (<kbd>ctrl</kbd>+<kbd>s</kbd>) saves your selected currency, selected favorite coins, and portfolio coins to the cointop config file.
|
||||
|
||||
## The data isn't refreshing!
|
||||
|
||||
The coin APIs have rate limits, so make sure to keep manual refreshes to a minimum. If you've hit the rate limit then wait about half an hour to be able to fetch the data again. Keep in mind that some coin APIs, such as CoinMarketCap, update prices every 5 minutes so constant refreshes aren't necessary.
|
||||
|
||||
## How do I quit the application?
|
||||
|
||||
Press <kbd>ctrl</kbd>+<kbd>c</kbd> to quit the application.
|
||||
|
||||
## How do I quit the open view/window?
|
||||
|
||||
Press <kbd>q</kbd> to quit the open view/window.
|
||||
|
||||
## How do I set the favorites view to be the default view?
|
||||
|
||||
In the config file, set `default_view = "favorites"`
|
||||
|
||||
## How do I set the portfolio view to be the default view?
|
||||
|
||||
In the config file, set `default_view = "portfolio"`
|
||||
|
||||
## How do I set the table view to be the default view?
|
||||
|
||||
In the config file, set `default_view = "default"`
|
||||
|
||||
## How can use a different config file other than the default?
|
||||
|
||||
Run cointop with the `--config` flag, eg `cointop --config="/path/to/config.toml"`, to use the specified file as the config.
|
||||
|
||||
## I'm getting the error `open /dev/tty: no such device or address`.
|
||||
|
||||
Usually this error occurs when cointop is running as a daemon or slave which means that there is no terminal allocated, so `/dev/tty` doesn't exist for that process. Try running it with the following environment variables:
|
||||
|
||||
```bash
|
||||
DEV_IN=/dev/stdout DEV_OUT=/dev/stdout cointop
|
||||
```
|
||||
|
||||
## I can only view the first page, why isn't the pagination is working?
|
||||
|
||||
Sometimes the coin APIs will make updates and break things. If you see this problem please [submit an issue](https://github.com/miguelmota/cointop/issues/new).
|
||||
|
||||
## How can run cointop with just the table?
|
||||
|
||||
Run cointop with the `--only-table` flag.
|
||||
|
||||
<img width="880" alt="table view only" src="https://user-images.githubusercontent.com/168240/60208658-b0387e80-980d-11e9-8819-8039fb11218f.png" />
|
||||
|
||||
## How do I toggle the table to go fullscreen?
|
||||
|
||||
Press <kbd>\\</kbd> to toggle the table fullscreen mode.
|
||||
|
||||
## How can I hide the top marketbar?
|
||||
|
||||
Run cointop with the `--hide-marketbar` flag.
|
||||
|
||||
## How can I hide the chart?
|
||||
|
||||
Run cointop with the `--hide-chart` flag.
|
||||
|
||||
## How can I hide the bottom statusbar?
|
||||
|
||||
Run cointop with the `--hide-statusbar` flag.
|
||||
|
||||
## How do I scroll the table horizontally left or right?
|
||||
|
||||
Use the keys <kbd><</kbd> to scroll the table to the left and <kbd><</kbd> to scroll the table to the right.
|
||||
|
||||
## How can I delete the cache?
|
||||
|
||||
Run `cointop clean` to delete the cache files. Cointop will generate new cache files after fetching data.
|
||||
|
||||
## How can I reset cointop?
|
||||
|
||||
Run the command `cointop reset` to delete the config files and cache. Cointop will generate a new config when starting up. You can run `cointop --reset` to reset before running cointop.
|
||||
|
||||
## Why aren't <kbd>Home</kbd> or <kbd>End</kbd> keys working for me?
|
||||
|
||||
Make sure to not manually set `TERM` in your `~/.bashrc`, `~/.zshrc`, or any where else. The `TERM` environment variable should be automatically set by your terminal, otherwise this may cause the terminal emulator to send escape codes when these keys are pressed. See [this Arch wiki](https://wiki.archlinux.org/index.php/Home_and_End_keys_not_working) for more info.
|
||||
|
||||
Use the `cointop price` command. Here are some examples:
|
||||
|
||||
## What is the size of the binary?
|
||||
|
||||
The Go build size is ~8MB but packed with UPX it's only a ~3MB executable binary.
|
||||
|
||||
## How much memory does cointop use?
|
||||
|
||||
Cointop uses ~15MB of memory so you can run it on a Raspberry Pi Zero if you wanted to (one reason why cointop was built using Go instead of Node.js or Python).
|
||||
|
||||
## How does cointop differ from *rate.sx*?
|
||||
|
||||
[rate.sx](https://rate.sx/) is great for one-off queries or fetching data for bash scripts because it doesn't require installing anything. Cointop differs in that it is interactive and also supports more currencies.
|
||||
|
||||
## How can I get just the coin price with cointop?
|
||||
|
||||
Use the `cointop price` command. Here are some examples:
|
||||
|
||||
```bash
|
||||
$ cointop price --coin ethereum
|
||||
$277.76
|
||||
|
||||
$ cointop price -c ethereum --currency btc
|
||||
Ƀ0.02814
|
||||
|
||||
$ cointop -c ethereum -f eur
|
||||
€245.51
|
||||
|
||||
$ cointop price -c ethereum -f usd --api coinmarketcap
|
||||
$276.37
|
||||
```
|
||||
|
||||
## Does cointop do mining?
|
||||
|
||||
Cointop does not do any kind of cryptocurrency mining.
|
||||
|
||||
## How can I run the cointop SSH server on port 22?
|
||||
|
||||
Port 22 is a privileged port so you need to run with `sudo`:
|
||||
|
||||
```bash
|
||||
sudo cointop server -p 22
|
||||
```
|
||||
|
||||
## Why doesn't the version number work when I install with `go get`?
|
||||
|
||||
The version number is read from the git tag during the build process but this requires the `GO111MODULE` environment variable to be set in order for Go to read the build information:
|
||||
|
||||
```bash
|
||||
GO111MODULE=on go get github.com/miguelmota/cointop
|
||||
```
|
||||
@ -0,0 +1,56 @@
|
||||
---
|
||||
title: "Getting started"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Getting started
|
||||
|
||||
After [installing](/install), run the `cointop` command to get started:
|
||||
|
||||
```bash
|
||||
$ cointop
|
||||
```
|
||||
|
||||
To see all the available commands and options run `help` flag:
|
||||
|
||||
```bash
|
||||
$ cointop --help
|
||||
```
|
||||
|
||||
### Navigation
|
||||
|
||||
- Easiest way to navigate up and down is using the arrow keys <kbd>↑</kbd> and <kbd>↓</kbd>, respectively
|
||||
- To go the next and previous pages, use <kbd>→</kbd> and <kbd>←</kbd>, respectively
|
||||
- To go to the top and bottom of the page, use <kbd>g</kbd> and <kbd>G</kbd> (Shift+g), respectively
|
||||
- Check out the rest of [shortcut](/shortcuts) keys for vim-inspired navigation
|
||||
|
||||
### Favorites
|
||||
|
||||
- To toggle a coin as a favorite, press <kbd>Space</kbd> on the highlighted coin
|
||||
- To view all your favorite coins, press <kbd>F</kbd> (Shift+f)
|
||||
- To exit out of the favorites view, press <kbd>F</kbd> (Shift+f) again or <kbd>q</kbd>
|
||||
|
||||
### Portfolio
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/168240/50439364-a78ade00-08a6-11e9-992b-af63ef21100d.png" alt="portfolio screenshot" width="880" />
|
||||
|
||||
- To add a coin to your portfolio, press <kbd>e</kbd> on the highlighted coin
|
||||
- To edit the holdings of coin in your portfolio, press <kbd>e</kbd> on the highlighted coin
|
||||
- To view your portfolio, press <kbd>P</kbd> (Shift+p)
|
||||
- To exit out of the portfolio view press, <kbd>P</kbd> (Shift+p) again or <kbd>q</kbd>
|
||||
|
||||
### Search
|
||||
|
||||
- To search for coins, press <kbd>/</kbd> then enter the search query and hit <kbd>Enter</kbd>
|
||||
|
||||
### Base Currency
|
||||
|
||||
- To change the currency, press <kbd>c</kbd> then enter the character next to the desired currency
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/168240/41806841-043c0ca6-767a-11e8-9c51-df9fc64b3b5c.png" alt="currency convert menu" width="880" />
|
||||
|
||||
### Help Menu
|
||||
|
||||
- To view the help menu, press <kbd>?</kbd>
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/168240/39569662-bcbdbcc0-4e7a-11e8-8a8f-8ff45868a8ae.png" alt="help menu" width="880" />
|
||||
@ -0,0 +1,172 @@
|
||||
---
|
||||
title: "Install"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Install
|
||||
|
||||
There are multiple ways you can install cointop depending on the platform you're on.
|
||||
|
||||
## From source (always latest and recommeded)
|
||||
|
||||
Make sure to have [go](https://golang.org/) (1.12+) installed, then do:
|
||||
|
||||
```bash
|
||||
go get github.com/miguelmota/cointop
|
||||
```
|
||||
|
||||
Make sure `$GOPATH/bin` is added to the `$PATH` variable.
|
||||
|
||||
Now you can run cointop:
|
||||
|
||||
```bash
|
||||
cointop
|
||||
```
|
||||
|
||||
## Binary (all platforms)
|
||||
|
||||
You can download the binary from the [releases](https://github.com/miguelmota/cointop/releases) page.
|
||||
|
||||
```bash
|
||||
curl -o- https://raw.githubusercontent.com/miguelmota/cointop/master/install.sh | bash
|
||||
```
|
||||
|
||||
```bash
|
||||
wget -qO- https://raw.githubusercontent.com/miguelmota/cointop/master/install.sh | bash
|
||||
```
|
||||
|
||||
## Homebrew (macOS)
|
||||
|
||||
cointop is available via [Homebrew](https://formulae.brew.sh/formula/cointop) for macOS:
|
||||
|
||||
```bash
|
||||
brew install cointop
|
||||
```
|
||||
|
||||
Run
|
||||
|
||||
```bash
|
||||
cointop
|
||||
```
|
||||
|
||||
## Snap (Ubuntu)
|
||||
|
||||
cointop is available as a [snap](https://snapcraft.io/cointop) for Linux users.
|
||||
|
||||
```bash
|
||||
sudo snap install cointop --stable
|
||||
```
|
||||
|
||||
Running snap:
|
||||
|
||||
```bash
|
||||
sudo snap run cointop
|
||||
```
|
||||
|
||||
Note: snaps don't work in Windows WSL. See this [issue thread](https://forum.snapcraft.io/t/windows-subsystem-for-linux/216).
|
||||
|
||||
## Copr (Fedora)
|
||||
|
||||
cointop is available as a [copr](https://copr.fedorainfracloud.org/coprs/miguelmota/cointop/) package.
|
||||
|
||||
First, enable the respository
|
||||
|
||||
```bash
|
||||
sudo dnf copr enable miguelmota/cointop -y
|
||||
```
|
||||
|
||||
Install cointop
|
||||
|
||||
```bash
|
||||
sudo dnf install cointop
|
||||
```
|
||||
|
||||
Run
|
||||
|
||||
```bash
|
||||
cointop
|
||||
```
|
||||
|
||||
## AUR (Arch Linux)
|
||||
|
||||
cointop is available as an [AUR](https://aur.archlinux.org/packages/cointop) package.
|
||||
|
||||
```bash
|
||||
git clone https://aur.archlinux.org/cointop.git
|
||||
cd cointop
|
||||
makepkg -si
|
||||
```
|
||||
|
||||
Using [yay](https://github.com/Jguer/yay)
|
||||
|
||||
```bash
|
||||
yay -S cointop
|
||||
```
|
||||
|
||||
## XBPS (Void Linux)
|
||||
|
||||
cointop is available as a [XBPS](https://voidlinux.org/packages/) package.
|
||||
|
||||
```bash
|
||||
sudo xbps-install -S cointop
|
||||
```
|
||||
|
||||
## Flatpak (Linux)
|
||||
|
||||
cointop is available as a [Flatpak](https://flatpak.org/) package via the [Flathub](https://flathub.org/apps/details/com.github.miguelmota.Cointop) registry.
|
||||
|
||||
Add the flathub repository (if not done so already)
|
||||
|
||||
```bash
|
||||
sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
|
||||
```
|
||||
|
||||
Install cointop flatpak
|
||||
|
||||
```bash
|
||||
sudo flatpak install flathub com.github.miguelmota.Cointop
|
||||
```
|
||||
|
||||
Run cointop flatpak
|
||||
|
||||
```bash
|
||||
flatpak run com.github.miguelmota.Cointop
|
||||
```
|
||||
|
||||
## NixOS (Linux)
|
||||
|
||||
cointop is available as a [nixpkg](https://search.nixos.org/packages?channel=unstable&show=cointop&from=0&size=30&sort=relevance&query=cointop).
|
||||
|
||||
```bash
|
||||
nix-env -iA nixpkgs.cointop
|
||||
```
|
||||
|
||||
## FreshPorts (FreeBSD / OpenBSD)
|
||||
|
||||
cointop is available as a [FreshPort](https://www.freshports.org/finance/cointop/) package.
|
||||
|
||||
```bash
|
||||
sudo pkg install cointop
|
||||
```
|
||||
|
||||
## Windows (PowerShell / WSL)
|
||||
|
||||
Install [Go](https://golang.org/doc/install) and [git](https://git-scm.com/download/win), then:
|
||||
|
||||
```powershell
|
||||
go get -u github.com/miguelmota/cointop
|
||||
```
|
||||
|
||||
You'll need additional font support for Windows. Please see the [wiki](https://github.com/miguelmota/cointop/wiki/Windows-Command-Prompt-and-WSL-Font-Support) for instructions.
|
||||
|
||||
## Docker
|
||||
|
||||
cointop is available on [Docker Hub](https://hub.docker.com/r/cointop/cointop).
|
||||
|
||||
```bash
|
||||
docker run -it cointop/cointop
|
||||
```
|
||||
|
||||
## Binaries
|
||||
|
||||
You can find pre-built binaries on the [releases](https://github.com/miguelmota/cointop/releases) page.
|
||||
@ -0,0 +1,83 @@
|
||||
---
|
||||
title: "Shortcuts"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Shortcuts
|
||||
|
||||
List of default shortcut keys:
|
||||
|
||||
Key|Action
|
||||
----|------|
|
||||
<kbd>↑</kbd>|Move up
|
||||
<kbd>↓</kbd>|Move down
|
||||
<kbd>→</kbd>|Go to next page
|
||||
<kbd>←</kbd>|Go to previous page
|
||||
<kbd>Page Up</kbd>|Jump page up
|
||||
<kbd>Page Down</kbd>|Jump page down
|
||||
<kbd>Home</kbd>|Go to first line of page
|
||||
<kbd>End</kbd>|Go to last line of page
|
||||
<kbd>Enter</kbd>|Toggle chart for highlighted coin
|
||||
<kbd>Esc</kbd>|Quit view
|
||||
<kbd>Space</kbd>|Toggle coin as favorite
|
||||
<kbd>Tab</kbd>|Move down or next page
|
||||
<kbd>Ctrl</kbd>+<kbd>c</kbd>|Quit application
|
||||
<kbd>Ctrl</kbd>+<kbd>d</kbd>|Jump page down (vim inspired)
|
||||
<kbd>Ctrl</kbd>+<kbd>f</kbd>|Search
|
||||
<kbd>Ctrl</kbd>+<kbd>n</kbd>|Go to next page
|
||||
<kbd>Ctrl</kbd>+<kbd>p</kbd>|Go to previous page
|
||||
<kbd>Ctrl</kbd>+<kbd>r</kbd>|Force refresh data
|
||||
<kbd>Ctrl</kbd>+<kbd>s</kbd>|Save config
|
||||
<kbd>Ctrl</kbd>+<kbd>u</kbd>|Jump page up (vim inspired)
|
||||
<kbd>Ctrl</kbd>+<kbd>j</kbd>|Increase chart height
|
||||
<kbd>Ctrl</kbd>+<kbd>k</kbd>|Decrease chart height
|
||||
<kbd>Alt</kbd>+<kbd>↑</kbd>|Sort current column in ascending order
|
||||
<kbd>Alt</kbd>+<kbd>↓</kbd>|Sort current column in descending order
|
||||
<kbd>Alt</kbd>+<kbd>←</kbd>|Sort column to the left
|
||||
<kbd>Alt</kbd>+<kbd>→</kbd>|Sort column to the right
|
||||
<kbd>F1</kbd>|Show help|
|
||||
<kbd>F5</kbd>|Force refresh data|
|
||||
<kbd>0</kbd>|Go to first page (vim inspired)
|
||||
<kbd>1</kbd>|Sort table by *[1] hour change*
|
||||
<kbd>2</kbd>|Sort table by *[2]4 hour change*
|
||||
<kbd>7</kbd>|Sort table by *[7] day change*
|
||||
<kbd>a</kbd>|Sort table by *[a]vailable supply*
|
||||
<kbd>b</kbd>|Sort table by *[b]alance*
|
||||
<kbd>c</kbd>|Show currency convert menu
|
||||
<kbd>C</kbd>|Show currency convert menu
|
||||
<kbd>e</kbd>|Show portfolio edit holdings menu
|
||||
<kbd>E</kbd> (Shift+e)|Show portfolio edit holdings menu
|
||||
<kbd>f</kbd>|Toggle coin as favorite
|
||||
<kbd>F</kbd> (Shift+f)|Toggle show favorites
|
||||
<kbd>g</kbd>|Go to first line of page (vim inspired)
|
||||
<kbd>G</kbd> (Shift+g)|Go to last line of page (vim inspired)
|
||||
<kbd>h</kbd>|Go to previous page (vim inspired)
|
||||
<kbd>h</kbd>|Sort table by *[h]oldings* (portfolio view only)
|
||||
<kbd>H</kbd> (Shift+h)|Go to top of table window (vim inspired)
|
||||
<kbd>j</kbd>|Move down (vim inspired)
|
||||
<kbd>k</kbd>|Move up (vim inspired)
|
||||
<kbd>l</kbd>|Go to next page (vim inspired)
|
||||
<kbd>L</kbd> (Shift+l)|Go to last line of visible table window (vim inspired)
|
||||
<kbd>m</kbd>|Sort table by *[m]arket cap*
|
||||
<kbd>M</kbd> (Shift+m)|Go to middle of visible table window (vim inspired)
|
||||
<kbd>n</kbd>|Sort table by *[n]ame*
|
||||
<kbd>o</kbd>|[o]pen link to highlighted coin (visits the API's coin page)
|
||||
<kbd>p</kbd>|Sort table by *[p]rice*
|
||||
<kbd>P</kbd> (Shift+p)|Toggle show portfolio
|
||||
<kbd>r</kbd>|Sort table by *[r]ank*
|
||||
<kbd>s</kbd>|Sort table by *[s]ymbol*
|
||||
<kbd>t</kbd>|Sort table by *[t]otal supply*
|
||||
<kbd>u</kbd>|Sort table by *last [u]pdated*
|
||||
<kbd>v</kbd>|Sort table by *24 hour [v]olume*
|
||||
<kbd>%</kbd>|Sort table by *[%]holdings*
|
||||
<kbd>q</kbd>|Quit view
|
||||
<kbd>$</kbd>|Go to last page (vim inspired)
|
||||
<kbd>?</kbd>|Show help|
|
||||
<kbd>/</kbd>|Search (vim inspired)|
|
||||
<kbd>]</kbd>|Next chart date range|
|
||||
<kbd>[</kbd>|Previous chart date range|
|
||||
<kbd>}</kbd>|Last chart date range|
|
||||
<kbd>{</kbd>|First chart date range|
|
||||
<kbd>\></kbd>|Go to next page|
|
||||
<kbd>\<</kbd>|Go to previous page|
|
||||
<kbd>\\</kbd>|Toggle table fullscreen|
|
||||
@ -0,0 +1,20 @@
|
||||
---
|
||||
title: "Social"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Social
|
||||
|
||||
- Follow on twitter [@cointop](https://twitter.com/cointop)
|
||||
- Chat on [Telegram](https://telegram.me/cointopsh)
|
||||
- Discuss on [Discord](https://discord.gg/pUVGy7ECGg)
|
||||
|
||||
## Mentioned in
|
||||
|
||||
Cointop has been mentioned in:
|
||||
|
||||
- [Ubuntu Twitter](https://twitter.com/ubuntu/status/985947962311311360?lang=en)
|
||||
- [Ubuntu Podcast](https://ubuntupodcast.org/2018/04/12/s11e06-six-feet-over-it/)
|
||||
- [Ubuntu Facebook](https://www.facebook.com/ubuntulinux/photos/coin-tracking-for-hackers-cointop-is-a-fast-and-easy-to-use-command-line-applica/10156147393253592/)
|
||||
- [Terminals Are Sexy](https://github.com/k4m4/terminals-are-sexy#tools-and-plugins)
|
||||
- [The Changelog News](https://changelog.com/news/cointop-coin-tracking-for-hackers-rAzZ)
|
||||
@ -0,0 +1,36 @@
|
||||
---
|
||||
title: "SSH"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# SSH Server
|
||||
|
||||
Run SSH server:
|
||||
|
||||
```bash
|
||||
cointop server -p 2222
|
||||
```
|
||||
|
||||
SSH into server to see cointop:
|
||||
|
||||
```bash
|
||||
ssh localhost -p 2222
|
||||
```
|
||||
|
||||
SSH demo:
|
||||
|
||||
```bash
|
||||
ssh cointop.sh
|
||||
```
|
||||
|
||||
Passing arguments to SSH server:
|
||||
|
||||
```bash
|
||||
ssh cointop.sh -t cointop --colorscheme synthwave
|
||||
```
|
||||
|
||||
Using docker to run SSH server:
|
||||
|
||||
```bash
|
||||
docker run -p 2222:22 -v ~/.ssh:/keys --entrypoint cointop -it cointop/cointop server -k /keys/id_rsa
|
||||
```
|
||||
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: "Tip Jar"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Tip Jar
|
||||
|
||||
[](https://www.blockchain.com/btc/address/3KdMW53vUMLPEC33xhHAUx4EFtvmXQF8Kf) `3KdMW53vUMLPEC33xhHAUx4EFtvmXQF8Kf`
|
||||
|
||||
[](https://etherscan.io/address/0x0072cdd7c3d9963ba69506ECf50e16E963B35bb1) `0x0072cdd7c3d9963ba69506ECf50e16E963B35bb1`
|
||||
|
||||
Thank you for tips! 🙏
|
||||
@ -0,0 +1,59 @@
|
||||
---
|
||||
title: "Update"
|
||||
date: 2020-01-01T00:00:00-00:00
|
||||
draft: false
|
||||
---
|
||||
# Update
|
||||
|
||||
## Go
|
||||
|
||||
To update make sure to use the `-u` flag if installed via Go.
|
||||
|
||||
```bash
|
||||
go get -u github.com/miguelmota/cointop
|
||||
```
|
||||
|
||||
## Homebrew (macOS)
|
||||
|
||||
```bash
|
||||
brew uninstall cointop && brew install cointop
|
||||
```
|
||||
|
||||
## Snap (Ubuntu)
|
||||
|
||||
Use the `refresh` command to update snap.
|
||||
|
||||
```bash
|
||||
sudo snap refresh cointop
|
||||
```
|
||||
|
||||
## Copr (Fedora)
|
||||
|
||||
```bash
|
||||
sudo dnf update cointop
|
||||
```
|
||||
|
||||
## AUR (Arch Linux)
|
||||
|
||||
```bash
|
||||
yay -S cointop
|
||||
```
|
||||
|
||||
## XBPS (Void Linux)
|
||||
|
||||
```bash
|
||||
sudo xbps-install -Su cointop
|
||||
```
|
||||
|
||||
## Flatpak (Linux)
|
||||
|
||||
```bash
|
||||
sudo flatpak uninstall com.github.miguelmota.Cointop
|
||||
sudo flatpak install flathub com.github.miguelmota.Cointop
|
||||
```
|
||||
|
||||
## NixOS (Linux)
|
||||
|
||||
```bash
|
||||
nix-env -uA nixpkgs.cointop
|
||||
```
|
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
|
||||
{"Target":"book.min.a3a6cbe0353ff1ec2abe178acc17154b415479501c332f91031ab759b49acbef.css","MediaType":"text/css","Data":{"Integrity":"sha256-o6bL4DU/8ewqvheKzBcVS0FUeVAcMy+RAxq3WbSay+8="}}
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1 @@
|
||||
{"Target":"main.css","MediaType":"text/css","Data":{}}
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1 @@
|
||||
{"Target":"scss/main.css","MediaType":"text/css","Data":{}}
|
||||
@ -0,0 +1,3 @@
|
||||
public/
|
||||
exampleSite/public/
|
||||
.DS_Store
|
||||
@ -0,0 +1,20 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Alex Shpak
|
||||
|
||||
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.
|
||||
@ -0,0 +1,313 @@
|
||||
# Hugo Book Theme
|
||||
|
||||
[](https://gohugo.io)
|
||||
[](LICENSE)
|
||||
|
||||
|
||||
### [Hugo](https://gohugo.io) documentation theme as simple as plain book
|
||||
|
||||
|
||||
|
||||
- [Features](#features)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Menu](#menu)
|
||||
- [Blog](#blog)
|
||||
- [Configuration](#configuration)
|
||||
- [Shortcodes](#shortcodes)
|
||||
- [Versioning](#versioning)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Features
|
||||
|
||||
- Clean simple design
|
||||
- Light and Mobile-Friendly
|
||||
- Multi-language support
|
||||
- Customisable
|
||||
- Zero initial configuration
|
||||
- Handy shortcodes
|
||||
- Comments support
|
||||
- Simple blog and taxonomy
|
||||
- Primary features work without JavaScript
|
||||
- Dark Mode
|
||||
|
||||
## Requirements
|
||||
|
||||
- Hugo 0.68 or higher
|
||||
- Hugo extended version, read more [here](https://gohugo.io/news/0.48-relnotes/)
|
||||
|
||||
## Installation
|
||||
|
||||
Navigate to your hugo project root and run:
|
||||
|
||||
```
|
||||
git submodule add https://github.com/alex-shpak/hugo-book themes/book
|
||||
```
|
||||
|
||||
Then run hugo (or set `theme = "book"`/`theme: book` in configuration file)
|
||||
|
||||
```
|
||||
hugo server --minify --theme book
|
||||
```
|
||||
|
||||
### Creating site from scratch
|
||||
|
||||
Below is an example on how to create a new site from scratch:
|
||||
|
||||
```sh
|
||||
hugo new site mydocs; cd mydocs
|
||||
git init
|
||||
git submodule add https://github.com/alex-shpak/hugo-book themes/book
|
||||
cp -R themes/book/exampleSite/content .
|
||||
```
|
||||
|
||||
```sh
|
||||
hugo server --minify --theme book
|
||||
```
|
||||
|
||||
## Menu
|
||||
|
||||
### File tree menu (default)
|
||||
|
||||
By default, the theme will render pages from the `content/docs` section as a menu in a tree structure.
|
||||
You can set `title` and `weight` in the front matter of pages to adjust the order and titles in the menu.
|
||||
|
||||
### Leaf bundle menu
|
||||
|
||||
You can also use leaf bundle and the content of its `index.md` file as menu.
|
||||
Given you have the following file structure:
|
||||
|
||||
```
|
||||
├── content
|
||||
│ ├── docs
|
||||
│ │ ├── page-one.md
|
||||
│ │ └── page-two.md
|
||||
│ └── posts
|
||||
│ ├── post-one.md
|
||||
│ └── post-two.md
|
||||
```
|
||||
|
||||
Create a file `content/menu/index.md` with the content:
|
||||
|
||||
```md
|
||||
+++
|
||||
headless = true
|
||||
+++
|
||||
|
||||
- [Book Example]({{< relref "/docs/" >}})
|
||||
- [Page One]({{< relref "/docs/page-one" >}})
|
||||
- [Page Two]({{< relref "/docs/page-two" >}})
|
||||
- [Blog]({{< relref "/posts" >}})
|
||||
```
|
||||
|
||||
And Enable it by setting `BookMenuBundle: /menu` in Site configuration.
|
||||
|
||||
- [Example menu](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/content/menu/index.md)
|
||||
- [Example config file](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yaml)
|
||||
- [Leaf bundles](https://gohugo.io/content-management/page-bundles/)
|
||||
|
||||
## Blog
|
||||
|
||||
A simple blog is supported in the section `posts`.
|
||||
A blog is not the primary usecase of this theme, so it has only minimal features.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Site Configuration
|
||||
|
||||
There are a few configuration options that you can add to your `config.toml` file.
|
||||
You can also see the `yaml` example [here](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yaml).
|
||||
|
||||
```toml
|
||||
# (Optional) Set Google Analytics if you use it to track your website.
|
||||
# Always put it on the top of the configuration file, otherwise it won't work
|
||||
googleAnalytics = "UA-XXXXXXXXX-X"
|
||||
|
||||
# (Optional) If you provide a Disqus shortname, comments will be enabled on
|
||||
# all pages.
|
||||
disqusShortname = "my-site"
|
||||
|
||||
# (Optional) Set this to true if you use capital letters in file names
|
||||
disablePathToLower = true
|
||||
|
||||
# (Optional) Set this to true to enable 'Last Modified by' date and git author
|
||||
# information on 'doc' type pages.
|
||||
enableGitInfo = true
|
||||
|
||||
# (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy.
|
||||
# You can remove related files with config below
|
||||
disableKinds = ['taxonomy', 'taxonomyTerm']
|
||||
|
||||
[params]
|
||||
# (Optional, default light) Sets color theme: light, dark or auto.
|
||||
# Theme 'auto' switches between dark and light modes based on browser/os preferences
|
||||
BookTheme = 'light'
|
||||
|
||||
# (Optional, default true) Controls table of contents visibility on right side of pages.
|
||||
# Start and end levels can be controlled with markup.tableOfContents setting.
|
||||
# You can also specify this parameter per page in front matter.
|
||||
BookToC = true
|
||||
|
||||
# (Optional, default none) Set the path to a logo for the book. If the logo is
|
||||
# /static/logo.png then the path would be 'logo.png'
|
||||
BookLogo = 'logo.png'
|
||||
|
||||
# (Optional, default none) Set leaf bundle to render as side menu
|
||||
# When not specified file structure and weights will be used
|
||||
BookMenuBundle = '/menu'
|
||||
|
||||
# (Optional, default docs) Specify section of content to render as menu
|
||||
# You can also set value to "*" to render all sections to menu
|
||||
BookSection = 'docs'
|
||||
|
||||
# Set source repository location.
|
||||
# Used for 'Last Modified' and 'Edit this page' links.
|
||||
BookRepo = 'https://github.com/alex-shpak/hugo-book'
|
||||
|
||||
# Enable 'Edit this page' links for 'doc' page type.
|
||||
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
|
||||
# Path must point to the site directory.
|
||||
BookEditPath = 'edit/master/exampleSite'
|
||||
|
||||
# (Optional, default January 2, 2006) Configure the date format used on the pages
|
||||
# - In git information
|
||||
# - In blog posts
|
||||
BookDateFormat = 'Jan 2, 2006'
|
||||
|
||||
# (Optional, default true) Enables search function with flexsearch,
|
||||
# Index is built on fly, therefore it might slowdown your website.
|
||||
# Configuration for indexing can be adjusted in i18n folder per language.
|
||||
BookSearch = true
|
||||
|
||||
# (Optional, default true) Enables comments template on pages
|
||||
# By default partials/docs/comments.html includes Disqus template
|
||||
# See https://gohugo.io/content-management/comments/#configure-disqus
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments = true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
||||
# Theme will print warning if page referenced in markdown does not exists.
|
||||
BookPortableLinks = true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
|
||||
BookServiceWorker = true
|
||||
```
|
||||
|
||||
### Multi-Language Support
|
||||
|
||||
Theme supports Hugo's [multilingual mode](https://gohugo.io/content-management/multilingual/), just follow configuration guide there. You can also tweak search indexing configuration per language in `i18n` folder.
|
||||
|
||||
### Page Configuration
|
||||
|
||||
You can specify additional params in the front matter of individual pages:
|
||||
|
||||
```toml
|
||||
# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'
|
||||
type = 'docs'
|
||||
|
||||
# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
|
||||
weight = 10
|
||||
|
||||
# (Optional) Set to 'true' to mark page as flat section in file-tree menu (if BookMenuBundle not set)
|
||||
bookFlatSection = false
|
||||
|
||||
# (Optional) Set to hide nested sections or pages at that level. Works only with file-tree menu mode
|
||||
bookCollapseSection = true
|
||||
|
||||
# (Optional) Set true to hide page or section from side menu (if BookMenuBundle not set)
|
||||
bookHidden = false
|
||||
|
||||
# (Optional) Set 'false' to hide ToC from page
|
||||
bookToC = true
|
||||
|
||||
# (Optional) If you have enabled BookComments for the site, you can disable it for specific pages.
|
||||
bookComments = true
|
||||
|
||||
# (Optional) Set to 'false' to exclude page from search index.
|
||||
bookSearchExclude = true
|
||||
```
|
||||
|
||||
### Partials
|
||||
|
||||
There are few empty partials you can override in `layouts/partials/`
|
||||
|
||||
| Partial | Placement |
|
||||
| -------------------------------------------------- | ------------------------------------------- |
|
||||
| `layouts/partials/docs/inject/head.html` | Before closing `<head>` tag |
|
||||
| `layouts/partials/docs/inject/body.html` | Before closing `<body>` tag |
|
||||
| `layouts/partials/docs/inject/footer.html` | After page footer content |
|
||||
| `layouts/partials/docs/inject/menu-before.html` | At the beginning of `<nav>` menu block |
|
||||
| `layouts/partials/docs/inject/menu-after.html` | At the end of `<nav>` menu block |
|
||||
| `layouts/partials/docs/inject/content-before.html` | Before page content |
|
||||
| `layouts/partials/docs/inject/content-after.html` | After page content |
|
||||
| `layouts/partials/docs/inject/toc-before.html` | At the beginning of table of contents block |
|
||||
| `layouts/partials/docs/inject/toc-after.html` | At the end of table of contents block |
|
||||
|
||||
### Extra Customisation
|
||||
|
||||
| File | Description |
|
||||
| ------------------------ | ------------------------------------------------------------------------------------- |
|
||||
| `static/favicon.png` | Override default favicon |
|
||||
| `assets/_custom.scss` | Customise or override scss styles |
|
||||
| `assets/_variables.scss` | Override default SCSS variables |
|
||||
| `assets/_fonts.scss` | Replace default font with custom fonts (e.g. local files or remote like google fonts) |
|
||||
|
||||
### Plugins
|
||||
|
||||
There are a few features implemented as plugable `scss` styles. Usually these are features that don't make it to the core but can still be useful.
|
||||
|
||||
| Plugin | Description |
|
||||
| --------------------------------- | ----------------------------------------------------------- |
|
||||
| `assets/plugins/_numbered.scss` | Makes headings in markdown numbered, e.g. `1.1`, `1.2` |
|
||||
| `assets/plugins/_scrollbars.scss` | Overrides scrollbar styles to look similar across platforms |
|
||||
|
||||
To enable plugins, add `@import "plugins/{name}";` to `assets/_custom.scss` in your website root.
|
||||
|
||||
### Hugo Internal Templates
|
||||
|
||||
There are a few hugo templates inserted in `<head>`
|
||||
|
||||
- [Google Analytics](https://gohugo.io/templates/internal/#google-analytics)
|
||||
- [Open Graph](https://gohugo.io/templates/internal/#open-graph)
|
||||
|
||||
## Shortcodes
|
||||
|
||||
- [Buttons](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/buttons/)
|
||||
- [Columns](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/columns/)
|
||||
- [Expand](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/expand/)
|
||||
- [Hints](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/hints/)
|
||||
- [KaTeX](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/katex/)
|
||||
- [Mermaid](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/mermaid/)
|
||||
- [Tabs](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/tabs/)
|
||||
|
||||
By default, Goldmark trims unsafe outputs which might prevent some shortcodes from rendering. It is recommended to set `markup.goldmark.renderer.unsafe=true` if you encounter problems.
|
||||
|
||||
```toml
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
```
|
||||
|
||||
If you are using `config.yaml` or `config.json`, consult the [configuration markup](https://gohugo.io/getting-started/configuration-markup/)
|
||||
|
||||
## Versioning
|
||||
|
||||
This theme follows a simple incremental versioning. e.g. `v1`, `v2` and so on. There might be breaking changes between versions.
|
||||
|
||||
If you want lower maintenance, use one of the released versions. If you want to live on the bleeding edge of changes, you can use the `master` branch and update your website when needed.
|
||||
|
||||
## Contributing
|
||||
|
||||
### [Extra credits to contributors](https://github.com/alex-shpak/hugo-book/graphs/contributors)
|
||||
|
||||
Contributions are welcome and I will review and consider pull requests.
|
||||
Primary goals are:
|
||||
|
||||
- Keep it simple.
|
||||
- Keep minimal (or zero) default configuration.
|
||||
- Avoid interference with user-defined layouts.
|
||||
- Avoid using JS if it can be solved by CSS.
|
||||
|
||||
Feel free to open issues if you find missing configuration or customisation options.
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: "{{ .Name | humanize | title }}"
|
||||
weight: 1
|
||||
# bookFlatSection: false
|
||||
# bookToc: true
|
||||
# bookHidden: false
|
||||
# bookCollapseSection: false
|
||||
# bookComments: true
|
||||
---
|
||||
@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
---
|
||||
@ -0,0 +1,4 @@
|
||||
/* You can add custom styles here. */
|
||||
|
||||
// @import "plugins/numbered";
|
||||
|
||||
@ -0,0 +1,66 @@
|
||||
// Used in layout
|
||||
$padding-1: 1px !default;
|
||||
$padding-4: 0.25rem !default;
|
||||
$padding-8: 0.5rem !default;
|
||||
$padding-16: 1rem !default;
|
||||
|
||||
$font-size-base: 16px !default;
|
||||
$font-size-12: 0.75rem !default;
|
||||
$font-size-14: 0.875rem !default;
|
||||
$font-size-16: 1rem !default;
|
||||
|
||||
$border-radius: $padding-4 !default;
|
||||
|
||||
$body-font-weight: normal !default;
|
||||
|
||||
$body-min-width: 20rem !default;
|
||||
$container-max-width: 80rem !default;
|
||||
|
||||
$header-height: 3.5rem !default;
|
||||
$menu-width: 16rem !default;
|
||||
$toc-width: 16rem !default;
|
||||
|
||||
$mobile-breakpoint: $menu-width + $body-min-width * 1.2 + $toc-width !default;
|
||||
|
||||
$hint-colors: (
|
||||
info: #6bf,
|
||||
warning: #fd6,
|
||||
danger: #f66,
|
||||
) !default;
|
||||
|
||||
// Themes
|
||||
@mixin theme-light {
|
||||
--gray-100: #f8f9fa;
|
||||
--gray-200: #e9ecef;
|
||||
--gray-500: #adb5bd;
|
||||
|
||||
--color-link: #0055bb;
|
||||
--color-visited-link: #8440f1;
|
||||
|
||||
--body-background: white;
|
||||
--body-font-color: black;
|
||||
|
||||
--icon-filter: none;
|
||||
|
||||
--hint-color-info: #6bf;
|
||||
--hint-color-warning: #fd6;
|
||||
--hint-color-danger: #f66;
|
||||
}
|
||||
|
||||
@mixin theme-dark {
|
||||
--gray-100: rgba(255, 255, 255, 0.1);
|
||||
--gray-200: rgba(255, 255, 255, 0.2);
|
||||
--gray-500: rgba(255, 255, 255, 0.5);
|
||||
|
||||
--color-link: #84b2ff;
|
||||
--color-visited-link: #b88dff;
|
||||
|
||||
--body-background: #343a40;
|
||||
--body-font-color: #e9ecef;
|
||||
|
||||
--icon-filter: brightness(0) invert(1);
|
||||
|
||||
--hint-color-info: #6bf;
|
||||
--hint-color-warning: #fd6;
|
||||
--hint-color-danger: #f66;
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
/* roboto-300italic - latin */
|
||||
@font-face {
|
||||
font-family: 'Roboto';
|
||||
font-style: italic;
|
||||
font-weight: 300;
|
||||
font-display: swap;
|
||||
src: local('Roboto Light Italic'), local('Roboto-LightItalic'),
|
||||
url('fonts/roboto-v19-latin-300italic.woff2') format('woff2'), /* Chrome 26+, Opera 23+, Firefox 39+ */
|
||||
url('fonts/roboto-v19-latin-300italic.woff') format('woff'); /* Chrome 6+, Firefox 3.6+, IE 9+, Safari 5.1+ */
|
||||
}
|
||||
/* roboto-regular - latin */
|
||||
@font-face {
|
||||
font-family: 'Roboto';
|
||||
font-style: normal;
|
||||
font-weight: 400;
|
||||
font-display: swap;
|
||||
src: local('Roboto'), local('Roboto-Regular'),
|
||||
url('fonts/roboto-v19-latin-regular.woff2') format('woff2'), /* Chrome 26+, Opera 23+, Firefox 39+ */
|
||||
url('fonts/roboto-v19-latin-regular.woff') format('woff'); /* Chrome 6+, Firefox 3.6+, IE 9+, Safari 5.1+ */
|
||||
}
|
||||
/* roboto-700 - latin */
|
||||
@font-face {
|
||||
font-family: 'Roboto';
|
||||
font-style: normal;
|
||||
font-weight: 700;
|
||||
font-display: swap;
|
||||
src: local('Roboto Bold'), local('Roboto-Bold'),
|
||||
url('fonts/roboto-v19-latin-700.woff2') format('woff2'), /* Chrome 26+, Opera 23+, Firefox 39+ */
|
||||
url('fonts/roboto-v19-latin-700.woff') format('woff'); /* Chrome 6+, Firefox 3.6+, IE 9+, Safari 5.1+ */
|
||||
}
|
||||
|
||||
/* roboto-mono-regular - latin */
|
||||
@font-face {
|
||||
font-family: 'Roboto Mono';
|
||||
font-style: normal;
|
||||
font-weight: 400;
|
||||
font-display: swap;
|
||||
src: local('Roboto Mono'), local('RobotoMono-Regular'),
|
||||
url('fonts/roboto-mono-v6-latin-regular.woff2') format('woff2'), /* Chrome 26+, Opera 23+, Firefox 39+ */
|
||||
url('fonts/roboto-mono-v6-latin-regular.woff') format('woff'); /* Chrome 6+, Firefox 3.6+, IE 9+, Safari 5.1+ */
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: 'Roboto Mono', monospace;
|
||||
}
|
||||
@ -0,0 +1,384 @@
|
||||
html {
|
||||
font-size: $font-size-base;
|
||||
scroll-behavior: smooth;
|
||||
touch-action: manipulation;
|
||||
}
|
||||
|
||||
body {
|
||||
min-width: $body-min-width;
|
||||
color: var(--body-font-color);
|
||||
background: var(--body-background);
|
||||
|
||||
letter-spacing: 0.33px;
|
||||
font-weight: $body-font-weight;
|
||||
text-rendering: optimizeLegibility;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
|
||||
box-sizing: border-box;
|
||||
* {
|
||||
box-sizing: inherit;
|
||||
}
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5 {
|
||||
font-weight: $body-font-weight;
|
||||
}
|
||||
|
||||
a {
|
||||
text-decoration: none;
|
||||
color: var(--color-link);
|
||||
}
|
||||
|
||||
img {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
:focus {
|
||||
@include outline;
|
||||
}
|
||||
|
||||
aside nav ul {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
list-style: none;
|
||||
|
||||
li {
|
||||
margin: 1em 0;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
a {
|
||||
display: block;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
opacity: 0.5;
|
||||
}
|
||||
|
||||
ul {
|
||||
padding-inline-start: $padding-16;
|
||||
}
|
||||
}
|
||||
|
||||
ul.pagination {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
list-style-type: none;
|
||||
|
||||
.page-item a {
|
||||
padding: $padding-16;
|
||||
}
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: $container-max-width;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
.book-icon {
|
||||
filter: var(--icon-filter);
|
||||
}
|
||||
|
||||
.book-brand {
|
||||
margin-top: 0;
|
||||
|
||||
img {
|
||||
height: 1.5em;
|
||||
width: auto;
|
||||
vertical-align: middle;
|
||||
margin-inline-end: $padding-8;
|
||||
}
|
||||
}
|
||||
|
||||
.book-menu {
|
||||
flex: 0 0 $menu-width;
|
||||
font-size: $font-size-14;
|
||||
|
||||
.book-menu-content {
|
||||
width: $menu-width;
|
||||
padding: $padding-16;
|
||||
background: var(--body-background);
|
||||
|
||||
@include fixed;
|
||||
}
|
||||
|
||||
a,
|
||||
label {
|
||||
color: inherit;
|
||||
cursor: pointer;
|
||||
word-wrap: break-word;
|
||||
}
|
||||
|
||||
a.active {
|
||||
color: var(--color-link);
|
||||
}
|
||||
|
||||
input.toggle + label + ul {
|
||||
display: none;
|
||||
}
|
||||
|
||||
input.toggle:checked + label + ul {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
|
||||
.book-section-flat {
|
||||
margin-bottom: $padding-16 * 2;
|
||||
|
||||
&:not(:first-child) {
|
||||
margin-top: $padding-16 * 2;
|
||||
}
|
||||
|
||||
> a,
|
||||
> span,
|
||||
> label {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
> ul {
|
||||
padding-inline-start: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.book-page {
|
||||
min-width: $body-min-width;
|
||||
flex-grow: 1;
|
||||
padding: $padding-16;
|
||||
}
|
||||
|
||||
.book-post {
|
||||
margin-bottom: $padding-16 * 3;
|
||||
}
|
||||
|
||||
.book-header {
|
||||
display: none;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
label {
|
||||
line-height: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.book-search {
|
||||
position: relative;
|
||||
margin: $padding-16 0;
|
||||
border-bottom: 1px solid transparent;
|
||||
|
||||
input {
|
||||
width: 100%;
|
||||
padding: $padding-8;
|
||||
|
||||
border: 0;
|
||||
border-radius: $border-radius;
|
||||
|
||||
background: var(--gray-100);
|
||||
color: var(--body-font-color);
|
||||
|
||||
&:required + .book-search-spinner {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
|
||||
.book-search-spinner {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
margin: $padding-8;
|
||||
margin-inline-start: calc(100% - #{$padding-16 + $padding-8});
|
||||
|
||||
width: $padding-16;
|
||||
height: $padding-16;
|
||||
|
||||
border: $padding-1 solid transparent;
|
||||
border-top-color: var(--body-font-color);
|
||||
border-radius: 50%;
|
||||
|
||||
@include spin(1s);
|
||||
}
|
||||
|
||||
small {
|
||||
opacity: 0.5;
|
||||
}
|
||||
}
|
||||
|
||||
.book-toc {
|
||||
flex: 0 0 $toc-width;
|
||||
font-size: $font-size-12;
|
||||
|
||||
.book-toc-content {
|
||||
width: $toc-width;
|
||||
padding: $padding-16;
|
||||
|
||||
@include fixed;
|
||||
}
|
||||
|
||||
img {
|
||||
height: 1em;
|
||||
}
|
||||
|
||||
nav > ul > li:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.book-footer {
|
||||
padding-top: $padding-16;
|
||||
font-size: $font-size-14;
|
||||
|
||||
img {
|
||||
height: 1em;
|
||||
margin-inline-end: $padding-8;
|
||||
}
|
||||
}
|
||||
|
||||
.book-comments {
|
||||
margin-top: $padding-16;
|
||||
}
|
||||
|
||||
.book-languages {
|
||||
position: relative;
|
||||
overflow: visible;
|
||||
|
||||
padding: $padding-16;
|
||||
margin: -$padding-16;
|
||||
|
||||
ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
list-style: none;
|
||||
|
||||
li {
|
||||
white-space: nowrap;
|
||||
cursor: pointer;
|
||||
}
|
||||
}
|
||||
|
||||
&:hover,
|
||||
&:focus,
|
||||
&:focus-within {
|
||||
.book-languages-list {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
|
||||
.book-languages-list {
|
||||
display: none;
|
||||
|
||||
position: absolute;
|
||||
bottom: 100%;
|
||||
left: 0;
|
||||
padding: $padding-8 0;
|
||||
|
||||
background: var(--body-background);
|
||||
box-shadow: 0 0 $padding-4 rgba(0, 0, 0, 0.1);
|
||||
|
||||
li img {
|
||||
opacity: 0.25;
|
||||
}
|
||||
|
||||
li.active img,
|
||||
li:hover img {
|
||||
opacity: initial;
|
||||
}
|
||||
|
||||
a {
|
||||
color: inherit;
|
||||
padding: $padding-8 $padding-16;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.book-home {
|
||||
padding: $padding-16;
|
||||
}
|
||||
|
||||
// Responsive styles
|
||||
.book-menu-content,
|
||||
.book-toc-content,
|
||||
.book-page,
|
||||
.book-header aside,
|
||||
.markdown {
|
||||
transition: 0.2s ease-in-out;
|
||||
transition-property: transform, margin, opacity, visibility;
|
||||
will-change: transform, margin, opacity;
|
||||
}
|
||||
|
||||
@media screen and (max-width: $mobile-breakpoint) {
|
||||
#menu-control,
|
||||
#toc-control {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.book-menu {
|
||||
visibility: hidden;
|
||||
margin-inline-start: -$menu-width;
|
||||
font-size: $font-size-base;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
.book-toc {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.book-header {
|
||||
display: block;
|
||||
}
|
||||
|
||||
#menu-control:focus ~ main label[for="menu-control"] {
|
||||
@include outline;
|
||||
}
|
||||
|
||||
#menu-control:checked ~ main {
|
||||
.book-menu {
|
||||
visibility: initial;
|
||||
}
|
||||
|
||||
.book-menu .book-menu-content {
|
||||
transform: translateX($menu-width);
|
||||
box-shadow: 0 0 $padding-8 rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.book-page {
|
||||
opacity: 0.25;
|
||||
}
|
||||
|
||||
.book-menu-overlay {
|
||||
display: block;
|
||||
position: absolute;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
}
|
||||
}
|
||||
|
||||
#toc-control:focus ~ main label[for="toc-control"] {
|
||||
@include outline;
|
||||
}
|
||||
|
||||
#toc-control:checked ~ main {
|
||||
.book-header aside {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
|
||||
//for RTL support
|
||||
body[dir="rtl"] #menu-control:checked + main {
|
||||
.book-menu .book-menu-content {
|
||||
transform: translateX(-$menu-width);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Extra space for big screens
|
||||
@media screen and (min-width: $container-max-width) {
|
||||
.book-page,
|
||||
.book-menu .book-menu-content,
|
||||
.book-toc .book-toc-content {
|
||||
padding: $padding-16 * 2 $padding-16;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,192 @@
|
||||
@import "variables";
|
||||
|
||||
.markdown {
|
||||
line-height: 1.6;
|
||||
|
||||
// remove padding at the beginning of page
|
||||
> :first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
font-weight: normal;
|
||||
line-height: 1.4;
|
||||
margin-top: 1.5em;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
a.anchor {
|
||||
opacity: 0;
|
||||
font-size: 0.75em;
|
||||
vertical-align: middle;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
&:hover a.anchor,
|
||||
a.anchor:focus {
|
||||
opacity: initial;
|
||||
}
|
||||
}
|
||||
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
h5 {
|
||||
font-size: 0.875em;
|
||||
}
|
||||
|
||||
h6 {
|
||||
font-size: 0.75em;
|
||||
}
|
||||
|
||||
b,
|
||||
optgroup,
|
||||
strong {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
a {
|
||||
text-decoration: none;
|
||||
|
||||
&:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
&:visited {
|
||||
color: var(--color-visited-link);
|
||||
}
|
||||
}
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
code,
|
||||
kbd {
|
||||
padding: 0 $padding-4;
|
||||
background: var(--gray-200);
|
||||
border-radius: $border-radius;
|
||||
font-size: 0.875em;
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: $padding-16;
|
||||
background: var(--gray-100);
|
||||
border-radius: $border-radius;
|
||||
overflow-x: auto;
|
||||
|
||||
code {
|
||||
padding: 0;
|
||||
background: none;
|
||||
}
|
||||
}
|
||||
|
||||
blockquote {
|
||||
margin: $padding-16 0;
|
||||
padding: $padding-8 $padding-16 $padding-8 ($padding-16 - $padding-4); //to keep total left space 16dp
|
||||
|
||||
border-inline-start: $padding-4 solid var(--gray-200);
|
||||
border-radius: $border-radius;
|
||||
|
||||
:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
|
||||
table {
|
||||
overflow: auto;
|
||||
display: block;
|
||||
border-spacing: 0;
|
||||
border-collapse: collapse;
|
||||
margin-top: $padding-16;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
tr th,
|
||||
tr td {
|
||||
padding: $padding-8 $padding-16;
|
||||
border: $padding-1 solid var(--gray-200);
|
||||
}
|
||||
|
||||
tr:nth-child(2n) {
|
||||
background: var(--gray-100);
|
||||
}
|
||||
}
|
||||
|
||||
hr {
|
||||
height: $padding-1;
|
||||
border: none;
|
||||
background: var(--gray-200);
|
||||
}
|
||||
|
||||
ul,
|
||||
ol {
|
||||
padding-inline-start: $padding-16 * 2;
|
||||
}
|
||||
|
||||
dl {
|
||||
dt {
|
||||
font-weight: bolder;
|
||||
margin-top: $padding-16;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-inline-start: $padding-16;
|
||||
margin-bottom: $padding-16;
|
||||
}
|
||||
}
|
||||
|
||||
// Special case for highlighted code with line numbers
|
||||
.highlight table tr {
|
||||
td:nth-child(1) pre {
|
||||
margin: 0;
|
||||
padding-inline-end: 0;
|
||||
}
|
||||
td:nth-child(2) pre {
|
||||
margin: 0;
|
||||
padding-inline-start: 0;
|
||||
}
|
||||
}
|
||||
|
||||
details {
|
||||
padding: $padding-16;
|
||||
border: $padding-1 solid var(--gray-200);
|
||||
border-radius: $border-radius;
|
||||
|
||||
summary {
|
||||
line-height: 1;
|
||||
padding: $padding-16;
|
||||
margin: -$padding-16;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
&[open] summary {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
|
||||
figure {
|
||||
margin: $padding-16 0;
|
||||
figcaption p {
|
||||
margin-top: 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.markdown-inner {
|
||||
// Util class to remove extra margin in nested markdown content
|
||||
> :first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
> :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,17 @@
|
||||
@media print {
|
||||
.book-menu,
|
||||
.book-footer,
|
||||
.book-toc {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.book-header,
|
||||
.book-header aside {
|
||||
display: block;
|
||||
}
|
||||
|
||||
main {
|
||||
// Fix for https://bugzilla.mozilla.org/show_bug.cgi?id=939897
|
||||
display: block !important;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,104 @@
|
||||
.markdown {
|
||||
// {{< expand "Label" "icon" >}}
|
||||
.book-expand {
|
||||
margin-top: $padding-16;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
border: $padding-1 solid var(--gray-200);
|
||||
border-radius: $border-radius;
|
||||
|
||||
overflow: hidden;
|
||||
|
||||
.book-expand-head {
|
||||
background: var(--gray-100);
|
||||
padding: $padding-8 $padding-16;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.book-expand-content {
|
||||
display: none;
|
||||
padding: $padding-16;
|
||||
}
|
||||
|
||||
input[type="checkbox"]:checked + .book-expand-content {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
|
||||
// {{< tabs >}}
|
||||
.book-tabs {
|
||||
margin-top: $padding-16;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
border: $padding-1 solid var(--gray-200);
|
||||
border-radius: $border-radius;
|
||||
|
||||
overflow: hidden;
|
||||
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
|
||||
label {
|
||||
display: inline-block;
|
||||
padding: $padding-8 $padding-16;
|
||||
border-bottom: $padding-1 transparent;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.book-tabs-content {
|
||||
order: 999; //Move content blocks to the end
|
||||
width: 100%;
|
||||
border-top: $padding-1 solid var(--gray-100);
|
||||
padding: $padding-16;
|
||||
display: none;
|
||||
}
|
||||
|
||||
input[type="radio"]:checked + label {
|
||||
border-bottom: $padding-1 solid var(--color-link);
|
||||
}
|
||||
input[type="radio"]:checked + label + .book-tabs-content {
|
||||
display: block;
|
||||
}
|
||||
input[type="radio"]:focus + label {
|
||||
@include outline;
|
||||
}
|
||||
}
|
||||
|
||||
// {{< columns >}}
|
||||
.book-columns {
|
||||
margin-left: -$padding-16;
|
||||
margin-right: -$padding-16;
|
||||
|
||||
> div {
|
||||
margin: $padding-16 0;
|
||||
min-width: $body-min-width / 2;
|
||||
padding: 0 $padding-16;
|
||||
}
|
||||
}
|
||||
|
||||
// {{< button >}}
|
||||
a.book-btn {
|
||||
display: inline-block;
|
||||
font-size: $font-size-14;
|
||||
color: var(--color-link);
|
||||
line-height: $padding-16 * 2;
|
||||
padding: 0 $padding-16;
|
||||
border: $padding-1 solid var(--color-link);
|
||||
border-radius: $border-radius;
|
||||
cursor: pointer;
|
||||
|
||||
&:hover {
|
||||
text-decoration: none;
|
||||
}
|
||||
}
|
||||
|
||||
// {{< hint >}}
|
||||
.book-hint {
|
||||
@each $name, $color in $hint-colors {
|
||||
&.#{$name} {
|
||||
border-color: $color;
|
||||
background-color: rgba($color, 0.1);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,92 @@
|
||||
.flex {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
.flex-auto {
|
||||
flex: 1 1 auto;
|
||||
}
|
||||
|
||||
.flex-even {
|
||||
flex: 1 1;
|
||||
}
|
||||
|
||||
.flex-wrap {
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.justify-start {
|
||||
justify-content: flex-start;
|
||||
}
|
||||
|
||||
.justify-end {
|
||||
justify-content: flex-end;
|
||||
}
|
||||
|
||||
.justify-center {
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.justify-between {
|
||||
justify-content: space-between;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.mx-auto {
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
.text-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.text-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.text-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.hidden {
|
||||
display: none;
|
||||
}
|
||||
|
||||
input.toggle {
|
||||
height: 0;
|
||||
width: 0;
|
||||
overflow: hidden;
|
||||
opacity: 0;
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
.clearfix::after {
|
||||
content: "";
|
||||
display: table;
|
||||
clear: both;
|
||||
}
|
||||
|
||||
@mixin spin($duration) {
|
||||
animation: spin $duration ease infinite;
|
||||
@keyframes spin {
|
||||
100% {
|
||||
transform: rotate(360deg);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@mixin fixed {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
overflow-x: hidden;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
@mixin outline {
|
||||
outline-style: auto;
|
||||
outline-color: currentColor;
|
||||
outline-color: -webkit-focus-ring-color;
|
||||
}
|
||||
@ -0,0 +1,3 @@
|
||||
/* You can override SASS variables here. */
|
||||
|
||||
// @import "plugins/dark";
|
||||
@ -0,0 +1,15 @@
|
||||
@import "defaults";
|
||||
@import "variables";
|
||||
@import "themes/{{ default "light" .Site.Params.BookTheme }}";
|
||||
|
||||
@import "normalize";
|
||||
@import "utils";
|
||||
@import "main";
|
||||
@import "fonts";
|
||||
@import "print";
|
||||
|
||||
@import "markdown";
|
||||
@import "shortcodes";
|
||||
|
||||
// Custom defined styles
|
||||
@import "custom";
|
||||
@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "{{ .Site.Title }}",
|
||||
"short_name": "{{ .Site.Title }}",
|
||||
"start_url": "{{ "/" | relURL }}",
|
||||
"scope": "{{ "/" | relURL }}",
|
||||
"display": "standalone",
|
||||
"background_color": "#000000",
|
||||
"theme_color": "#000000",
|
||||
"icons": [
|
||||
{
|
||||
"src": "{{ "/favicon.svg" | relURL }}",
|
||||
"sizes": "512x512"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -0,0 +1,7 @@
|
||||
(function() {
|
||||
var menu = document.querySelector("aside.book-menu nav");
|
||||
addEventListener("beforeunload", function(event) {
|
||||
localStorage.setItem("menu.scrollTop", menu.scrollTop);
|
||||
});
|
||||
menu.scrollTop = localStorage.getItem("menu.scrollTop");
|
||||
})();
|
||||
@ -0,0 +1,6 @@
|
||||
{
|
||||
"flowchart": {
|
||||
"useMaxWidth":true
|
||||
},
|
||||
"theme": "default"
|
||||
}
|
||||
@ -0,0 +1,349 @@
|
||||
/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
|
||||
|
||||
/* Document
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* 1. Correct the line height in all browsers.
|
||||
* 2. Prevent adjustments of font size after orientation changes in iOS.
|
||||
*/
|
||||
|
||||
html {
|
||||
line-height: 1.15; /* 1 */
|
||||
-webkit-text-size-adjust: 100%; /* 2 */
|
||||
}
|
||||
|
||||
/* Sections
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove the margin in all browsers.
|
||||
*/
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the `main` element consistently in IE.
|
||||
*/
|
||||
|
||||
main {
|
||||
display: block;
|
||||
}
|
||||
|
||||
/**
|
||||
* Correct the font size and margin on `h1` elements within `section` and
|
||||
* `article` contexts in Chrome, Firefox, and Safari.
|
||||
*/
|
||||
|
||||
h1 {
|
||||
font-size: 2em;
|
||||
margin: 0.67em 0;
|
||||
}
|
||||
|
||||
/* Grouping content
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* 1. Add the correct box sizing in Firefox.
|
||||
* 2. Show the overflow in Edge and IE.
|
||||
*/
|
||||
|
||||
hr {
|
||||
box-sizing: content-box; /* 1 */
|
||||
height: 0; /* 1 */
|
||||
overflow: visible; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the inheritance and scaling of font size in all browsers.
|
||||
* 2. Correct the odd `em` font sizing in all browsers.
|
||||
*/
|
||||
|
||||
pre {
|
||||
font-family: monospace, monospace; /* 1 */
|
||||
font-size: 1em; /* 2 */
|
||||
}
|
||||
|
||||
/* Text-level semantics
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove the gray background on active links in IE 10.
|
||||
*/
|
||||
|
||||
a {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Remove the bottom border in Chrome 57-
|
||||
* 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
|
||||
*/
|
||||
|
||||
abbr[title] {
|
||||
border-bottom: none; /* 1 */
|
||||
text-decoration: underline; /* 2 */
|
||||
text-decoration: underline dotted; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the correct font weight in Chrome, Edge, and Safari.
|
||||
*/
|
||||
|
||||
b,
|
||||
strong {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the inheritance and scaling of font size in all browsers.
|
||||
* 2. Correct the odd `em` font sizing in all browsers.
|
||||
*/
|
||||
|
||||
code,
|
||||
kbd,
|
||||
samp {
|
||||
font-family: monospace, monospace; /* 1 */
|
||||
font-size: 1em; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the correct font size in all browsers.
|
||||
*/
|
||||
|
||||
small {
|
||||
font-size: 80%;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prevent `sub` and `sup` elements from affecting the line height in
|
||||
* all browsers.
|
||||
*/
|
||||
|
||||
sub,
|
||||
sup {
|
||||
font-size: 75%;
|
||||
line-height: 0;
|
||||
position: relative;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
sub {
|
||||
bottom: -0.25em;
|
||||
}
|
||||
|
||||
sup {
|
||||
top: -0.5em;
|
||||
}
|
||||
|
||||
/* Embedded content
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Remove the border on images inside links in IE 10.
|
||||
*/
|
||||
|
||||
img {
|
||||
border-style: none;
|
||||
}
|
||||
|
||||
/* Forms
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* 1. Change the font styles in all browsers.
|
||||
* 2. Remove the margin in Firefox and Safari.
|
||||
*/
|
||||
|
||||
button,
|
||||
input,
|
||||
optgroup,
|
||||
select,
|
||||
textarea {
|
||||
font-family: inherit; /* 1 */
|
||||
font-size: 100%; /* 1 */
|
||||
line-height: 1.15; /* 1 */
|
||||
margin: 0; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Show the overflow in IE.
|
||||
* 1. Show the overflow in Edge.
|
||||
*/
|
||||
|
||||
button,
|
||||
input { /* 1 */
|
||||
overflow: visible;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the inheritance of text transform in Edge, Firefox, and IE.
|
||||
* 1. Remove the inheritance of text transform in Firefox.
|
||||
*/
|
||||
|
||||
button,
|
||||
select { /* 1 */
|
||||
text-transform: none;
|
||||
}
|
||||
|
||||
/**
|
||||
* Correct the inability to style clickable types in iOS and Safari.
|
||||
*/
|
||||
|
||||
button,
|
||||
[type="button"],
|
||||
[type="reset"],
|
||||
[type="submit"] {
|
||||
-webkit-appearance: button;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the inner border and padding in Firefox.
|
||||
*/
|
||||
|
||||
button::-moz-focus-inner,
|
||||
[type="button"]::-moz-focus-inner,
|
||||
[type="reset"]::-moz-focus-inner,
|
||||
[type="submit"]::-moz-focus-inner {
|
||||
border-style: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Restore the focus styles unset by the previous rule.
|
||||
*/
|
||||
|
||||
button:-moz-focusring,
|
||||
[type="button"]:-moz-focusring,
|
||||
[type="reset"]:-moz-focusring,
|
||||
[type="submit"]:-moz-focusring {
|
||||
outline: 1px dotted ButtonText;
|
||||
}
|
||||
|
||||
/**
|
||||
* Correct the padding in Firefox.
|
||||
*/
|
||||
|
||||
fieldset {
|
||||
padding: 0.35em 0.75em 0.625em;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the text wrapping in Edge and IE.
|
||||
* 2. Correct the color inheritance from `fieldset` elements in IE.
|
||||
* 3. Remove the padding so developers are not caught out when they zero out
|
||||
* `fieldset` elements in all browsers.
|
||||
*/
|
||||
|
||||
legend {
|
||||
box-sizing: border-box; /* 1 */
|
||||
color: inherit; /* 2 */
|
||||
display: table; /* 1 */
|
||||
max-width: 100%; /* 1 */
|
||||
padding: 0; /* 3 */
|
||||
white-space: normal; /* 1 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the correct vertical alignment in Chrome, Firefox, and Opera.
|
||||
*/
|
||||
|
||||
progress {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the default vertical scrollbar in IE 10+.
|
||||
*/
|
||||
|
||||
textarea {
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Add the correct box sizing in IE 10.
|
||||
* 2. Remove the padding in IE 10.
|
||||
*/
|
||||
|
||||
[type="checkbox"],
|
||||
[type="radio"] {
|
||||
box-sizing: border-box; /* 1 */
|
||||
padding: 0; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Correct the cursor style of increment and decrement buttons in Chrome.
|
||||
*/
|
||||
|
||||
[type="number"]::-webkit-inner-spin-button,
|
||||
[type="number"]::-webkit-outer-spin-button {
|
||||
height: auto;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the odd appearance in Chrome and Safari.
|
||||
* 2. Correct the outline style in Safari.
|
||||
*/
|
||||
|
||||
[type="search"] {
|
||||
-webkit-appearance: textfield; /* 1 */
|
||||
outline-offset: -2px; /* 2 */
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the inner padding in Chrome and Safari on macOS.
|
||||
*/
|
||||
|
||||
[type="search"]::-webkit-search-decoration {
|
||||
-webkit-appearance: none;
|
||||
}
|
||||
|
||||
/**
|
||||
* 1. Correct the inability to style clickable types in iOS and Safari.
|
||||
* 2. Change font properties to `inherit` in Safari.
|
||||
*/
|
||||
|
||||
::-webkit-file-upload-button {
|
||||
-webkit-appearance: button; /* 1 */
|
||||
font: inherit; /* 2 */
|
||||
}
|
||||
|
||||
/* Interactive
|
||||
========================================================================== */
|
||||
|
||||
/*
|
||||
* Add the correct display in Edge, IE 10+, and Firefox.
|
||||
*/
|
||||
|
||||
details {
|
||||
display: block;
|
||||
}
|
||||
|
||||
/*
|
||||
* Add the correct display in all browsers.
|
||||
*/
|
||||
|
||||
summary {
|
||||
display: list-item;
|
||||
}
|
||||
|
||||
/* Misc
|
||||
========================================================================== */
|
||||
|
||||
/**
|
||||
* Add the correct display in IE 10+.
|
||||
*/
|
||||
|
||||
template {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the correct display in IE 10.
|
||||
*/
|
||||
|
||||
[hidden] {
|
||||
display: none;
|
||||
}
|
||||
@ -0,0 +1,36 @@
|
||||
$startLevel: 1;
|
||||
$endLevel: 6;
|
||||
|
||||
.book-page .markdown {
|
||||
@for $currentLevel from $startLevel through $endLevel {
|
||||
> h#{$currentLevel} {
|
||||
counter-increment: h#{$currentLevel};
|
||||
counter-reset: h#{$currentLevel + 1};
|
||||
|
||||
$content: "";
|
||||
@for $n from $startLevel through $currentLevel {
|
||||
$content: $content + 'counter(h#{$n})"."';
|
||||
}
|
||||
|
||||
&::before {
|
||||
content: unquote($content) " ";
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.book-toc nav ul {
|
||||
li {
|
||||
counter-increment: item;
|
||||
|
||||
&:first-child {
|
||||
counter-reset: item;
|
||||
}
|
||||
|
||||
&:before {
|
||||
content: counters(item, ".") ". ";
|
||||
float: left;
|
||||
margin-inline-end: $padding-4;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,26 @@
|
||||
@import "defaults";
|
||||
@import "variables";
|
||||
|
||||
// Webkit
|
||||
::-webkit-scrollbar {
|
||||
width: $padding-8;
|
||||
}
|
||||
|
||||
::-webkit-scrollbar-thumb {
|
||||
background: transparent;
|
||||
border-radius: $padding-8;
|
||||
}
|
||||
|
||||
:hover::-webkit-scrollbar-thumb {
|
||||
background: var(--gray-500);
|
||||
}
|
||||
|
||||
// MS
|
||||
body {
|
||||
-ms-overflow-style: -ms-autohiding-scrollbar;
|
||||
}
|
||||
|
||||
// Future
|
||||
.book-menu nav {
|
||||
scrollbar-color: transparent var(--gray-500);
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
'use strict';
|
||||
|
||||
(function () {
|
||||
const indexCfg = {{ with i18n "bookSearchConfig" }}
|
||||
{{ . }};
|
||||
{{ else }}
|
||||
{};
|
||||
{{ end }}
|
||||
|
||||
indexCfg.doc = {
|
||||
id: 'id',
|
||||
field: ['title', 'content'],
|
||||
store: ['title', 'href', 'section'],
|
||||
};
|
||||
|
||||
const index = FlexSearch.create('balance', indexCfg);
|
||||
window.bookSearchIndex = index;
|
||||
|
||||
{{- $pages := where .Site.Pages "Kind" "in" (slice "page" "section") -}}
|
||||
{{- $pages = where $pages "Params.booksearchexclude" "!=" true -}}
|
||||
{{- $pages = where $pages "Content" "not in" (slice nil "") -}}
|
||||
|
||||
{{ range $index, $page := $pages }}
|
||||
index.add({
|
||||
'id': {{ $index }},
|
||||
'href': '{{ $page.RelPermalink }}',
|
||||
'title': {{ (partial "docs/title" $page) | jsonify }},
|
||||
'section': {{ (partial "docs/title" $page.Parent) | jsonify }},
|
||||
'content': {{ $page.Plain | jsonify }}
|
||||
});
|
||||
{{- end -}}
|
||||
})();
|
||||
@ -0,0 +1,101 @@
|
||||
'use strict';
|
||||
|
||||
{{ $searchDataFile := printf "%s.search-data.js" .Language.Lang }}
|
||||
{{ $searchData := resources.Get "search-data.js" | resources.ExecuteAsTemplate $searchDataFile . | resources.Minify | resources.Fingerprint }}
|
||||
|
||||
(function () {
|
||||
const input = document.querySelector('#book-search-input');
|
||||
const results = document.querySelector('#book-search-results');
|
||||
|
||||
if (!input) {
|
||||
return
|
||||
}
|
||||
|
||||
input.addEventListener('focus', init);
|
||||
input.addEventListener('keyup', search);
|
||||
|
||||
document.addEventListener('keypress', focusSearchFieldOnKeyPress);
|
||||
|
||||
/**
|
||||
* @param {Event} event
|
||||
*/
|
||||
function focusSearchFieldOnKeyPress(event) {
|
||||
if (input === document.activeElement) {
|
||||
return;
|
||||
}
|
||||
|
||||
const characterPressed = String.fromCharCode(event.charCode);
|
||||
if (!isHotkey(characterPressed)) {
|
||||
return;
|
||||
}
|
||||
|
||||
input.focus();
|
||||
event.preventDefault();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {String} character
|
||||
* @returns {Boolean}
|
||||
*/
|
||||
function isHotkey(character) {
|
||||
const dataHotkeys = input.getAttribute('data-hotkeys') || '';
|
||||
return dataHotkeys.indexOf(character) >= 0;
|
||||
}
|
||||
|
||||
function init() {
|
||||
input.removeEventListener('focus', init); // init once
|
||||
input.required = true;
|
||||
|
||||
loadScript('{{ "flexsearch.min.js" | relURL }}');
|
||||
loadScript('{{ $searchData.RelPermalink }}', function () {
|
||||
input.required = false;
|
||||
search();
|
||||
});
|
||||
}
|
||||
|
||||
function search() {
|
||||
while (results.firstChild) {
|
||||
results.removeChild(results.firstChild);
|
||||
}
|
||||
|
||||
if (!input.value) {
|
||||
return;
|
||||
}
|
||||
|
||||
const searchHits = window.bookSearchIndex.search(input.value, 10);
|
||||
searchHits.forEach(function (page) {
|
||||
const li = element('<li><a href></a><small></small></li>');
|
||||
const a = li.querySelector('a'), small = li.querySelector('small');
|
||||
|
||||
a.href = page.href;
|
||||
a.textContent = page.title;
|
||||
small.textContent = page.section;
|
||||
|
||||
results.appendChild(li);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {String} src
|
||||
* @param {Function} callback
|
||||
*/
|
||||
function loadScript(src, callback) {
|
||||
const script = document.createElement('script');
|
||||
script.defer = true;
|
||||
script.async = false;
|
||||
script.src = src;
|
||||
script.onload = callback;
|
||||
|
||||
document.head.appendChild(script);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {String} content
|
||||
* @returns {Node}
|
||||
*/
|
||||
function element(content) {
|
||||
const div = document.createElement('div');
|
||||
div.innerHTML = content;
|
||||
return div.firstChild;
|
||||
}
|
||||
})();
|
||||
@ -0,0 +1,7 @@
|
||||
{{- $swJS := resources.Get "sw.js" | resources.ExecuteAsTemplate "sw.js" . -}}
|
||||
if (navigator.serviceWorker) {
|
||||
navigator.serviceWorker.register(
|
||||
"{{ $swJS.RelPermalink }}",
|
||||
{ scope: "{{ "/" | relURL }}" }
|
||||
);
|
||||
}
|
||||
@ -0,0 +1,55 @@
|
||||
const cacheName = self.location.pathname
|
||||
const pages = [
|
||||
{{ if eq .Site.Params.BookServiceWorker "precache" }}
|
||||
{{ range .Site.AllPages -}}
|
||||
"{{ .RelPermalink }}",
|
||||
{{ end -}}
|
||||
{{ end }}
|
||||
];
|
||||
|
||||
self.addEventListener("install", function (event) {
|
||||
self.skipWaiting();
|
||||
|
||||
caches.open(cacheName).then((cache) => {
|
||||
return cache.addAll(pages);
|
||||
});
|
||||
});
|
||||
|
||||
self.addEventListener("fetch", (event) => {
|
||||
const request = event.request;
|
||||
if (request.method !== "GET") {
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {Response} response
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
function saveToCache(response) {
|
||||
if (cacheable(response)) {
|
||||
return caches
|
||||
.open(cacheName)
|
||||
.then((cache) => cache.put(request, response.clone()))
|
||||
.then(() => response);
|
||||
} else {
|
||||
return response;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {Error} error
|
||||
*/
|
||||
function serveFromCache(error) {
|
||||
return caches.open(cacheName).then((cache) => cache.match(request.url));
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {Response} response
|
||||
* @returns {Boolean}
|
||||
*/
|
||||
function cacheable(response) {
|
||||
return response.type === "basic" && response.ok && !response.headers.has("Content-Disposition")
|
||||
}
|
||||
|
||||
event.respondWith(fetch(request).then(saveToCache).catch(serveFromCache));
|
||||
});
|
||||
@ -0,0 +1,9 @@
|
||||
:root {
|
||||
@include theme-light;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
@include theme-dark;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,3 @@
|
||||
:root {
|
||||
@include theme-dark;
|
||||
}
|
||||
@ -0,0 +1,3 @@
|
||||
:root {
|
||||
@include theme-light;
|
||||
}
|
||||
@ -0,0 +1,4 @@
|
||||
/* You can add custom styles here. */
|
||||
|
||||
// @import "plugins/numbered";
|
||||
// @import "plugins/scrollbars";
|
||||
@ -0,0 +1 @@
|
||||
/* You can override SASS variables here. */
|
||||
@ -0,0 +1,111 @@
|
||||
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
|
||||
|
||||
baseURL = 'https://example.com/'
|
||||
title = 'Hugo Book'
|
||||
theme = 'hugo-book'
|
||||
|
||||
# Book configuration
|
||||
disablePathToLower = true
|
||||
enableGitInfo = true
|
||||
|
||||
# Needed for mermaid/katex shortcodes
|
||||
[markup]
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
|
||||
[markup.tableOfContents]
|
||||
startLevel = 1
|
||||
|
||||
# Multi-lingual mode config
|
||||
# There are different options to translate files
|
||||
# See https://gohugo.io/content-management/multilingual/#translation-by-filename
|
||||
# And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
[languages]
|
||||
[languages.en]
|
||||
languageName = 'English'
|
||||
contentDir = 'content'
|
||||
weight = 1
|
||||
|
||||
[languages.ru]
|
||||
languageName = 'Russian'
|
||||
contentDir = 'content.ru'
|
||||
weight = 2
|
||||
|
||||
[languages.zh]
|
||||
languageName = 'Chinese'
|
||||
contentDir = 'content.zh'
|
||||
weight = 3
|
||||
|
||||
[menu]
|
||||
# [[menu.before]]
|
||||
[[menu.after]]
|
||||
name = "Github"
|
||||
url = "https://github.com/alex-shpak/hugo-book"
|
||||
weight = 10
|
||||
|
||||
[[menu.after]]
|
||||
name = "Hugo Themes"
|
||||
url = "https://themes.gohugo.io/hugo-book/"
|
||||
weight = 20
|
||||
|
||||
[params]
|
||||
# (Optional, default light) Sets color theme: light, dark or auto.
|
||||
# Theme 'auto' switches between dark and light modes based on browser/os preferences
|
||||
BookTheme = 'light'
|
||||
|
||||
# (Optional, default true) Controls table of contents visibility on right side of pages.
|
||||
# Start and end levels can be controlled with markup.tableOfContents setting.
|
||||
# You can also specify this parameter per page in front matter.
|
||||
BookToC = true
|
||||
|
||||
# (Optional, default none) Set the path to a logo for the book. If the logo is
|
||||
# /static/logo.png then the path would be logo.png
|
||||
# BookLogo = 'logo.png'
|
||||
|
||||
# (Optional, default none) Set leaf bundle to render as side menu
|
||||
# When not specified file structure and weights will be used
|
||||
# BookMenuBundle = '/menu'
|
||||
|
||||
# (Optional, default docs) Specify root page to render child pages as menu.
|
||||
# Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
|
||||
# For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
|
||||
BookSection = 'docs'
|
||||
|
||||
# Set source repository location.
|
||||
# Used for 'Last Modified' and 'Edit this page' links.
|
||||
BookRepo = 'https://github.com/alex-shpak/hugo-book'
|
||||
|
||||
# Enable "Edit this page" links for 'doc' page type.
|
||||
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
|
||||
# Edit path must point to root directory of repo.
|
||||
BookEditPath = 'edit/master/exampleSite'
|
||||
|
||||
# Configure the date format used on the pages
|
||||
# - In git information
|
||||
# - In blog posts
|
||||
BookDateFormat = 'January 2, 2006'
|
||||
|
||||
# (Optional, default true) Enables search function with flexsearch,
|
||||
# Index is built on fly, therefore it might slowdown your website.
|
||||
# Configuration for indexing can be adjusted in i18n folder per language.
|
||||
BookSearch = true
|
||||
|
||||
# (Optional, default true) Enables comments template on pages
|
||||
# By default partals/docs/comments.html includes Disqus template
|
||||
# See https://gohugo.io/content-management/comments/#configure-disqus
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments = true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
||||
# Theme will print warning if page referenced in markdown does not exists.
|
||||
BookPortableLinks = true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
|
||||
BookServiceWorker = true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
|
||||
BookTranslatedOnly = false
|
||||
@ -0,0 +1,107 @@
|
||||
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
|
||||
|
||||
baseURL: https://example.com/
|
||||
title: Hugo Book
|
||||
theme: hugo-book
|
||||
|
||||
# Book configuration
|
||||
disablePathToLower: true
|
||||
enableGitInfo: true
|
||||
|
||||
# Needed for mermaid/katex shortcodes
|
||||
markup:
|
||||
goldmark:
|
||||
renderer:
|
||||
unsafe: true
|
||||
tableOfContents:
|
||||
startLevel: 1
|
||||
|
||||
# Multi-lingual mode config
|
||||
# There are different options to translate files
|
||||
# See https://gohugo.io/content-management/multilingual/#translation-by-filename
|
||||
# And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
languages:
|
||||
en:
|
||||
languageName: English
|
||||
contentDir: content
|
||||
weight: 1
|
||||
ru:
|
||||
languageName: Russian
|
||||
contentDir: content.ru
|
||||
weight: 2
|
||||
zh:
|
||||
languageName: Chinese
|
||||
contentDir: content.zh
|
||||
weight: 3
|
||||
|
||||
menu:
|
||||
# before: []
|
||||
after:
|
||||
- name: "Github"
|
||||
url: "https://github.com/alex-shpak/hugo-book"
|
||||
weight: 10
|
||||
- name: "Hugo Themes"
|
||||
url: "https://themes.gohugo.io/hugo-book/"
|
||||
weight: 20
|
||||
|
||||
params:
|
||||
# (Optional, default light) Sets color theme: light, dark or auto.
|
||||
# Theme 'auto' switches between dark and light modes based on browser/os preferences
|
||||
BookTheme: "light"
|
||||
|
||||
# (Optional, default true) Controls table of contents visibility on right side of pages.
|
||||
# Start and end levels can be controlled with markup.tableOfContents setting.
|
||||
# You can also specify this parameter per page in front matter.
|
||||
BookToC: true
|
||||
|
||||
# (Optional, default none) Set the path to a logo for the book. If the logo is
|
||||
# /static/logo.png then the path would be logo.png
|
||||
# BookLogo: /logo.png
|
||||
|
||||
# (Optional, default none) Set leaf bundle to render as side menu
|
||||
# When not specified file structure and weights will be used
|
||||
# BookMenuBundle: /menu
|
||||
|
||||
# (Optional, default docs) Specify root page to render child pages as menu.
|
||||
# Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
|
||||
# For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
|
||||
BookSection: docs
|
||||
|
||||
# Set source repository location.
|
||||
# Used for 'Last Modified' and 'Edit this page' links.
|
||||
BookRepo: https://github.com/alex-shpak/hugo-book
|
||||
|
||||
# Enable "Edit this page" links for 'doc' page type.
|
||||
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
|
||||
# Edit path must point to root directory of repo.
|
||||
BookEditPath: edit/master/exampleSite
|
||||
|
||||
# Configure the date format used on the pages
|
||||
# - In git information
|
||||
# - In blog posts
|
||||
BookDateFormat: "January 2, 2006"
|
||||
|
||||
# (Optional, default true) Enables search function with flexsearch,
|
||||
# Index is built on fly, therefore it might slowdown your website.
|
||||
# Configuration for indexing can be adjusted in i18n folder per language.
|
||||
BookSearch: true
|
||||
|
||||
# (Optional, default true) Enables comments template on pages
|
||||
# By default partals/docs/comments.html includes Disqus template
|
||||
# See https://gohugo.io/content-management/comments/#configure-disqus
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments: true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
||||
# Theme will print warning if page referenced in markdown does not exists.
|
||||
BookPortableLinks: true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
|
||||
BookServiceWorker: true
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
|
||||
BookTranslatedOnly: false
|
||||
@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Введение
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Стартовая страница на русском языке
|
||||
|
||||
{{< columns >}}
|
||||
## Astris ipse furtiva
|
||||
|
||||
Est in vagis et Pittheus tu arge accipiter regia iram vocatur nurus. Omnes ut
|
||||
olivae sensit **arma sorori** deducit, inesset **crudus**, ego vetuere aliis,
|
||||
modo arsit? Utinam rapta fiducia valuere litora _adicit cursu_, ad facies
|
||||
|
||||
<--->
|
||||
|
||||
## Suis quot vota
|
||||
|
||||
Ea _furtique_ risere fratres edidit terrae magis. Colla tam mihi tenebat:
|
||||
miseram excita suadent es pecudes iam. Concilio _quam_ velatus posset ait quod
|
||||
nunc! Fragosis suae dextra geruntur functus vulgata.
|
||||
{{< /columns >}}
|
||||
|
||||
|
||||
## Tempora nisi nunc
|
||||
|
||||
Lorem **markdownum** emicat gestu. Cannis sol pressit ducta. **Est** Idaei,
|
||||
tremens ausim se tutaeque, illi ulnis hausit, sed, lumina cutem. Quae avis
|
||||
sequens!
|
||||
|
||||
var panel = ram_design;
|
||||
if (backup + system) {
|
||||
file.readPoint = network_native;
|
||||
sidebar_engine_device(cell_tftp_raster,
|
||||
dual_login_paper.adf_vci.application_reader_design(
|
||||
graphicsNvramCdma, lpi_footer_snmp, integer_model));
|
||||
}
|
||||
public_keyboard_docking += error.controller_gibibyte_plug.ip(4,
|
||||
asciiPetaflops, software(supercomputer_compatible_status + 4));
|
||||
dynamic_disk.indexModeLaptop = bufferTftpReality;
|
||||
var export_vlog_sequence = trinitron_flowchart + supercomputer_cluster_rj(
|
||||
-1, toolbar_powerpoint_query, -2 / multiprocessing_impression);
|
||||
|
||||
## Locis suis novi cum suoque decidit eadem
|
||||
|
||||
Idmoniae ripis, at aves, ali missa adest, ut _et autem_, et ab? Venit spes
|
||||
versus finis sermonibus patefecit murum nec est sine oculis. _Ille_ inmota
|
||||
macies domoque caelestia cadit tantummodo scelus procul, corde!
|
||||
|
||||
1. Dolentem capi parte rostro alvum habentem pudor
|
||||
2. Fulgentia sanguine paret
|
||||
3. E punior consurgit lentus
|
||||
4. Vox hasta eras micantes
|
||||
|
||||
## Facibus pharetrae indetonsusque indulsit sic incurrite foliis
|
||||
|
||||
Nefandam et prisci palmas! Blandita cutis flectitur montis macies, te _nati_
|
||||
Latiis; turbaque inferias. Virginis tibi peracta avidusque facies caper nec, e
|
||||
at ademptae, mira.
|
||||
|
||||
direct *= font(inputScareware(sliHome), crossplatform.byte(
|
||||
ppl_encryption.excel_e_rte(integratedModelModifier), timeVirtual,
|
||||
floating_speakers.media_printer(us, yahoo, primaryPhp)));
|
||||
friendly_metal_flatbed(cd, isoPrimaryStorage(reader), dmaMirrored);
|
||||
if (parse_flash_cron.metalGif(1, adServiceDevice, utility)) {
|
||||
adf -= operation_cdma_samba;
|
||||
imapGif.switch += torrent;
|
||||
} else {
|
||||
pmu.disk_captcha = digital_ppp_pci + recursionTransistor(5, dram);
|
||||
ajax_service += grayscalePythonLock;
|
||||
google_scroll_capacity = ftp + engine_dslam_sidebar / tape - 1;
|
||||
}
|
||||
drive_rw = zipTftp;
|
||||
var suffix = software_router_extension.dimm_ddr(-5,
|
||||
kernel_digital_minisite);
|
||||
|
||||
Vocavit toto; alas **mitis** maestus in liquidarum ab legi finitimosque dominam
|
||||
tibi subitus; Orionis vertitur nota. Currere alti etiam seroque cernitis
|
||||
innumeris miraturus amplectique collo sustinet quemque! Litora ante turba?
|
||||
@ -0,0 +1,79 @@
|
||||
---
|
||||
title: 介绍
|
||||
type: docs
|
||||
---
|
||||
|
||||
# 中文索引页
|
||||
|
||||
{{< columns >}}
|
||||
## Astris ipse furtiva
|
||||
|
||||
Est in vagis et Pittheus tu arge accipiter regia iram vocatur nurus. Omnes ut
|
||||
olivae sensit **arma sorori** deducit, inesset **crudus**, ego vetuere aliis,
|
||||
modo arsit? Utinam rapta fiducia valuere litora _adicit cursu_, ad facies
|
||||
|
||||
<--->
|
||||
|
||||
## Suis quot vota
|
||||
|
||||
Ea _furtique_ risere fratres edidit terrae magis. Colla tam mihi tenebat:
|
||||
miseram excita suadent es pecudes iam. Concilio _quam_ velatus posset ait quod
|
||||
nunc! Fragosis suae dextra geruntur functus vulgata.
|
||||
{{< /columns >}}
|
||||
|
||||
|
||||
## Tempora nisi nunc
|
||||
|
||||
Lorem **markdownum** emicat gestu. Cannis sol pressit ducta. **Est** Idaei,
|
||||
tremens ausim se tutaeque, illi ulnis hausit, sed, lumina cutem. Quae avis
|
||||
sequens!
|
||||
|
||||
var panel = ram_design;
|
||||
if (backup + system) {
|
||||
file.readPoint = network_native;
|
||||
sidebar_engine_device(cell_tftp_raster,
|
||||
dual_login_paper.adf_vci.application_reader_design(
|
||||
graphicsNvramCdma, lpi_footer_snmp, integer_model));
|
||||
}
|
||||
public_keyboard_docking += error.controller_gibibyte_plug.ip(4,
|
||||
asciiPetaflops, software(supercomputer_compatible_status + 4));
|
||||
dynamic_disk.indexModeLaptop = bufferTftpReality;
|
||||
var export_vlog_sequence = trinitron_flowchart + supercomputer_cluster_rj(
|
||||
-1, toolbar_powerpoint_query, -2 / multiprocessing_impression);
|
||||
|
||||
## Locis suis novi cum suoque decidit eadem
|
||||
|
||||
Idmoniae ripis, at aves, ali missa adest, ut _et autem_, et ab? Venit spes
|
||||
versus finis sermonibus patefecit murum nec est sine oculis. _Ille_ inmota
|
||||
macies domoque caelestia cadit tantummodo scelus procul, corde!
|
||||
|
||||
1. Dolentem capi parte rostro alvum habentem pudor
|
||||
2. Fulgentia sanguine paret
|
||||
3. E punior consurgit lentus
|
||||
4. Vox hasta eras micantes
|
||||
|
||||
## Facibus pharetrae indetonsusque indulsit sic incurrite foliis
|
||||
|
||||
Nefandam et prisci palmas! Blandita cutis flectitur montis macies, te _nati_
|
||||
Latiis; turbaque inferias. Virginis tibi peracta avidusque facies caper nec, e
|
||||
at ademptae, mira.
|
||||
|
||||
direct *= font(inputScareware(sliHome), crossplatform.byte(
|
||||
ppl_encryption.excel_e_rte(integratedModelModifier), timeVirtual,
|
||||
floating_speakers.media_printer(us, yahoo, primaryPhp)));
|
||||
friendly_metal_flatbed(cd, isoPrimaryStorage(reader), dmaMirrored);
|
||||
if (parse_flash_cron.metalGif(1, adServiceDevice, utility)) {
|
||||
adf -= operation_cdma_samba;
|
||||
imapGif.switch += torrent;
|
||||
} else {
|
||||
pmu.disk_captcha = digital_ppp_pci + recursionTransistor(5, dram);
|
||||
ajax_service += grayscalePythonLock;
|
||||
google_scroll_capacity = ftp + engine_dslam_sidebar / tape - 1;
|
||||
}
|
||||
drive_rw = zipTftp;
|
||||
var suffix = software_router_extension.dimm_ddr(-5,
|
||||
kernel_digital_minisite);
|
||||
|
||||
Vocavit toto; alas **mitis** maestus in liquidarum ab legi finitimosque dominam
|
||||
tibi subitus; Orionis vertitur nota. Currere alti etiam seroque cernitis
|
||||
innumeris miraturus amplectique collo sustinet quemque! Litora ante turba?
|
||||
@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Introduction
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Acerbo datus maxime
|
||||
|
||||
{{< columns >}}
|
||||
## Astris ipse furtiva
|
||||
|
||||
Est in vagis et Pittheus tu arge accipiter regia iram vocatur nurus. Omnes ut
|
||||
olivae sensit **arma sorori** deducit, inesset **crudus**, ego vetuere aliis,
|
||||
modo arsit? Utinam rapta fiducia valuere litora _adicit cursu_, ad facies
|
||||
|
||||
<--->
|
||||
|
||||
## Suis quot vota
|
||||
|
||||
Ea _furtique_ risere fratres edidit terrae magis. Colla tam mihi tenebat:
|
||||
miseram excita suadent es pecudes iam. Concilio _quam_ velatus posset ait quod
|
||||
nunc! Fragosis suae dextra geruntur functus vulgata.
|
||||
{{< /columns >}}
|
||||
|
||||
|
||||
## Tempora nisi nunc
|
||||
|
||||
Lorem **markdownum** emicat gestu. Cannis sol pressit ducta. **Est** Idaei,
|
||||
tremens ausim se tutaeque, illi ulnis hausit, sed, lumina cutem. Quae avis
|
||||
sequens!
|
||||
|
||||
var panel = ram_design;
|
||||
if (backup + system) {
|
||||
file.readPoint = network_native;
|
||||
sidebar_engine_device(cell_tftp_raster,
|
||||
dual_login_paper.adf_vci.application_reader_design(
|
||||
graphicsNvramCdma, lpi_footer_snmp, integer_model));
|
||||
}
|
||||
|
||||
## Locis suis novi cum suoque decidit eadem
|
||||
|
||||
Idmoniae ripis, at aves, ali missa adest, ut _et autem_, et ab?
|
||||
@ -0,0 +1,71 @@
|
||||
---
|
||||
weight: 1
|
||||
bookFlatSection: true
|
||||
title: "Example Site"
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
## Ferre hinnitibus erat accipitrem dixi Troiae tollens
|
||||
|
||||
Lorem markdownum, a quoque nutu est *quodcumque mandasset* veluti. Passim
|
||||
inportuna totidemque nympha fert; repetens pendent, poenarum guttura sed vacet
|
||||
non, mortali undas. Omnis pharetramque gramen portentificisque membris servatum
|
||||
novabis fallit de nubibus atque silvas mihi. **Dixit repetitaque Quid**; verrit
|
||||
longa; sententia [mandat](http://pastor-ad.io/questussilvas) quascumque nescio
|
||||
solebat [litore](http://lacrimas-ab.net/); noctes. *Hostem haerentem* circuit
|
||||
[plenaque tamen](http://www.sine.io/in).
|
||||
|
||||
- Pedum ne indigenae finire invergens carpebat
|
||||
- Velit posses summoque
|
||||
- De fumos illa foret
|
||||
|
||||
## Est simul fameque tauri qua ad
|
||||
|
||||
Locum nullus nisi vomentes. Ab Persea sermone vela, miratur aratro; eandem
|
||||
Argolicas gener.
|
||||
|
||||
## Me sol
|
||||
|
||||
Nec dis certa fuit socer, Nonacria **dies** manet tacitaque sibi? Sucis est
|
||||
iactata Castrumque iudex, et iactato quoque terraeque es tandem et maternos
|
||||
vittis. Lumina litus bene poenamque animos callem ne tuas in leones illam dea
|
||||
cadunt genus, et pleno nunc in quod. Anumque crescentesque sanguinis
|
||||
[progenies](http://www.late.net/alimentavirides) nuribus rustica tinguet. Pater
|
||||
omnes liquido creditis noctem.
|
||||
|
||||
if (mirrored(icmp_dvd_pim, 3, smbMirroredHard) != lion(clickImportQueue,
|
||||
viralItunesBalancing, bankruptcy_file_pptp)) {
|
||||
file += ip_cybercrime_suffix;
|
||||
}
|
||||
if (runtimeSmartRom == netMarketingWord) {
|
||||
virusBalancingWin *= scriptPromptBespoke + raster(post_drive,
|
||||
windowsSli);
|
||||
cd = address_hertz_trojan;
|
||||
soap_ccd.pcbServerGigahertz(asp_hardware_isa, offlinePeopleware, nui);
|
||||
} else {
|
||||
megabyte.api = modem_flowchart - web + syntaxHalftoneAddress;
|
||||
}
|
||||
if (3 < mebibyteNetworkAnimated) {
|
||||
pharming_regular_error *= jsp_ribbon + algorithm * recycleMediaKindle(
|
||||
dvrSyntax, cdma);
|
||||
adf_sla *= hoverCropDrive;
|
||||
templateNtfs = -1 - vertical;
|
||||
} else {
|
||||
expressionCompressionVariable.bootMulti = white_eup_javascript(
|
||||
table_suffix);
|
||||
guidPpiPram.tracerouteLinux += rtfTerabyteQuicktime(1,
|
||||
managementRosetta(webcamActivex), 740874);
|
||||
}
|
||||
var virusTweetSsl = nullGigo;
|
||||
|
||||
## Trepident sitimque
|
||||
|
||||
Sentiet et ferali errorem fessam, coercet superbus, Ascaniumque in pennis
|
||||
mediis; dolor? Vidit imi **Aeacon** perfida propositos adde, tua Somni Fluctibus
|
||||
errante lustrat non.
|
||||
|
||||
Tamen inde, vos videt e flammis Scythica parantem rupisque pectora umbras. Haec
|
||||
ficta canistris repercusso simul ego aris Dixit! Esse Fama trepidare hunc
|
||||
crescendo vigor ululasse vertice *exspatiantur* celer tepidique petita aversata
|
||||
oculis iussa est me ferro.
|
||||
@ -0,0 +1,12 @@
|
||||
# 4th Level of Menu
|
||||
|
||||
## Caesorum illa tu sentit micat vestes papyriferi
|
||||
|
||||
Inde aderam facti; Theseus vis de tauri illa peream. Oculos **uberaque** non
|
||||
regisque vobis cursuque, opus venit quam vulnera. Et maiora necemque, lege modo;
|
||||
gestanda nitidi, vero? Dum ne pectoraque testantur.
|
||||
|
||||
Venasque repulsa Samos qui, exspectatum eram animosque hinc, [aut
|
||||
manes](http://www.creveratnon.net/apricaaetheriis), Assyrii. Cupiens auctoribus
|
||||
pariter rubet, profana magni super nocens. Vos ius sibilat inpar turba visae
|
||||
iusto! Sedes ante dum superest **extrema**.
|
||||
@ -0,0 +1,26 @@
|
||||
# 3rd Level of Menu
|
||||
|
||||
Nefas discordemque domino montes numen tum humili nexilibusque exit, Iove. Quae
|
||||
miror esse, scelerisque Melaneus viribus. Miseri laurus. Hoc est proposita me
|
||||
ante aliquid, aura inponere candidioribus quidque accendit bella, sumpta.
|
||||
Intravit quam erat figentem hunc, motus de fontes parvo tempestate.
|
||||
|
||||
iscsi_virus = pitch(json_in_on(eupViral),
|
||||
northbridge_services_troubleshooting, personal(
|
||||
firmware_rw.trash_rw_crm.device(interactive_gopher_personal,
|
||||
software, -1), megabit, ergonomicsSoftware(cmyk_usb_panel,
|
||||
mips_whitelist_duplex, cpa)));
|
||||
if (5) {
|
||||
managementNetwork += dma - boolean;
|
||||
kilohertz_token = 2;
|
||||
honeypot_affiliate_ergonomics = fiber;
|
||||
}
|
||||
mouseNorthbridge = byte(nybble_xmp_modem.horse_subnet(
|
||||
analogThroughputService * graphicPoint, drop(daw_bit, dnsIntranet),
|
||||
gateway_ospf), repository.domain_key.mouse(serverData(fileNetwork,
|
||||
trim_duplex_file), cellTapeDirect, token_tooltip_mashup(
|
||||
ripcordingMashup)));
|
||||
module_it = honeypot_driver(client_cold_dvr(593902, ripping_frequency) +
|
||||
coreLog.joystick(componentUdpLink), windows_expansion_touchscreen);
|
||||
bashGigabit.external.reality(2, server_hardware_codec.flops.ebookSampling(
|
||||
ciscNavigationBacklink, table + cleanDriver), indexProtocolIsp);
|
||||
@ -0,0 +1,4 @@
|
||||
---
|
||||
bookCollapseSection: true
|
||||
weight: 20
|
||||
---
|
||||
@ -0,0 +1,52 @@
|
||||
---
|
||||
bookHidden: true
|
||||
---
|
||||
|
||||
# This page is hidden in menu
|
||||
|
||||
# Quondam non pater est dignior ille Eurotas
|
||||
|
||||
## Latent te facies
|
||||
|
||||
Lorem markdownum arma ignoscas vocavit quoque ille texit mandata mentis ultimus,
|
||||
frementes, qui in vel. Hippotades Peleus [pennas
|
||||
conscia](http://gratia.net/tot-qua.php) cuiquam Caeneus quas.
|
||||
|
||||
- Pater demittere evincitque reddunt
|
||||
- Maxime adhuc pressit huc Danaas quid freta
|
||||
- Soror ego
|
||||
- Luctus linguam saxa ultroque prior Tatiumque inquit
|
||||
- Saepe liquitur subita superata dederat Anius sudor
|
||||
|
||||
## Cum honorum Latona
|
||||
|
||||
O fallor [in sustinui
|
||||
iussorum](http://www.spectataharundine.org/aquas-relinquit.html) equidem.
|
||||
Nymphae operi oris alii fronde parens dumque, in auro ait mox ingenti proxima
|
||||
iamdudum maius?
|
||||
|
||||
reality(burnDocking(apache_nanometer),
|
||||
pad.property_data_programming.sectorBrowserPpga(dataMask, 37,
|
||||
recycleRup));
|
||||
intellectualVaporwareUser += -5 * 4;
|
||||
traceroute_key_upnp /= lag_optical(android.smb(thyristorTftp));
|
||||
surge_host_golden = mca_compact_device(dual_dpi_opengl, 33,
|
||||
commerce_add_ppc);
|
||||
if (lun_ipv) {
|
||||
verticalExtranet(1, thumbnail_ttl, 3);
|
||||
bar_graphics_jpeg(chipset - sector_xmp_beta);
|
||||
}
|
||||
|
||||
## Fronde cetera dextrae sequens pennis voce muneris
|
||||
|
||||
Acta cretus diem restet utque; move integer, oscula non inspirat, noctisque
|
||||
scelus! Nantemque in suas vobis quamvis, et labori!
|
||||
|
||||
var runtimeDiskCompiler = home - array_ad_software;
|
||||
if (internic > disk) {
|
||||
emoticonLockCron += 37 + bps - 4;
|
||||
wan_ansi_honeypot.cardGigaflops = artificialStorageCgi;
|
||||
simplex -= downloadAccess;
|
||||
}
|
||||
var volumeHardeningAndroid = pixel + tftp + onProcessorUnmount;
|
||||
sector(memory(firewire + interlaced, wired));
|
||||
@ -0,0 +1,85 @@
|
||||
---
|
||||
weight: 10
|
||||
---
|
||||
|
||||
# Ubi loqui
|
||||
|
||||
## Mentem genus facietque salire tempus bracchia
|
||||
|
||||
Lorem markdownum partu paterno Achillem. Habent amne generosi aderant ad pellem
|
||||
nec erat sustinet merces columque haec et, dixit minus nutrit accipiam subibis
|
||||
subdidit. Temeraria servatum agros qui sed fulva facta. Primum ultima, dedit,
|
||||
suo quisque linguae medentes fixo: tum petis.
|
||||
|
||||
## Rapit vocant si hunc siste adspice
|
||||
|
||||
Ora precari Patraeque Neptunia, dixit Danae [Cithaeron
|
||||
armaque](http://mersis-an.org/litoristum) maxima in **nati Coniugis** templis
|
||||
fluidove. Effugit usus nec ingreditur agmen *ac manus* conlato. Nullis vagis
|
||||
nequiquam vultibus aliquos altera *suum venis* teneas fretum. Armos [remotis
|
||||
hoc](http://tutum.io/me) sine ferrea iuncta quam!
|
||||
|
||||
## Locus fuit caecis
|
||||
|
||||
Nefas discordemque domino montes numen tum humili nexilibusque exit, Iove. Quae
|
||||
miror esse, scelerisque Melaneus viribus. Miseri laurus. Hoc est proposita me
|
||||
ante aliquid, aura inponere candidioribus quidque accendit bella, sumpta.
|
||||
Intravit quam erat figentem hunc, motus de fontes parvo tempestate.
|
||||
|
||||
iscsi_virus = pitch(json_in_on(eupViral),
|
||||
northbridge_services_troubleshooting, personal(
|
||||
firmware_rw.trash_rw_crm.device(interactive_gopher_personal,
|
||||
software, -1), megabit, ergonomicsSoftware(cmyk_usb_panel,
|
||||
mips_whitelist_duplex, cpa)));
|
||||
if (5) {
|
||||
managementNetwork += dma - boolean;
|
||||
kilohertz_token = 2;
|
||||
honeypot_affiliate_ergonomics = fiber;
|
||||
}
|
||||
mouseNorthbridge = byte(nybble_xmp_modem.horse_subnet(
|
||||
analogThroughputService * graphicPoint, drop(daw_bit, dnsIntranet),
|
||||
gateway_ospf), repository.domain_key.mouse(serverData(fileNetwork,
|
||||
trim_duplex_file), cellTapeDirect, token_tooltip_mashup(
|
||||
ripcordingMashup)));
|
||||
module_it = honeypot_driver(client_cold_dvr(593902, ripping_frequency) +
|
||||
coreLog.joystick(componentUdpLink), windows_expansion_touchscreen);
|
||||
bashGigabit.external.reality(2, server_hardware_codec.flops.ebookSampling(
|
||||
ciscNavigationBacklink, table + cleanDriver), indexProtocolIsp);
|
||||
|
||||
## Placabilis coactis nega ingemuit ignoscat nimia non
|
||||
|
||||
Frontis turba. Oculi gravis est Delphice; *inque praedaque* sanguine manu non.
|
||||
|
||||
if (ad_api) {
|
||||
zif += usb.tiffAvatarRate(subnet, digital_rt) + exploitDrive;
|
||||
gigaflops(2 - bluetooth, edi_asp_memory.gopher(queryCursor, laptop),
|
||||
panel_point_firmware);
|
||||
spyware_bash.statePopApplet = express_netbios_digital(
|
||||
insertion_troubleshooting.brouter(recordFolderUs), 65);
|
||||
}
|
||||
recursionCoreRay = -5;
|
||||
if (hub == non) {
|
||||
portBoxVirus = soundWeb(recursive_card(rwTechnologyLeopard),
|
||||
font_radcab, guidCmsScalable + reciprocalMatrixPim);
|
||||
left.bug = screenshot;
|
||||
} else {
|
||||
tooltipOpacity = raw_process_permalink(webcamFontUser, -1);
|
||||
executable_router += tape;
|
||||
}
|
||||
if (tft) {
|
||||
bandwidthWeb *= social_page;
|
||||
} else {
|
||||
regular += 611883;
|
||||
thumbnail /= system_lag_keyboard;
|
||||
}
|
||||
|
||||
## Caesorum illa tu sentit micat vestes papyriferi
|
||||
|
||||
Inde aderam facti; Theseus vis de tauri illa peream. Oculos **uberaque** non
|
||||
regisque vobis cursuque, opus venit quam vulnera. Et maiora necemque, lege modo;
|
||||
gestanda nitidi, vero? Dum ne pectoraque testantur.
|
||||
|
||||
Venasque repulsa Samos qui, exspectatum eram animosque hinc, [aut
|
||||
manes](http://www.creveratnon.net/apricaaetheriis), Assyrii. Cupiens auctoribus
|
||||
pariter rubet, profana magni super nocens. Vos ius sibilat inpar turba visae
|
||||
iusto! Sedes ante dum superest **extrema**.
|
||||
@ -0,0 +1,64 @@
|
||||
---
|
||||
title: With ToC
|
||||
weight: 1
|
||||
---
|
||||
# Caput vino delphine in tamen vias
|
||||
|
||||
## Cognita laeva illo fracta
|
||||
|
||||
Lorem markdownum pavent auras, surgit nunc cingentibus libet **Laomedonque que**
|
||||
est. Pastor [An](http://est.org/ire.aspx) arbor filia foedat, ne [fugit
|
||||
aliter](http://www.indiciumturbam.org/moramquid.php), per. Helicona illas et
|
||||
callida neptem est *Oresitrophos* caput, dentibus est venit. Tenet reddite
|
||||
[famuli](http://www.antro-et.net/) praesentem fortibus, quaeque vis foret si
|
||||
frondes *gelidos* gravidae circumtulit [inpulit armenta
|
||||
nativum](http://incurvasustulit.io/illi-virtute.html).
|
||||
|
||||
1. Te at cruciabere vides rubentis manebo
|
||||
2. Maturuit in praetemptat ruborem ignara postquam habitasse
|
||||
3. Subitarum supplevit quoque fontesque venabula spretis modo
|
||||
4. Montis tot est mali quasque gravis
|
||||
5. Quinquennem domus arsit ipse
|
||||
6. Pellem turis pugnabant locavit
|
||||
|
||||
## Natus quaerere
|
||||
|
||||
Pectora et sine mulcere, coniuge dum tincta incurvae. Quis iam; est dextra
|
||||
Peneosque, metuis a verba, primo. Illa sed colloque suis: magno: gramen, aera
|
||||
excutiunt concipit.
|
||||
|
||||
> Phrygiae petendo suisque extimuit, super, pars quod audet! Turba negarem.
|
||||
> Fuerat attonitus; et dextra retinet sidera ulnas undas instimulat vacuae
|
||||
> generis? *Agnus* dabat et ignotis dextera, sic tibi pacis **feriente at mora**
|
||||
> euhoeque *comites hostem* vestras Phineus. Vultuque sanguine dominoque [metuit
|
||||
> risi](http://iuvat.org/eundem.php) fama vergit summaque meus clarissimus
|
||||
> artesque tinguebat successor nominis cervice caelicolae.
|
||||
|
||||
## Limitibus misere sit
|
||||
|
||||
Aurea non fata repertis praerupit feruntur simul, meae hosti lentaque *citius
|
||||
levibus*, cum sede dixit, Phaethon texta. *Albentibus summos* multifidasque
|
||||
iungitur loquendi an pectore, mihi ursaque omnia adfata, aeno parvumque in animi
|
||||
perlucentes. Epytus agis ait vixque clamat ornum adversam spondet, quid sceptra
|
||||
ipsum **est**. Reseret nec; saeva suo passu debentia linguam terga et aures et
|
||||
cervix [de](http://www.amnem.io/pervenit.aspx) ubera. Coercet gelidumque manus,
|
||||
doluit volvitur induta?
|
||||
|
||||
## Enim sua
|
||||
|
||||
Iuvenilior filia inlustre templa quidem herbis permittat trahens huic. In
|
||||
cruribus proceres sole crescitque *fata*, quos quos; merui maris se non tamen
|
||||
in, mea.
|
||||
|
||||
## Germana aves pignus tecta
|
||||
|
||||
Mortalia rudibusque caelum cognosceret tantum aquis redito felicior texit, nec,
|
||||
aris parvo acre. Me parum contulerant multi tenentem, gratissime suis; vultum tu
|
||||
occupat deficeret corpora, sonum. E Actaea inplevit Phinea concepit nomenque
|
||||
potest sanguine captam nulla et, in duxisses campis non; mercede. Dicere cur
|
||||
Leucothoen obitum?
|
||||
|
||||
Postibus mittam est *nubibus principium pluma*, exsecratur facta et. Iunge
|
||||
Mnemonidas pallamque pars; vere restitit alis flumina quae **quoque**, est
|
||||
ignara infestus Pyrrha. Di ducis terris maculatum At sede praemia manes
|
||||
nullaque!
|
||||
@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Without ToC
|
||||
weight: 2
|
||||
bookToc: false
|
||||
---
|
||||
|
||||
# At me ipso nepotibus nunc celebratior genus
|
||||
|
||||
## Tanto oblite
|
||||
|
||||
Lorem markdownum pectora novis patenti igne sua opus aurae feras materiaque
|
||||
illic demersit imago et aristas questaque posset. Vomit quoque suo inhaesuro
|
||||
clara. Esse cumque, per referri triste. Ut exponit solisque communis in tendens
|
||||
vincetis agisque iamque huic bene ante vetat omina Thebae rates. Aeacus servat
|
||||
admonitu concidit, ad resimas vultus et rugas vultu **dignamque** Siphnon.
|
||||
|
||||
Quam iugulum regia simulacra, plus meruit humo pecorumque haesit, ab discedunt
|
||||
dixit: ritu pharetramque. Exul Laurenti orantem modo, per densum missisque labor
|
||||
manibus non colla unum, obiectat. Tu pervia collo, fessus quae Cretenque Myconon
|
||||
crate! Tegumenque quae invisi sudore per vocari quaque plus ventis fluidos. Nodo
|
||||
perque, fugisse pectora sorores.
|
||||
|
||||
## Summe promissa supple vadit lenius
|
||||
|
||||
Quibus largis latebris aethera versato est, ait sentiat faciemque. Aequata alis
|
||||
nec Caeneus exululat inclite corpus est, ire **tibi** ostendens et tibi. Rigent
|
||||
et vires dique possent lumina; **eadem** dixit poma funeribus paret et felix
|
||||
reddebant ventis utile lignum.
|
||||
|
||||
1. Remansit notam Stygia feroxque
|
||||
2. Et dabit materna
|
||||
3. Vipereas Phrygiaeque umbram sollicito cruore conlucere suus
|
||||
4. Quarum Elis corniger
|
||||
5. Nec ieiunia dixit
|
||||
|
||||
Vertitur mos ortu ramosam contudit dumque; placabat ac lumen. Coniunx Amoris
|
||||
spatium poenamque cavernis Thebae Pleiadasque ponunt, rapiare cum quae parum
|
||||
nimium rima.
|
||||
|
||||
## Quidem resupinus inducto solebat una facinus quae
|
||||
|
||||
Credulitas iniqua praepetibus paruit prospexit, voce poena, sub rupit sinuatur,
|
||||
quin suum ventorumque arcadiae priori. Soporiferam erat formamque, fecit,
|
||||
invergens, nymphae mutat fessas ait finge.
|
||||
|
||||
1. Baculum mandataque ne addere capiti violentior
|
||||
2. Altera duas quam hoc ille tenues inquit
|
||||
3. Sicula sidereus latrantis domoque ratae polluit comites
|
||||
4. Possit oro clausura namque se nunc iuvenisque
|
||||
5. Faciem posuit
|
||||
6. Quodque cum ponunt novercae nata vestrae aratra
|
||||
|
||||
Ite extrema Phrygiis, patre dentibus, tonso perculit, enim blanda, manibus fide
|
||||
quos caput armis, posse! Nocendo fas Alcyonae lacertis structa ferarum manus
|
||||
fulmen dubius, saxa caelum effuge extremis fixum tumor adfecit **bella**,
|
||||
potentes? Dum nec insidiosa tempora tegit
|
||||
[spirarunt](http://mihiferre.net/iuvenes-peto.html). Per lupi pars foliis,
|
||||
porreximus humum negant sunt subposuere Sidone steterant auro. Memoraverit sine:
|
||||
ferrum idem Orion caelum heres gerebat fixis?
|
||||
@ -0,0 +1,3 @@
|
||||
---
|
||||
bookFlatSection: true
|
||||
---
|
||||
@ -0,0 +1,13 @@
|
||||
# Buttons
|
||||
|
||||
Buttons are styled links that can lead to local page or external link.
|
||||
|
||||
## Example
|
||||
|
||||
```tpl
|
||||
{{</* button relref="/" [class="..."] */>}}Get Home{{</* /button */>}}
|
||||
{{</* button href="https://github.com/alex-shpak/hugo-book" */>}}Contribute{{</* /button */>}}
|
||||
```
|
||||
|
||||
{{< button relref="/" >}}Get Home{{< /button >}}
|
||||
{{< button href="https://github.com/alex-shpak/hugo-book" >}}Contribute{{< /button >}}
|
||||
@ -0,0 +1,45 @@
|
||||
# Columns
|
||||
|
||||
Columns help organize shorter pieces of content horizontally for readability.
|
||||
|
||||
|
||||
```html
|
||||
{{</* columns */>}} <!-- begin columns block -->
|
||||
# Left Content
|
||||
Lorem markdownum insigne...
|
||||
|
||||
<---> <!-- magic separator, between columns -->
|
||||
|
||||
# Mid Content
|
||||
Lorem markdownum insigne...
|
||||
|
||||
<---> <!-- magic separator, between columns -->
|
||||
|
||||
# Right Content
|
||||
Lorem markdownum insigne...
|
||||
{{</* /columns */>}}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
{{< columns >}}
|
||||
## Left Content
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||
Miseratus fonte Ditis conubia.
|
||||
|
||||
<--->
|
||||
|
||||
## Mid Content
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter!
|
||||
|
||||
<--->
|
||||
|
||||
## Right Content
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||
Miseratus fonte Ditis conubia.
|
||||
{{< /columns >}}
|
||||
@ -0,0 +1,22 @@
|
||||
# Details
|
||||
|
||||
Details shortcode is a helper for `details` html5 element. It is going to replace `expand` shortcode.
|
||||
|
||||
## Example
|
||||
```tpl
|
||||
{{</* details "Title" [open] */>}}
|
||||
## Markdown content
|
||||
Lorem markdownum insigne...
|
||||
{{</* /details */>}}
|
||||
```
|
||||
```tpl
|
||||
{{</* details title="Title" open=true */>}}
|
||||
## Markdown content
|
||||
Lorem markdownum insigne...
|
||||
{{</* /details */>}}
|
||||
```
|
||||
|
||||
{{< details "Title" open >}}
|
||||
## Markdown content
|
||||
Lorem markdownum insigne...
|
||||
{{< /details >}}
|
||||
@ -0,0 +1,35 @@
|
||||
# Expand
|
||||
|
||||
Expand shortcode can help to decrease clutter on screen by hiding part of text. Expand content by clicking on it.
|
||||
|
||||
## Example
|
||||
### Default
|
||||
|
||||
```tpl
|
||||
{{</* expand */>}}
|
||||
## Markdown content
|
||||
Lorem markdownum insigne...
|
||||
{{</* /expand */>}}
|
||||
```
|
||||
|
||||
{{< expand >}}
|
||||
## Markdown content
|
||||
Lorem markdownum insigne...
|
||||
{{< /expand >}}
|
||||
|
||||
### With Custom Label
|
||||
|
||||
```tpl
|
||||
{{</* expand "Custom Label" "..." */>}}
|
||||
## Markdown content
|
||||
Lorem markdownum insigne...
|
||||
{{</* /expand */>}}
|
||||
```
|
||||
|
||||
{{< expand "Custom Label" "..." >}}
|
||||
## Markdown content
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||
Miseratus fonte Ditis conubia.
|
||||
{{< /expand >}}
|
||||
@ -0,0 +1,32 @@
|
||||
# Hints
|
||||
|
||||
Hint shortcode can be used as hint/alerts/notification block.
|
||||
There are 3 colors to choose: `info`, `warning` and `danger`.
|
||||
|
||||
```tpl
|
||||
{{</* hint [info|warning|danger] */>}}
|
||||
**Markdown content**
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
{{</* /hint */>}}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
{{< hint info >}}
|
||||
**Markdown content**
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
{{< /hint >}}
|
||||
|
||||
{{< hint warning >}}
|
||||
**Markdown content**
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
{{< /hint >}}
|
||||
|
||||
{{< hint danger >}}
|
||||
**Markdown content**
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
{{< /hint >}}
|
||||
@ -0,0 +1,28 @@
|
||||
# KaTeX
|
||||
|
||||
KaTeX shortcode let you render math typesetting in markdown document. See [KaTeX](https://katex.org/)
|
||||
|
||||
## Example
|
||||
{{< columns >}}
|
||||
|
||||
```latex
|
||||
{{</* katex [display] [class="text-center"] */>}}
|
||||
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
|
||||
{{</* /katex */>}}
|
||||
```
|
||||
|
||||
<--->
|
||||
|
||||
{{< katex display >}}
|
||||
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
|
||||
{{< /katex >}}
|
||||
|
||||
{{< /columns >}}
|
||||
|
||||
## Display Mode Example
|
||||
|
||||
Here is some inline example: {{< katex >}}\pi(x){{< /katex >}}, rendered in the same line. And below is `display` example, having `display: block`
|
||||
{{< katex display >}}
|
||||
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
|
||||
{{< /katex >}}
|
||||
Text continues here.
|
||||
@ -0,0 +1,38 @@
|
||||
# Mermaid Chart
|
||||
|
||||
[Mermaid](https://mermaidjs.github.io/) is library for generating svg charts and diagrams from text.
|
||||
|
||||
## Example
|
||||
|
||||
{{< columns >}}
|
||||
```tpl
|
||||
{{</* mermaid [class="text-center"]*/>}}
|
||||
sequenceDiagram
|
||||
Alice->>Bob: Hello Bob, how are you?
|
||||
alt is sick
|
||||
Bob->>Alice: Not so good :(
|
||||
else is well
|
||||
Bob->>Alice: Feeling fresh like a daisy
|
||||
end
|
||||
opt Extra response
|
||||
Bob->>Alice: Thanks for asking
|
||||
end
|
||||
{{</* /mermaid */>}}
|
||||
```
|
||||
|
||||
<--->
|
||||
|
||||
{{< mermaid >}}
|
||||
sequenceDiagram
|
||||
Alice->>Bob: Hello Bob, how are you?
|
||||
alt is sick
|
||||
Bob->>Alice: Not so good :(
|
||||
else is well
|
||||
Bob->>Alice: Feeling fresh like a daisy
|
||||
end
|
||||
opt Extra response
|
||||
Bob->>Alice: Thanks for asking
|
||||
end
|
||||
{{< /mermaid >}}
|
||||
|
||||
{{< /columns >}}
|
||||
@ -0,0 +1,15 @@
|
||||
---
|
||||
bookCollapseSection: true
|
||||
---
|
||||
|
||||
# Section
|
||||
|
||||
Section renders pages in section as definition list, using title and description.
|
||||
|
||||
## Example
|
||||
|
||||
```tpl
|
||||
{{</* section */>}}
|
||||
```
|
||||
|
||||
{{<section>}}
|
||||
@ -0,0 +1 @@
|
||||
# Page 1
|
||||
@ -0,0 +1 @@
|
||||
# Page 2
|
||||
@ -0,0 +1,50 @@
|
||||
# Tabs
|
||||
|
||||
Tabs let you organize content by context, for example installation instructions for each supported platform.
|
||||
|
||||
```tpl
|
||||
{{</* tabs "uniqueid" */>}}
|
||||
{{</* tab "MacOS" */>}} # MacOS Content {{</* /tab */>}}
|
||||
{{</* tab "Linux" */>}} # Linux Content {{</* /tab */>}}
|
||||
{{</* tab "Windows" */>}} # Windows Content {{</* /tab */>}}
|
||||
{{</* /tabs */>}}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
{{< tabs "uniqueid" >}}
|
||||
{{< tab "MacOS" >}}
|
||||
# MacOS
|
||||
|
||||
This is tab **MacOS** content.
|
||||
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||
Miseratus fonte Ditis conubia.
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab "Linux" >}}
|
||||
|
||||
# Linux
|
||||
|
||||
This is tab **Linux** content.
|
||||
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||
Miseratus fonte Ditis conubia.
|
||||
{{< /tab >}}
|
||||
|
||||
{{< tab "Windows" >}}
|
||||
|
||||
# Windows
|
||||
|
||||
This is tab **Windows** content.
|
||||
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
|
||||
Miseratus fonte Ditis conubia.
|
||||
{{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
@ -0,0 +1,22 @@
|
||||
---
|
||||
headless: true
|
||||
---
|
||||
|
||||
- [**Example Site**]({{< relref "/docs/example" >}})
|
||||
- [Table of Contents]({{< relref "/docs/example/table-of-contents" >}})
|
||||
- [With ToC]({{< relref "/docs/example/table-of-contents/with-toc" >}})
|
||||
- [Without ToC]({{< relref "/docs/example/table-of-contents/without-toc" >}})
|
||||
- [Collapsed]({{< relref "/docs/example/collapsed" >}})
|
||||
- [3rd]({{< relref "/docs/example/collapsed/3rd-level" >}})
|
||||
- [4th]({{< relref "/docs/example/collapsed/3rd-level/4th-level" >}})
|
||||
<br />
|
||||
|
||||
- **Shortcodes**
|
||||
- [Buttons]({{< relref "/docs/shortcodes/buttons" >}})
|
||||
- [Columns]({{< relref "/docs/shortcodes/columns" >}})
|
||||
- [Expand]({{< relref "/docs/shortcodes/expand" >}})
|
||||
- [Hints]({{< relref "/docs/shortcodes/hints" >}})
|
||||
- [Katex]({{< relref "/docs/shortcodes/katex" >}})
|
||||
- [Mermaid]({{< relref "/docs/shortcodes/mermaid" >}})
|
||||
- [Tabs]({{< relref "/docs/shortcodes/tabs" >}})
|
||||
<br />
|
||||
@ -0,0 +1,7 @@
|
||||
---
|
||||
menu:
|
||||
after:
|
||||
name: blog
|
||||
weight: 5
|
||||
title: Blog
|
||||
---
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,344 @@
|
||||
+++
|
||||
title = "(Hu)go Template Primer"
|
||||
description = ""
|
||||
tags = [
|
||||
"go",
|
||||
"golang",
|
||||
"templates",
|
||||
"themes",
|
||||
"development",
|
||||
]
|
||||
date = "2014-04-02"
|
||||
categories = [
|
||||
"Development",
|
||||
"golang",
|
||||
]
|
||||
menu = "main"
|
||||
+++
|
||||
|
||||
Hugo uses the excellent [Go][] [html/template][gohtmltemplate] library for
|
||||
its template engine. It is an extremely lightweight engine that provides a very
|
||||
small amount of logic. In our experience that it is just the right amount of
|
||||
logic to be able to create a good static website. If you have used other
|
||||
template systems from different languages or frameworks you will find a lot of
|
||||
similarities in Go templates.
|
||||
|
||||
This document is a brief primer on using Go templates. The [Go docs][gohtmltemplate]
|
||||
provide more details.
|
||||
|
||||
## Introduction to Go Templates
|
||||
|
||||
Go templates provide an extremely simple template language. It adheres to the
|
||||
belief that only the most basic of logic belongs in the template or view layer.
|
||||
One consequence of this simplicity is that Go templates parse very quickly.
|
||||
|
||||
A unique characteristic of Go templates is they are content aware. Variables and
|
||||
content will be sanitized depending on the context of where they are used. More
|
||||
details can be found in the [Go docs][gohtmltemplate].
|
||||
|
||||
## Basic Syntax
|
||||
|
||||
Golang templates are HTML files with the addition of variables and
|
||||
functions.
|
||||
|
||||
**Go variables and functions are accessible within {{ }}**
|
||||
|
||||
Accessing a predefined variable "foo":
|
||||
|
||||
{{ foo }}
|
||||
|
||||
**Parameters are separated using spaces**
|
||||
|
||||
Calling the add function with input of 1, 2:
|
||||
|
||||
{{ add 1 2 }}
|
||||
|
||||
**Methods and fields are accessed via dot notation**
|
||||
|
||||
Accessing the Page Parameter "bar"
|
||||
|
||||
{{ .Params.bar }}
|
||||
|
||||
**Parentheses can be used to group items together**
|
||||
|
||||
{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
|
||||
|
||||
|
||||
## Variables
|
||||
|
||||
Each Go template has a struct (object) made available to it. In hugo each
|
||||
template is passed either a page or a node struct depending on which type of
|
||||
page you are rendering. More details are available on the
|
||||
[variables](/layout/variables) page.
|
||||
|
||||
A variable is accessed by referencing the variable name.
|
||||
|
||||
<title>{{ .Title }}</title>
|
||||
|
||||
Variables can also be defined and referenced.
|
||||
|
||||
{{ $address := "123 Main St."}}
|
||||
{{ $address }}
|
||||
|
||||
|
||||
## Functions
|
||||
|
||||
Go template ship with a few functions which provide basic functionality. The Go
|
||||
template system also provides a mechanism for applications to extend the
|
||||
available functions with their own. [Hugo template
|
||||
functions](/layout/functions) provide some additional functionality we believe
|
||||
are useful for building websites. Functions are called by using their name
|
||||
followed by the required parameters separated by spaces. Template
|
||||
functions cannot be added without recompiling hugo.
|
||||
|
||||
**Example:**
|
||||
|
||||
{{ add 1 2 }}
|
||||
|
||||
## Includes
|
||||
|
||||
When including another template you will pass to it the data it will be
|
||||
able to access. To pass along the current context please remember to
|
||||
include a trailing dot. The templates location will always be starting at
|
||||
the /layout/ directory within Hugo.
|
||||
|
||||
**Example:**
|
||||
|
||||
{{ template "chrome/header.html" . }}
|
||||
|
||||
|
||||
## Logic
|
||||
|
||||
Go templates provide the most basic iteration and conditional logic.
|
||||
|
||||
### Iteration
|
||||
|
||||
Just like in Go, the Go templates make heavy use of range to iterate over
|
||||
a map, array or slice. The following are different examples of how to use
|
||||
range.
|
||||
|
||||
**Example 1: Using Context**
|
||||
|
||||
{{ range array }}
|
||||
{{ . }}
|
||||
{{ end }}
|
||||
|
||||
**Example 2: Declaring value variable name**
|
||||
|
||||
{{range $element := array}}
|
||||
{{ $element }}
|
||||
{{ end }}
|
||||
|
||||
**Example 2: Declaring key and value variable name**
|
||||
|
||||
{{range $index, $element := array}}
|
||||
{{ $index }}
|
||||
{{ $element }}
|
||||
{{ end }}
|
||||
|
||||
### Conditionals
|
||||
|
||||
If, else, with, or, & and provide the framework for handling conditional
|
||||
logic in Go Templates. Like range, each statement is closed with `end`.
|
||||
|
||||
|
||||
Go Templates treat the following values as false:
|
||||
|
||||
* false
|
||||
* 0
|
||||
* any array, slice, map, or string of length zero
|
||||
|
||||
**Example 1: If**
|
||||
|
||||
{{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
|
||||
|
||||
**Example 2: If -> Else**
|
||||
|
||||
{{ if isset .Params "alt" }}
|
||||
{{ index .Params "alt" }}
|
||||
{{else}}
|
||||
{{ index .Params "caption" }}
|
||||
{{ end }}
|
||||
|
||||
**Example 3: And & Or**
|
||||
|
||||
{{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
||||
|
||||
**Example 4: With**
|
||||
|
||||
An alternative way of writing "if" and then referencing the same value
|
||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
||||
and skips the block if the variable is absent.
|
||||
|
||||
The first example above could be simplified as:
|
||||
|
||||
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
|
||||
|
||||
**Example 5: If -> Else If**
|
||||
|
||||
{{ if isset .Params "alt" }}
|
||||
{{ index .Params "alt" }}
|
||||
{{ else if isset .Params "caption" }}
|
||||
{{ index .Params "caption" }}
|
||||
{{ end }}
|
||||
|
||||
## Pipes
|
||||
|
||||
One of the most powerful components of Go templates is the ability to
|
||||
stack actions one after another. This is done by using pipes. Borrowed
|
||||
from unix pipes, the concept is simple, each pipeline's output becomes the
|
||||
input of the following pipe.
|
||||
|
||||
Because of the very simple syntax of Go templates, the pipe is essential
|
||||
to being able to chain together function calls. One limitation of the
|
||||
pipes is that they only can work with a single value and that value
|
||||
becomes the last parameter of the next pipeline.
|
||||
|
||||
A few simple examples should help convey how to use the pipe.
|
||||
|
||||
**Example 1 :**
|
||||
|
||||
{{ if eq 1 1 }} Same {{ end }}
|
||||
|
||||
is the same as
|
||||
|
||||
{{ eq 1 1 | if }} Same {{ end }}
|
||||
|
||||
It does look odd to place the if at the end, but it does provide a good
|
||||
illustration of how to use the pipes.
|
||||
|
||||
**Example 2 :**
|
||||
|
||||
{{ index .Params "disqus_url" | html }}
|
||||
|
||||
Access the page parameter called "disqus_url" and escape the HTML.
|
||||
|
||||
**Example 3 :**
|
||||
|
||||
{{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
|
||||
Could be rewritten as
|
||||
|
||||
{{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
|
||||
|
||||
## Context (aka. the dot)
|
||||
|
||||
The most easily overlooked concept to understand about Go templates is that {{ . }}
|
||||
always refers to the current context. In the top level of your template this
|
||||
will be the data set made available to it. Inside of a iteration it will have
|
||||
the value of the current item. When inside of a loop the context has changed. .
|
||||
will no longer refer to the data available to the entire page. If you need to
|
||||
access this from within the loop you will likely want to set it to a variable
|
||||
instead of depending on the context.
|
||||
|
||||
**Example:**
|
||||
|
||||
{{ $title := .Site.Title }}
|
||||
{{ range .Params.tags }}
|
||||
<li> <a href="{{ $baseurl }}/tags/{{ . | urlize }}">{{ . }}</a> - {{ $title }} </li>
|
||||
{{ end }}
|
||||
|
||||
Notice how once we have entered the loop the value of {{ . }} has changed. We
|
||||
have defined a variable outside of the loop so we have access to it from within
|
||||
the loop.
|
||||
|
||||
# Hugo Parameters
|
||||
|
||||
Hugo provides the option of passing values to the template language
|
||||
through the site configuration (for sitewide values), or through the meta
|
||||
data of each specific piece of content. You can define any values of any
|
||||
type (supported by your front matter/config format) and use them however
|
||||
you want to inside of your templates.
|
||||
|
||||
|
||||
## Using Content (page) Parameters
|
||||
|
||||
In each piece of content you can provide variables to be used by the
|
||||
templates. This happens in the [front matter](/content/front-matter).
|
||||
|
||||
An example of this is used in this documentation site. Most of the pages
|
||||
benefit from having the table of contents provided. Sometimes the TOC just
|
||||
doesn't make a lot of sense. We've defined a variable in our front matter
|
||||
of some pages to turn off the TOC from being displayed.
|
||||
|
||||
Here is the example front matter:
|
||||
|
||||
```
|
||||
---
|
||||
title: "Permalinks"
|
||||
date: "2013-11-18"
|
||||
aliases:
|
||||
- "/doc/permalinks/"
|
||||
groups: ["extras"]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
```
|
||||
|
||||
Here is the corresponding code inside of the template:
|
||||
|
||||
{{ if not .Params.notoc }}
|
||||
<div id="toc" class="well col-md-4 col-sm-6">
|
||||
{{ .TableOfContents }}
|
||||
</div>
|
||||
{{ end }}
|
||||
|
||||
|
||||
|
||||
## Using Site (config) Parameters
|
||||
In your top-level configuration file (eg, `config.yaml`) you can define site
|
||||
parameters, which are values which will be available to you in chrome.
|
||||
|
||||
For instance, you might declare:
|
||||
|
||||
```yaml
|
||||
params:
|
||||
CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved."
|
||||
TwitterUser: "spf13"
|
||||
SidebarRecentLimit: 5
|
||||
```
|
||||
|
||||
Within a footer layout, you might then declare a `<footer>` which is only
|
||||
provided if the `CopyrightHTML` parameter is provided, and if it is given,
|
||||
you would declare it to be HTML-safe, so that the HTML entity is not escaped
|
||||
again. This would let you easily update just your top-level config file each
|
||||
January 1st, instead of hunting through your templates.
|
||||
|
||||
```
|
||||
{{if .Site.Params.CopyrightHTML}}<footer>
|
||||
<div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
|
||||
</footer>{{end}}
|
||||
```
|
||||
|
||||
An alternative way of writing the "if" and then referencing the same value
|
||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
||||
and skips the block if the variable is absent:
|
||||
|
||||
```
|
||||
{{with .Site.Params.TwitterUser}}<span class="twitter">
|
||||
<a href="https://twitter.com/{{.}}" rel="author">
|
||||
<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
|
||||
alt="Twitter"></a>
|
||||
</span>{{end}}
|
||||
```
|
||||
|
||||
Finally, if you want to pull "magic constants" out of your layouts, you can do
|
||||
so, such as in this example:
|
||||
|
||||
```
|
||||
<nav class="recent">
|
||||
<h1>Recent Posts</h1>
|
||||
<ul>{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
<li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
|
||||
{{end}}</ul>
|
||||
</nav>
|
||||
```
|
||||
|
||||
|
||||
[go]: https://golang.org/
|
||||
[gohtmltemplate]: https://golang.org/pkg/html/template/
|
||||
@ -0,0 +1,89 @@
|
||||
+++
|
||||
title = "Getting Started with Hugo"
|
||||
description = ""
|
||||
tags = [
|
||||
"go",
|
||||
"golang",
|
||||
"hugo",
|
||||
"development",
|
||||
]
|
||||
date = "2014-04-02"
|
||||
categories = [
|
||||
"Development",
|
||||
"golang",
|
||||
]
|
||||
menu = "main"
|
||||
+++
|
||||
|
||||
## Step 1. Install Hugo
|
||||
|
||||
Go to [Hugo releases](https://github.com/spf13/hugo/releases) and download the
|
||||
appropriate version for your OS and architecture.
|
||||
|
||||
Save it somewhere specific as we will be using it in the next step.
|
||||
|
||||
More complete instructions are available at [Install Hugo](https://gohugo.io/getting-started/installing/)
|
||||
|
||||
## Step 2. Build the Docs
|
||||
|
||||
Hugo has its own example site which happens to also be the documentation site
|
||||
you are reading right now.
|
||||
|
||||
Follow the following steps:
|
||||
|
||||
1. Clone the [Hugo repository](http://github.com/spf13/hugo)
|
||||
2. Go into the repo
|
||||
3. Run hugo in server mode and build the docs
|
||||
4. Open your browser to http://localhost:1313
|
||||
|
||||
Corresponding pseudo commands:
|
||||
|
||||
git clone https://github.com/spf13/hugo
|
||||
cd hugo
|
||||
/path/to/where/you/installed/hugo server --source=./docs
|
||||
> 29 pages created
|
||||
> 0 tags index created
|
||||
> in 27 ms
|
||||
> Web Server is available at http://localhost:1313
|
||||
> Press ctrl+c to stop
|
||||
|
||||
Once you've gotten here, follow along the rest of this page on your local build.
|
||||
|
||||
## Step 3. Change the docs site
|
||||
|
||||
Stop the Hugo process by hitting Ctrl+C.
|
||||
|
||||
Now we are going to run hugo again, but this time with hugo in watch mode.
|
||||
|
||||
/path/to/hugo/from/step/1/hugo server --source=./docs --watch
|
||||
> 29 pages created
|
||||
> 0 tags index created
|
||||
> in 27 ms
|
||||
> Web Server is available at http://localhost:1313
|
||||
> Watching for changes in /Users/spf13/Code/hugo/docs/content
|
||||
> Press ctrl+c to stop
|
||||
|
||||
|
||||
Open your [favorite editor](http://vim.spf13.com) and change one of the source
|
||||
content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
|
||||
|
||||
Content files are found in `docs/content/`. Unless otherwise specified, files
|
||||
are located at the same relative location as the url, in our case
|
||||
`docs/content/overview/quickstart.md`.
|
||||
|
||||
Change and save this file.. Notice what happened in your terminal.
|
||||
|
||||
> Change detected, rebuilding site
|
||||
|
||||
> 29 pages created
|
||||
> 0 tags index created
|
||||
> in 26 ms
|
||||
|
||||
Refresh the browser and observe that the typo is now fixed.
|
||||
|
||||
Notice how quick that was. Try to refresh the site before it's finished building. I double dare you.
|
||||
Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
|
||||
|
||||
## Step 4. Have fun
|
||||
|
||||
The best way to learn something is to play with it.
|
||||
@ -0,0 +1,156 @@
|
||||
---
|
||||
date: 2014-03-10
|
||||
linktitle: Migrating from Jekyll
|
||||
menu:
|
||||
main:
|
||||
parent: tutorials
|
||||
prev: /tutorials/mathjax
|
||||
title: Migrate to Hugo from Jekyll
|
||||
weight: 10
|
||||
---
|
||||
|
||||
## Move static content to `static`
|
||||
Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. Hugo keeps all static content under `static`. You should therefore move it all there.
|
||||
With Jekyll, something that looked like
|
||||
|
||||
▾ <root>/
|
||||
▾ images/
|
||||
logo.png
|
||||
|
||||
should become
|
||||
|
||||
▾ <root>/
|
||||
▾ static/
|
||||
▾ images/
|
||||
logo.png
|
||||
|
||||
Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`.
|
||||
|
||||
## Create your Hugo configuration file
|
||||
Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the [Hugo configuration documentation](/overview/configuration/) for details.
|
||||
|
||||
## Set your configuration publish folder to `_site`
|
||||
The default is for Jekyll to publish to `_site` and for Hugo to publish to `public`. If, like me, you have [`_site` mapped to a git submodule on the `gh-pages` branch](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html), you'll want to do one of two alternatives:
|
||||
|
||||
1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended).
|
||||
|
||||
git submodule deinit _site
|
||||
git rm _site
|
||||
git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
|
||||
|
||||
2. Or, change the Hugo configuration to use `_site` instead of `public`.
|
||||
|
||||
{
|
||||
..
|
||||
"publishdir": "_site",
|
||||
..
|
||||
}
|
||||
|
||||
## Convert Jekyll templates to Hugo templates
|
||||
That's the bulk of the work right here. The documentation is your friend. You should refer to [Jekyll's template documentation](http://jekyllrb.com/docs/templates/) if you need to refresh your memory on how you built your blog and [Hugo's template](/layout/templates/) to learn Hugo's way.
|
||||
|
||||
As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours.
|
||||
|
||||
## Convert Jekyll plugins to Hugo shortcodes
|
||||
Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port.
|
||||
|
||||
### Implementation
|
||||
As an example, I was using a custom [`image_tag`](https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb) plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing.
|
||||
|
||||
Jekyll's plugin:
|
||||
|
||||
module Jekyll
|
||||
class ImageTag < Liquid::Tag
|
||||
@url = nil
|
||||
@caption = nil
|
||||
@class = nil
|
||||
@link = nil
|
||||
// Patterns
|
||||
IMAGE_URL_WITH_CLASS_AND_CAPTION =
|
||||
IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
|
||||
IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
|
||||
IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
|
||||
IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
|
||||
def initialize(tag_name, markup, tokens)
|
||||
super
|
||||
if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
|
||||
@class = $1
|
||||
@url = $3
|
||||
@caption = $7
|
||||
@link = $9
|
||||
elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
|
||||
@class = $1
|
||||
@url = $3
|
||||
@caption = $7
|
||||
elsif markup =~ IMAGE_URL_WITH_CAPTION
|
||||
@url = $1
|
||||
@caption = $5
|
||||
elsif markup =~ IMAGE_URL_WITH_CLASS
|
||||
@class = $1
|
||||
@url = $3
|
||||
elsif markup =~ IMAGE_URL
|
||||
@url = $1
|
||||
end
|
||||
end
|
||||
def render(context)
|
||||
if @class
|
||||
source = "<figure class='#{@class}'>"
|
||||
else
|
||||
source = "<figure>"
|
||||
end
|
||||
if @link
|
||||
source += "<a href=\"#{@link}\">"
|
||||
end
|
||||
source += "<img src=\"#{@url}\">"
|
||||
if @link
|
||||
source += "</a>"
|
||||
end
|
||||
source += "<figcaption>#{@caption}</figcaption>" if @caption
|
||||
source += "</figure>"
|
||||
source
|
||||
end
|
||||
end
|
||||
end
|
||||
Liquid::Template.register_tag('image', Jekyll::ImageTag)
|
||||
|
||||
is written as this Hugo shortcode:
|
||||
|
||||
<!-- image -->
|
||||
<figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
|
||||
{{ with .Get "link"}}<a href="{{.}}">{{ end }}
|
||||
<img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
|
||||
{{ if .Get "link"}}</a>{{ end }}
|
||||
{{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
|
||||
<figcaption>{{ if isset .Params "title" }}
|
||||
{{ .Get "title" }}{{ end }}
|
||||
{{ if or (.Get "caption") (.Get "attr")}}<p>
|
||||
{{ .Get "caption" }}
|
||||
{{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
|
||||
{{ .Get "attr" }}
|
||||
{{ if .Get "attrlink"}}</a> {{ end }}
|
||||
</p> {{ end }}
|
||||
</figcaption>
|
||||
{{ end }}
|
||||
</figure>
|
||||
<!-- image -->
|
||||
|
||||
### Usage
|
||||
I simply changed:
|
||||
|
||||
{% image full http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg "One of my favorite touristy-type photos. I secretly waited for the good light while we were "having fun" and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." ->http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/ %}
|
||||
|
||||
to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`):
|
||||
|
||||
{{%/* fig class="full" src="http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg" title="One of my favorite touristy-type photos. I secretly waited for the good light while we were having fun and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." link="http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/" */%}}
|
||||
|
||||
As a bonus, the shortcode named parameters are, arguably, more readable.
|
||||
|
||||
## Finishing touches
|
||||
### Fix content
|
||||
Depending on the amount of customization that was done with each post with Jekyll, this step will require more or less effort. There are no hard and fast rules here except that `hugo server --watch` is your friend. Test your changes and fix errors as needed.
|
||||
|
||||
### Clean up
|
||||
You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it.
|
||||
|
||||
## A practical example in a diff
|
||||
[Hey, it's Alex](http://heyitsalex.net/) was migrated in less than a _father-with-kids day_ from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this [diff](https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610).
|
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
|
||||
{"Target":"book.min.6c7c6446dfdee7c8c933e9bbc6e80ee3ed6c913b2a59519f2092c3c6a9d63e55.css","MediaType":"text/css","Data":{"Integrity":"sha256-bHxkRt/e58jJM+m7xugO4+1skTsqWVGfIJLDxqnWPlU="}}
|
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
|
||||
{"Target":"book.min.284c8fc21ced13c579d9027a9d14893c56b243c6045001180391cebb4cc36ab8.css","MediaType":"text/css","Data":{"Integrity":"sha256-KEyPwhztE8V52QJ6nRSJPFayQ8YEUAEYA5HOu0zDarg="}}
|
||||
@ -0,0 +1,21 @@
|
||||
# This should be removed in future, 'cn' is moved to `zh'
|
||||
- id: Search
|
||||
translation: 搜索
|
||||
|
||||
- id: Edit this page
|
||||
translation: 编辑本页
|
||||
|
||||
- id: Last modified by
|
||||
translation: 最后修改者
|
||||
|
||||
- id: Expand
|
||||
translation: 展开
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: |
|
||||
{
|
||||
encode: false,
|
||||
tokenize: function(str) {
|
||||
return str.replace(/[\x00-\x7F]/g, '').split('');
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
- id: Search
|
||||
translation: Vyhledávat
|
||||
|
||||
- id: Edit this page
|
||||
translation: Upravit tuto stránku
|
||||
|
||||
- id: Last modified by
|
||||
translation: Autor poslední změny
|
||||
|
||||
- id: Expand
|
||||
translation: Rozbalit
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
@ -0,0 +1,14 @@
|
||||
- id: Search
|
||||
translation: Suche
|
||||
|
||||
- id: Edit this page
|
||||
translation: Seite bearbeiten
|
||||
|
||||
- id: Last modified by
|
||||
translation: Zuletzt geändert von
|
||||
|
||||
- id: Expand
|
||||
translation: Erweitern
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
@ -0,0 +1,14 @@
|
||||
- id: Search
|
||||
translation: Search
|
||||
|
||||
- id: Edit this page
|
||||
translation: Edit this page
|
||||
|
||||
- id: Last modified by
|
||||
translation: Last modified by
|
||||
|
||||
- id: Expand
|
||||
translation: Expand
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
@ -0,0 +1,14 @@
|
||||
- id: Search
|
||||
translation: Buscar
|
||||
|
||||
- id: Edit this page
|
||||
translation: Editar esta página
|
||||
|
||||
- id: Last modified by
|
||||
translation: Última modificación por
|
||||
|
||||
- id: Expand
|
||||
translation: Expand
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
@ -0,0 +1,14 @@
|
||||
- id: Search
|
||||
translation: Rechercher
|
||||
|
||||
- id: Edit this page
|
||||
translation: Modifier cette page
|
||||
|
||||
- id: Last modified by
|
||||
translation: Dernière modification par
|
||||
|
||||
- id: Expand
|
||||
translation: Développer
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
@ -0,0 +1,20 @@
|
||||
- id: Search
|
||||
translation: 検索
|
||||
|
||||
- id: Edit this page
|
||||
translation: このページを編集する
|
||||
|
||||
- id: Last modified by
|
||||
translation: 最終更新者
|
||||
|
||||
- id: Expand
|
||||
translation: 展開
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: |
|
||||
{
|
||||
encode: false,
|
||||
tokenize: function(str) {
|
||||
return str.replace(/[\x00-\x7F]/g, '').split('');
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,21 @@
|
||||
# This should be removed in future, 'jp' is moved to `ja'
|
||||
- id: Search
|
||||
translation: 検索
|
||||
|
||||
- id: Edit this page
|
||||
translation: このページを編集する
|
||||
|
||||
- id: Last modified by
|
||||
translation: 最終更新者
|
||||
|
||||
- id: Expand
|
||||
translation: 展開
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: |
|
||||
{
|
||||
encode: false,
|
||||
tokenize: function(str) {
|
||||
return str.replace(/[\x00-\x7F]/g, '').split('');
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,20 @@
|
||||
- id: Search
|
||||
translation: Search
|
||||
|
||||
- id: Edit this page
|
||||
translation: Edit this page
|
||||
|
||||
- id: Last modified by
|
||||
translation: Last modified by
|
||||
|
||||
- id: Expand
|
||||
translation: Expand
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: |
|
||||
{
|
||||
encode: false,
|
||||
tokenize: function(str) {
|
||||
return str.replace(/[\x00-\x7F]/g, '').split('');
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
- id: Search
|
||||
translation: Søk
|
||||
|
||||
- id: Edit this page
|
||||
translation: Rediger denne siden
|
||||
|
||||
- id: Last modified by
|
||||
translation: Sist endret av
|
||||
|
||||
- id: Expand
|
||||
translation: Utvid
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue