Compare commits
No commits in common. "master" and "v5" have entirely different histories.
|
|
@ -1,34 +1,18 @@
|
|||
name: Build with Hugo
|
||||
|
||||
on: [push, pull_request]
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
hugo:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
hugo-version:
|
||||
- 'latest'
|
||||
- '0.134.2'
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true # Fetch Hugo themes (true OR recursive)
|
||||
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
|
||||
- uses: actions/checkout@master
|
||||
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@v3
|
||||
with:
|
||||
hugo-version: ${{ matrix.hugo-version }}
|
||||
extended: true
|
||||
- name: Install Hugo
|
||||
run: |
|
||||
wget https://github.com/gohugoio/hugo/releases/download/v0.59.1/hugo_extended_0.59.1_Linux-64bit.deb -O /tmp/hugo.deb
|
||||
sudo dpkg -i /tmp/hugo.deb
|
||||
|
||||
- name: Run Hugo
|
||||
working-directory: exampleSite
|
||||
run: hugo --themesDir ../..
|
||||
|
||||
# - name: Deploy
|
||||
# uses: peaceiris/actions-gh-pages@v3
|
||||
# with:
|
||||
# github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# publish_dir: ./public
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,3 @@
|
|||
public/
|
||||
exampleSite/public/
|
||||
.DS_Store
|
||||
.hugo_build.lock
|
||||
resources/
|
||||
|
|
|
|||
321
README.md
321
README.md
|
|
@ -1,12 +1,11 @@
|
|||
# Hugo Book Theme
|
||||
|
||||
[](https://gohugo.io)
|
||||
[](https://gohugo.io)
|
||||
[](LICENSE)
|
||||
|
||||
|
||||
### [Hugo](https://gohugo.io) documentation theme as simple as plain book
|
||||
|
||||
|
||||
|
||||
|
||||
- [Features](#features)
|
||||
- [Requirements](#requirements)
|
||||
|
|
@ -15,7 +14,6 @@
|
|||
- [Blog](#blog)
|
||||
- [Configuration](#configuration)
|
||||
- [Shortcodes](#shortcodes)
|
||||
- [Versioning](#versioning)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Features
|
||||
|
|
@ -24,98 +22,102 @@
|
|||
- Light and Mobile-Friendly
|
||||
- Multi-language support
|
||||
- Customisable
|
||||
- Designed to not interfere with other layouts
|
||||
- Zero initial configuration
|
||||
- Handy shortcodes
|
||||
- Comments support
|
||||
- Simple blog and taxonomy
|
||||
- Primary features work without JavaScript
|
||||
- Dark Mode
|
||||
|
||||
## Requirements
|
||||
|
||||
- Hugo 0.134 or higher
|
||||
- Hugo extended version, [Installation Instructions](https://gohugo.io/installation/)
|
||||
- Hugo 0.56 or higher
|
||||
- Hugo extended version, read more [here](https://gohugo.io/news/0.48-relnotes/)
|
||||
|
||||
## Installation
|
||||
|
||||
### Install as git submodule
|
||||
Navigate to your hugo project root and run:
|
||||
|
||||
```
|
||||
git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book
|
||||
git submodule add https://github.com/alex-shpak/hugo-book themes/book
|
||||
```
|
||||
|
||||
Then run hugo (or set `theme = "hugo-book"`/`theme: hugo-book` in configuration file)
|
||||
Then run hugo (or set `theme = "book"`/`theme: book` in configuration file)
|
||||
|
||||
```
|
||||
hugo server --minify --theme hugo-book
|
||||
```
|
||||
|
||||
### Install as hugo module
|
||||
|
||||
You can also add this theme as a Hugo module instead of a git submodule.
|
||||
|
||||
Start with initializing hugo modules, if not done yet:
|
||||
```
|
||||
hugo mod init github.com/repo/path
|
||||
```
|
||||
|
||||
Navigate to your hugo project root and add [module] section to your `hugo.toml`:
|
||||
|
||||
```toml
|
||||
[module]
|
||||
[[module.imports]]
|
||||
path = 'github.com/alex-shpak/hugo-book'
|
||||
```
|
||||
|
||||
Then, to load/update the theme module and run hugo:
|
||||
|
||||
```sh
|
||||
hugo mod get -u
|
||||
hugo server --minify
|
||||
hugo server --minify --theme book
|
||||
```
|
||||
|
||||
### Creating site from scratch
|
||||
|
||||
Below is an example on how to create a new site from scratch:
|
||||
Below is example how to create new site from scratch
|
||||
|
||||
```sh
|
||||
hugo new site mydocs; cd mydocs
|
||||
git init
|
||||
git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book
|
||||
cp -R themes/hugo-book/exampleSite/content.en/* ./content
|
||||
git submodule add https://github.com/alex-shpak/hugo-book themes/book
|
||||
cp -R themes/book/exampleSite/content .
|
||||
```
|
||||
|
||||
```sh
|
||||
hugo server --minify --theme hugo-book
|
||||
hugo server --minify --theme book
|
||||
```
|
||||
|
||||
## Menu
|
||||
|
||||
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, as well as other parameters to hide or alter urls in the menu. You can choose which folder to use for generating menu with `BookSection` configuration parameter.
|
||||
### File tree menu (default)
|
||||
|
||||
By default theme will render pages from `content/docs` section as menu in a tree structure.
|
||||
You can set `title` and `weight` in front matter of pages to adjust order and titles in menu.
|
||||
|
||||
### Leaf bundle menu
|
||||
|
||||
You can also use leaf bundle and content of it's `index.md` as menu.
|
||||
Given you have this file structure
|
||||
|
||||
```
|
||||
├── content
|
||||
│ ├── docs
|
||||
│ │ ├── page-one.md
|
||||
│ │ └── page-two.md
|
||||
│ └── posts
|
||||
│ ├── post-one.md
|
||||
│ └── post-two.md
|
||||
```
|
||||
|
||||
Create file `content/docs/menu/index.md` with 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 settings `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.
|
||||
Simple blog supported for section `posts`.
|
||||
Blog is not primary use case so book theme so it has only minimal features
|
||||
|
||||
## Configuration
|
||||
|
||||
### Site Configuration
|
||||
|
||||
There are a few configuration options that you can add to your `hugo.toml` file.
|
||||
You can also see the `yaml` example [here](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/hugo.yaml).
|
||||
There are few configuration options you can add to your `config.toml` file.
|
||||
You can also see `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
|
||||
|
||||
|
|
@ -128,19 +130,19 @@ enableGitInfo = true
|
|||
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 6) Set how many table of contents levels to be showed on page.
|
||||
# Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
|
||||
# You can also specify this parameter per page in front matter
|
||||
BookToC = 3
|
||||
|
||||
# (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'
|
||||
|
|
@ -149,17 +151,10 @@ disableKinds = ['taxonomy', 'taxonomyTerm']
|
|||
# Used for 'Last Modified' and 'Edit this page' links.
|
||||
BookRepo = 'https://github.com/alex-shpak/hugo-book'
|
||||
|
||||
# Specifies commit portion of the link to the page's last modified commit hash for 'doc' page
|
||||
# type.
|
||||
# Required if 'BookRepo' param is set.
|
||||
# Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
|
||||
# Github uses 'commit', Bitbucket uses 'commits'
|
||||
BookCommitPath = 'commit'
|
||||
|
||||
# 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'
|
||||
# Path must point to 'content' directory of repo.
|
||||
BookEditPath = 'edit/master/exampleSite/content'
|
||||
|
||||
# (Optional, default January 2, 2006) Configure the date format used on the pages
|
||||
# - In git information
|
||||
|
|
@ -168,80 +163,47 @@ disableKinds = ['taxonomy', 'taxonomyTerm']
|
|||
|
||||
# (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:
|
||||
You can specify additional params per page in front matter
|
||||
|
||||
```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.
|
||||
# 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.
|
||||
bookFlatSection = false
|
||||
# (Optional) Set to mark page as flat section in file-tree menu (if BookMenuBundle not set)
|
||||
bookFlatSection = true
|
||||
|
||||
# (Optional) Set to hide nested sections or pages at that level. Works only with file-tree menu mode
|
||||
# (Optional, Experimental) 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.
|
||||
bookHidden = false
|
||||
# (Optional) Set true to hide page or section from side menu (if BookMenuBundle not set)
|
||||
bookHidden = true
|
||||
|
||||
# (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
|
||||
|
||||
# (Optional) Set explicit href attribute for this page in a menu.
|
||||
bookHref = ''
|
||||
# (Optional) Set how many levels of ToC to show. use 'false' to hide ToC completely
|
||||
bookToC = 3
|
||||
```
|
||||
|
||||
### Partials
|
||||
|
||||
There are layout partials available for you to easily override components of the theme in `layouts/partials/`.
|
||||
There are few empty partials you can override in `layouts/partials/`
|
||||
|
||||
In addition to this, there are several empty partials you can override to easily add/inject code.
|
||||
|
||||
| Empty Partial | Placement |
|
||||
| -------------------------------------------------- | ------------------------------------------- |
|
||||
| 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/footer.html` | After page 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
|
||||
|
||||
|
|
@ -251,56 +213,108 @@ In addition to this, there are several empty partials you can override to easily
|
|||
| `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) |
|
||||
| `assets/mermaid.json` | Replace Mermaid initialization config |
|
||||
|
||||
### Plugins
|
||||
|
||||
There are a few features implemented as pluggable `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>`
|
||||
There are few hugo tempaltes inserted in `<head>`
|
||||
|
||||
- [Google Analytics](https://gohugo.io/templates/internal/#google-analytics)
|
||||
- [Open Graph](https://gohugo.io/templates/internal/#open-graph)
|
||||
|
||||
To disable Open Graph inclusion you can create your own empty file `\layouts\_internal\opengraph.html`.
|
||||
In fact almost empty not quite empty because an empty file looks like absent for HUGO. For example:
|
||||
```
|
||||
<!-- -->
|
||||
```
|
||||
|
||||
## Shortcodes
|
||||
|
||||
- [Buttons](https://hugo-book-demo.netlify.app/docs/shortcodes/buttons/)
|
||||
- [Columns](https://hugo-book-demo.netlify.app/docs/shortcodes/columns/)
|
||||
- [Details](https://hugo-book-demo.netlify.app/docs/shortcodes/details/)
|
||||
- [Hints](https://hugo-book-demo.netlify.app/docs/shortcodes/hints/)
|
||||
- [KaTeX](https://hugo-book-demo.netlify.app/docs/shortcodes/katex/)
|
||||
- [Mermaid](https://hugo-book-demo.netlify.app/docs/shortcodes/mermaid/)
|
||||
- [Tabs](https://hugo-book-demo.netlify.app/docs/shortcodes/tabs/)
|
||||
### Hint
|
||||
|
||||
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.
|
||||
Hint shortcode can be used as hint/alerts/notification block. There are 3 colors to choose: `info`, `warning` and `danger`.
|
||||
|
||||
```toml
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
```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 >}}
|
||||
```
|
||||
|
||||
If you are using `config.yaml` or `config.json`, consult the [configuration markup](https://gohugo.io/getting-started/configuration-markup/)
|
||||
### Buttons
|
||||
|
||||
## Versioning
|
||||
Buttons are styled links to internal of external pages
|
||||
|
||||
This theme follows a simple incremental versioning. e.g. `v1`, `v2` and so on. There might be breaking changes between versions.
|
||||
```
|
||||
{{< button relref="/" >}}Get Home{{< /button >}}
|
||||
{{< button href="https://github.com/alex-shpak/hugo-book" >}}Contribute{{< /button >}}
|
||||
```
|
||||
|
||||
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.
|
||||
### Tabs
|
||||
|
||||
Useful if you want to show alternative information per platform or setting.
|
||||
|
||||
```
|
||||
{{< tabs "uniqueid" >}}
|
||||
{{< tab "MacOS" >}} # MacOS Content {{< /tab >}}
|
||||
{{< tab "Linux" >}} # Linux Content {{< /tab >}}
|
||||
{{< tab "Windows" >}} # Windows Content {{< /tab >}}
|
||||
{{< /tabs >}}
|
||||
```
|
||||
|
||||
### Multi column text
|
||||
|
||||
Organize text in 2 or more columns to use space efficiently.
|
||||
|
||||
```html
|
||||
{{< columns >}} <!-- begin columns block -->
|
||||
# Left Content Lorem markdownum insigne...
|
||||
|
||||
<---> <!-- magic sparator, between columns -->
|
||||
|
||||
# Mid Content Lorem markdownum insigne...
|
||||
|
||||
<---> <!-- magic sparator, between columns -->
|
||||
|
||||
# Right Content Lorem markdownum insigne...
|
||||
{{< /columns >}}
|
||||
```
|
||||
|
||||
### Expand
|
||||
|
||||
Provides clickable panel that show extra hidden content.
|
||||
|
||||
```
|
||||
{{< expand >}}
|
||||
## Markdown content
|
||||
{{< /expand >}}
|
||||
```
|
||||
|
||||
### Mermaid Charts
|
||||
|
||||
Render various charts with [mermaidjs](https://mermaidjs.github.io/)
|
||||
|
||||
```
|
||||
{{< 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 >}}
|
||||
```
|
||||
|
||||
### KaTeX Syntax
|
||||
|
||||
Render math formulas with [KaTeX](https://katex.org/)
|
||||
|
||||
```
|
||||
{{< katex >}}
|
||||
x = \begin{cases}
|
||||
a &\text{if } b \\
|
||||
c &\text{if } d
|
||||
\end{cases}
|
||||
{{< /katex >}}
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
@ -309,9 +323,8 @@ If you want lower maintenance, use one of the released versions. If you want to
|
|||
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.
|
||||
- Keep it simple
|
||||
- Keep minimal (or zero) default configuration
|
||||
- Avoid interference with user-defined layouts
|
||||
|
||||
Feel free to open issues if you find missing configuration or customisation options.
|
||||
Feel free to open issue if you missing some configuration or customisation option.
|
||||
|
|
|
|||
|
|
@ -2,9 +2,6 @@
|
|||
title: "{{ .Name | humanize | title }}"
|
||||
weight: 1
|
||||
# bookFlatSection: false
|
||||
# bookToc: true
|
||||
# bookToc: 6
|
||||
# bookHidden: false
|
||||
# bookCollapseSection: false
|
||||
# bookComments: false
|
||||
# bookSearchExclude: false
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,6 +1,4 @@
|
|||
---
|
||||
title: "{{ .Name | humanize | title }}"
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
# bookComments: false
|
||||
# bookSearchExclude: false
|
||||
---
|
||||
|
|
|
|||
|
|
@ -9,57 +9,41 @@ $font-size-12: 0.75rem !default;
|
|||
$font-size-14: 0.875rem !default;
|
||||
$font-size-16: 1rem !default;
|
||||
|
||||
$border-radius: $padding-4 !default;
|
||||
$border-radius: 0.15rem !default;
|
||||
|
||||
// Grayscale
|
||||
$white: #ffffff !default;
|
||||
$gray-100: #f8f9fa !default;
|
||||
$gray-200: #e9ecef !default;
|
||||
$gray-300: #dee2e6 !default;
|
||||
$gray-400: #ced4da !default;
|
||||
$gray-500: #adb5bd !default;
|
||||
$gray-600: #868e96 !default;
|
||||
$gray-700: #495057 !default;
|
||||
$gray-800: #343a40 !default;
|
||||
$gray-900: #212529 !default;
|
||||
$black: #000 !default;
|
||||
|
||||
$color-link: #05b !default;
|
||||
$color-visited-link: #8440f1 !default;
|
||||
|
||||
$body-background: white !default;
|
||||
$body-font-color: $gray-800 !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;
|
||||
$md-breakpoint: $menu-width + $body-min-width * 1.25 + $toc-width !default;
|
||||
$sm-breakpoint: $menu-width + $body-min-width !default;
|
||||
|
||||
// Panel colors
|
||||
$hint-colors: (
|
||||
info: #6bf,
|
||||
warning: #fd6,
|
||||
danger: #f66,
|
||||
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: #494e54;
|
||||
--gray-200: #5c6165;
|
||||
--gray-500: #999d9f;
|
||||
|
||||
--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;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,28 +1,43 @@
|
|||
/* 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: fallback;
|
||||
src: url(https://fonts.gstatic.com/s/roboto/v32/KFOmCnqEu92Fr1Mu4mxKKTU1Kg.woff2) format('woff2');
|
||||
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
|
||||
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: fallback;
|
||||
src: url(https://fonts.gstatic.com/s/roboto/v32/KFOlCnqEu92Fr1MmWUlfBBc4AMP6lQ.woff2) format('woff2');
|
||||
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
|
||||
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: fallback;
|
||||
src: url(https://fonts.gstatic.com/s/robotomono/v23/L0xuDF4xlVMF-BfR8bXMIhJHg45mwgGEFl0_3vq_ROW4AJi8SJQt.woff2) format('woff2');
|
||||
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
|
||||
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 {
|
||||
|
|
|
|||
|
|
@ -1,17 +1,21 @@
|
|||
html {
|
||||
font-size: $font-size-base;
|
||||
letter-spacing: 0.33px;
|
||||
scroll-behavior: smooth;
|
||||
touch-action: manipulation;
|
||||
scrollbar-gutter: stable;
|
||||
}
|
||||
|
||||
html,
|
||||
body {
|
||||
min-width: $body-min-width;
|
||||
overflow-x: hidden;
|
||||
}
|
||||
|
||||
body {
|
||||
min-width: $body-min-width;
|
||||
color: var(--body-font-color);
|
||||
background: var(--body-background);
|
||||
color: $body-font-color;
|
||||
background: $body-background;
|
||||
|
||||
// letter-spacing: 0.33px;
|
||||
font-weight: $body-font-weight;
|
||||
|
||||
text-rendering: optimizeLegibility;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
|
|
@ -32,17 +36,17 @@ h5 {
|
|||
|
||||
a {
|
||||
text-decoration: none;
|
||||
color: var(--color-link);
|
||||
color: $color-link;
|
||||
|
||||
&:visited {
|
||||
color: $color-visited-link;
|
||||
}
|
||||
}
|
||||
|
||||
img {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
|
||||
:focus {
|
||||
@include outline;
|
||||
}
|
||||
|
||||
aside nav ul {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
|
|
@ -50,7 +54,6 @@ aside nav ul {
|
|||
|
||||
li {
|
||||
margin: 1em 0;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
a {
|
||||
|
|
@ -62,15 +65,24 @@ aside nav ul {
|
|||
}
|
||||
|
||||
ul {
|
||||
padding-inline-start: $padding-16;
|
||||
padding-left: $padding-16;
|
||||
}
|
||||
}
|
||||
|
||||
// Classes to hide nested levels of ToC/Menu
|
||||
.levels-1 ul ul,
|
||||
.levels-2 ul ul ul,
|
||||
.levels-3 ul ul ul ul,
|
||||
.levels-4 ul ul ul ul ul,
|
||||
.levels-5 ul ul ul ul ul ul,
|
||||
.levels-6 ul ul ul ul ul ul ul {
|
||||
display: none;
|
||||
}
|
||||
|
||||
ul.pagination {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
list-style-type: none;
|
||||
padding-inline-start: 0px;
|
||||
|
||||
.page-item a {
|
||||
padding: $padding-16;
|
||||
|
|
@ -82,24 +94,14 @@ ul.pagination {
|
|||
margin: 0 auto;
|
||||
}
|
||||
|
||||
.book-icon {
|
||||
filter: var(--icon-filter);
|
||||
}
|
||||
|
||||
a .book-icon {
|
||||
height: 1em;
|
||||
width: 1em;
|
||||
margin-inline-end: .5em;
|
||||
}
|
||||
|
||||
.book-brand {
|
||||
margin-top: 0;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
img {
|
||||
height: 1.5em;
|
||||
width: 1.5em;
|
||||
margin-inline-end: $padding-8;
|
||||
width: auto;
|
||||
vertical-align: middle;
|
||||
margin-right: $padding-8;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -107,64 +109,36 @@ a .book-icon {
|
|||
flex: 0 0 $menu-width;
|
||||
font-size: $font-size-14;
|
||||
|
||||
.book-menu-content {
|
||||
nav {
|
||||
width: $menu-width;
|
||||
padding: $padding-16;
|
||||
background: var(--body-background);
|
||||
|
||||
@include fixed;
|
||||
}
|
||||
|
||||
a,
|
||||
label {
|
||||
a {
|
||||
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;
|
||||
}
|
||||
|
||||
input.toggle + label::after {
|
||||
content: "▸";
|
||||
}
|
||||
|
||||
input.toggle:checked + label::after {
|
||||
content: "▾";
|
||||
}
|
||||
}
|
||||
|
||||
// for RTL support
|
||||
body[dir="rtl"] .book-menu {
|
||||
input.toggle + label::after {
|
||||
content: "◂";
|
||||
}
|
||||
|
||||
input.toggle:checked + label::after {
|
||||
content: "▾";
|
||||
color: $color-link;
|
||||
}
|
||||
}
|
||||
|
||||
.book-section-flat {
|
||||
margin: $padding-16 * 2 0;
|
||||
margin-bottom: $padding-16 * 2;
|
||||
|
||||
&:not(:first-child) {
|
||||
margin-top: $padding-16 * 2;
|
||||
}
|
||||
|
||||
> a,
|
||||
> span,
|
||||
> label {
|
||||
> span {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
> ul {
|
||||
padding-inline-start: 0;
|
||||
padding-left: 0;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -174,38 +148,9 @@ body[dir="rtl"] .book-menu {
|
|||
padding: $padding-16;
|
||||
}
|
||||
|
||||
.book-post {
|
||||
margin-bottom: $padding-16 * 2;
|
||||
|
||||
.book-post-date img {
|
||||
height: 1em;
|
||||
width: 1em;
|
||||
margin-inline-end: .5em;
|
||||
}
|
||||
|
||||
.book-post-content > :first-child {
|
||||
margin-top: $padding-16;
|
||||
}
|
||||
}
|
||||
|
||||
.book-header {
|
||||
display: none;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
label {
|
||||
line-height: 0;
|
||||
}
|
||||
|
||||
h3 {
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
margin: 0 $padding-16;
|
||||
}
|
||||
|
||||
img.book-icon {
|
||||
height: 1.5em;
|
||||
width: 1.5em;
|
||||
}
|
||||
display: none;
|
||||
}
|
||||
|
||||
.book-search {
|
||||
|
|
@ -213,15 +158,21 @@ body[dir="rtl"] .book-menu {
|
|||
margin: $padding-16 0;
|
||||
border-bottom: 1px solid transparent;
|
||||
|
||||
&::after {
|
||||
display: block;
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
input {
|
||||
width: 100%;
|
||||
padding: $padding-8;
|
||||
|
||||
border: 0;
|
||||
border-radius: $border-radius;
|
||||
border-radius: $padding-4;
|
||||
|
||||
background: var(--gray-100);
|
||||
color: var(--body-font-color);
|
||||
background: $gray-100;
|
||||
color: $body-font-color;
|
||||
|
||||
&:required + .book-search-spinner {
|
||||
display: block;
|
||||
|
|
@ -230,30 +181,26 @@ body[dir="rtl"] .book-menu {
|
|||
|
||||
.book-search-spinner {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
margin: $padding-8;
|
||||
margin-inline-start: calc(100% - #{$padding-16 + $padding-8});
|
||||
right: 0;
|
||||
top: 0;
|
||||
|
||||
width: $padding-16;
|
||||
height: $padding-16;
|
||||
|
||||
border: $padding-1 solid transparent;
|
||||
border-top-color: var(--body-font-color);
|
||||
border-top-color: $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 {
|
||||
nav {
|
||||
width: $toc-width;
|
||||
padding: $padding-16;
|
||||
|
||||
|
|
@ -262,7 +209,6 @@ body[dir="rtl"] .book-menu {
|
|||
|
||||
img {
|
||||
height: 1em;
|
||||
width: 1em;
|
||||
}
|
||||
|
||||
nav > ul > li:first-child {
|
||||
|
|
@ -271,104 +217,128 @@ body[dir="rtl"] .book-menu {
|
|||
}
|
||||
|
||||
.book-footer {
|
||||
display: flex;
|
||||
padding-top: $padding-16;
|
||||
font-size: $font-size-14;
|
||||
|
||||
img {
|
||||
height: 1em;
|
||||
margin-right: $padding-8;
|
||||
}
|
||||
}
|
||||
|
||||
.book-comments {
|
||||
margin-top: $padding-16;
|
||||
}
|
||||
|
||||
.book-languages {
|
||||
margin-block-end: $padding-16 * 2;
|
||||
position: relative;
|
||||
overflow: visible;
|
||||
|
||||
padding: $padding-16;
|
||||
margin: -$padding-16;
|
||||
|
||||
&:hover .book-languages-list {
|
||||
display: block;
|
||||
}
|
||||
|
||||
.book-languages-list {
|
||||
display: none;
|
||||
|
||||
position: absolute;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
padding: $padding-8 0;
|
||||
|
||||
background: $body-background;
|
||||
box-shadow: 0 0 $padding-4 rgba(0, 0, 0, 0.1);
|
||||
|
||||
li {
|
||||
padding: $padding-8 $padding-16;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
img {
|
||||
opacity: .1;
|
||||
}
|
||||
|
||||
li.active img {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
a {
|
||||
color: inherit;
|
||||
}
|
||||
}
|
||||
|
||||
ul {
|
||||
padding-inline-start: 1.5em;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
list-style: none;
|
||||
}
|
||||
}
|
||||
|
||||
.book-posts {
|
||||
min-width: $body-min-width;
|
||||
max-width: $body-min-width * 2;
|
||||
flex-grow: 1;
|
||||
padding: $padding-16;
|
||||
|
||||
article {
|
||||
padding-bottom: $padding-16;
|
||||
}
|
||||
}
|
||||
|
||||
.book-home {
|
||||
padding: $padding-16;
|
||||
}
|
||||
|
||||
// Responsive styles
|
||||
.book-menu-content,
|
||||
.book-toc-content,
|
||||
aside nav,
|
||||
.book-page,
|
||||
.book-header aside,
|
||||
.book-posts,
|
||||
.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;
|
||||
z-index: 1;
|
||||
transition-property: transform, margin-left, opacity;
|
||||
will-change: transform, margin-left;
|
||||
}
|
||||
|
||||
@media screen and (max-width: $md-breakpoint) {
|
||||
.book-toc {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: $sm-breakpoint) {
|
||||
.book-menu {
|
||||
margin-left: -$menu-width;
|
||||
font-size: $font-size-base;
|
||||
}
|
||||
|
||||
.book-header {
|
||||
display: block;
|
||||
display: flex;
|
||||
}
|
||||
|
||||
#menu-control:focus ~ main label[for="menu-control"] {
|
||||
@include outline;
|
||||
}
|
||||
|
||||
#menu-control:checked ~ main {
|
||||
.book-menu {
|
||||
visibility: initial;
|
||||
}
|
||||
|
||||
.book-menu .book-menu-content {
|
||||
#menu-control:checked + main {
|
||||
.book-menu nav,
|
||||
.book-page,
|
||||
.book-posts {
|
||||
transform: translateX($menu-width);
|
||||
box-shadow: 0 0 $padding-8 rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.book-page {
|
||||
.book-header label {
|
||||
transform: rotate(90deg);
|
||||
}
|
||||
|
||||
.markdown {
|
||||
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 {
|
||||
.book-posts,
|
||||
.book-menu nav,
|
||||
.book-toc nav {
|
||||
padding: $padding-16 * 2 $padding-16;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,54 +1,33 @@
|
|||
@import "variables";
|
||||
@import 'variables';
|
||||
|
||||
.markdown {
|
||||
line-height: 1.6;
|
||||
line-height: 1.6em;
|
||||
|
||||
// remove padding at the beginning of page
|
||||
> :first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-weight: normal;
|
||||
line-height: 1;
|
||||
line-height: 1em;
|
||||
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 {
|
||||
h4, h5, h6 {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
h5 {
|
||||
font-size: 0.875em;
|
||||
font-size: .875em;
|
||||
}
|
||||
|
||||
h6 {
|
||||
font-size: 0.75em;
|
||||
font-size: .75em;
|
||||
}
|
||||
|
||||
b,
|
||||
optgroup,
|
||||
strong {
|
||||
b, optgroup, strong {
|
||||
font-weight: bolder;
|
||||
}
|
||||
|
||||
|
|
@ -58,30 +37,22 @@
|
|||
&:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
&:visited {
|
||||
color: var(--color-visited-link);
|
||||
}
|
||||
}
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
code {
|
||||
direction: ltr;
|
||||
unicode-bidi: embed;
|
||||
padding: 0 $padding-4;
|
||||
background: var(--gray-200);
|
||||
background: $gray-200;
|
||||
border-radius: $border-radius;
|
||||
font-size: 0.875em;
|
||||
font-size: .875em;
|
||||
}
|
||||
|
||||
pre {
|
||||
direction: ltr;
|
||||
unicode-bidi: embed;
|
||||
padding: $padding-16;
|
||||
background: var(--gray-100);
|
||||
background: $gray-100;
|
||||
border-radius: $border-radius;
|
||||
overflow-x: auto;
|
||||
|
||||
|
|
@ -91,23 +62,15 @@
|
|||
}
|
||||
}
|
||||
|
||||
p {
|
||||
word-wrap: break-word;
|
||||
}
|
||||
|
||||
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-left: $padding-4 solid $gray-200;
|
||||
border-radius: $border-radius;
|
||||
|
||||
:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
:first-child { margin-top: 0; }
|
||||
:last-child { margin-bottom: 0; }
|
||||
}
|
||||
|
||||
table {
|
||||
|
|
@ -118,27 +81,24 @@
|
|||
margin-top: $padding-16;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
tr th,
|
||||
tr td {
|
||||
tr th, tr td {
|
||||
padding: $padding-8 $padding-16;
|
||||
border: $padding-1 solid var(--gray-200);
|
||||
border: $padding-1 solid $gray-200;
|
||||
}
|
||||
|
||||
tr:nth-child(2n) {
|
||||
background: var(--gray-100);
|
||||
background: $gray-100;
|
||||
}
|
||||
}
|
||||
|
||||
hr {
|
||||
height: $padding-1;
|
||||
border: none;
|
||||
background: var(--gray-200);
|
||||
background: $gray-200;
|
||||
}
|
||||
|
||||
ul,
|
||||
ol {
|
||||
padding-inline-start: $padding-16 * 2;
|
||||
word-wrap: break-word;
|
||||
ul, ol {
|
||||
padding-left: $padding-16 * 2;
|
||||
}
|
||||
|
||||
dl {
|
||||
|
|
@ -148,65 +108,19 @@
|
|||
}
|
||||
|
||||
dd {
|
||||
margin-inline-start: 0;
|
||||
margin-bottom: $padding-16;
|
||||
margin-left: $padding-16 * 2;
|
||||
}
|
||||
}
|
||||
|
||||
// Special case for highlighted code with line numbers
|
||||
.highlight {
|
||||
direction: ltr;
|
||||
unicode-bidi: embed;
|
||||
border-radius: $border-radius;
|
||||
overflow: hidden;
|
||||
|
||||
table tr {
|
||||
td pre code > span {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
.highlight table tr {
|
||||
td:nth-child(1) pre {
|
||||
margin: 0;
|
||||
padding-inline-end: 0;
|
||||
padding-right: 0;
|
||||
}
|
||||
td:nth-child(2) pre {
|
||||
margin: 0;
|
||||
padding-inline-start: 0;
|
||||
padding-left: 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;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,17 +1,19 @@
|
|||
@media print {
|
||||
.book-menu,
|
||||
.book-footer,
|
||||
.book-toc {
|
||||
.book-footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.book-header,
|
||||
.book-header aside {
|
||||
display: block;
|
||||
main {
|
||||
flex-direction: column-reverse;
|
||||
}
|
||||
|
||||
main {
|
||||
// Fix for https://bugzilla.mozilla.org/show_bug.cgi?id=939897
|
||||
display: block !important;
|
||||
.book-toc {
|
||||
flex: none;
|
||||
|
||||
nav {
|
||||
position: relative;
|
||||
width: auto;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
.markdown {
|
||||
.markdown-inner {
|
||||
// Util class to remove extra margin in nested markdown content
|
||||
> :first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
> :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
|
||||
// {{< expand "Label" "icon" >}}
|
||||
.book-expand {
|
||||
margin-top: $padding-16;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
border: $padding-1 solid var(--gray-200);
|
||||
border: $padding-1 solid $gray-200;
|
||||
border-radius: $border-radius;
|
||||
|
||||
overflow: hidden;
|
||||
|
||||
.book-expand-head {
|
||||
background: var(--gray-100);
|
||||
background: $gray-100;
|
||||
padding: $padding-8 $padding-16;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
|
@ -30,7 +39,7 @@
|
|||
margin-top: $padding-16;
|
||||
margin-bottom: $padding-16;
|
||||
|
||||
border: $padding-1 solid var(--gray-200);
|
||||
border: $padding-1 solid $gray-200;
|
||||
border-radius: $border-radius;
|
||||
|
||||
overflow: hidden;
|
||||
|
|
@ -48,20 +57,17 @@
|
|||
.book-tabs-content {
|
||||
order: 999; //Move content blocks to the end
|
||||
width: 100%;
|
||||
border-top: $padding-1 solid var(--gray-100);
|
||||
border-top: $padding-1 solid $gray-100;
|
||||
padding: $padding-16;
|
||||
display: none;
|
||||
}
|
||||
|
||||
input[type="radio"]:checked + label {
|
||||
border-bottom: $padding-1 solid var(--color-link);
|
||||
border-bottom: $padding-1 solid $color-link;
|
||||
}
|
||||
input[type="radio"]:checked + label + .book-tabs-content {
|
||||
display: block;
|
||||
}
|
||||
input[type="radio"]:focus + label {
|
||||
@include outline;
|
||||
}
|
||||
}
|
||||
|
||||
// {{< columns >}}
|
||||
|
|
@ -71,6 +77,7 @@
|
|||
|
||||
> div {
|
||||
margin: $padding-16 0;
|
||||
// max-width: 50%;
|
||||
min-width: $body-min-width * 0.66;
|
||||
padding: 0 $padding-16;
|
||||
}
|
||||
|
|
@ -79,26 +86,23 @@
|
|||
// {{< 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);
|
||||
color: $color-link !important;
|
||||
text-decoration: none !important;
|
||||
border: $padding-1 solid $color-link;
|
||||
border-radius: $border-radius;
|
||||
padding: $padding-4 $padding-16;
|
||||
margin-top: $padding-8;
|
||||
margin-bottom: $padding-8;
|
||||
cursor: pointer;
|
||||
|
||||
&:hover {
|
||||
text-decoration: none;
|
||||
}
|
||||
}
|
||||
|
||||
// {{< hint >}}
|
||||
.book-hint {
|
||||
@each $name, $color in $hint-colors {
|
||||
&.#{$name} {
|
||||
border-color: $color;
|
||||
border-left-color: $color;
|
||||
background-color: rgba($color, 0.1);
|
||||
// background-color: $gray-100;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -42,36 +42,10 @@
|
|||
text-align: center;
|
||||
}
|
||||
|
||||
.text-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.text-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.text-small {
|
||||
font-size: .875em;
|
||||
}
|
||||
|
||||
.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 {
|
||||
|
|
@ -88,9 +62,3 @@ input.toggle {
|
|||
overflow-x: hidden;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
@mixin outline {
|
||||
outline-style: auto;
|
||||
outline-color: currentColor;
|
||||
outline-color: -webkit-focus-ring-color;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
@import "defaults";
|
||||
@import "variables";
|
||||
@import "themes/{{ default "light" .Site.Params.BookTheme }}";
|
||||
|
||||
@import "normalize";
|
||||
@import "utils";
|
||||
|
|
|
|||
|
|
@ -1,24 +0,0 @@
|
|||
(function () {
|
||||
function select(element) {
|
||||
const selection = window.getSelection();
|
||||
|
||||
const range = document.createRange();
|
||||
range.selectNodeContents(element);
|
||||
|
||||
selection.removeAllRanges();
|
||||
selection.addRange(range);
|
||||
}
|
||||
|
||||
document.querySelectorAll("pre code").forEach(code => {
|
||||
code.addEventListener("click", function (event) {
|
||||
if (window.getSelection().toString()) {
|
||||
return;
|
||||
}
|
||||
select(code.parentElement);
|
||||
|
||||
if (navigator.clipboard) {
|
||||
navigator.clipboard.writeText(code.parentElement.textContent);
|
||||
}
|
||||
});
|
||||
});
|
||||
})();
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
(function() {
|
||||
var menu = document.querySelector("aside .book-menu-content");
|
||||
addEventListener("beforeunload", function(event) {
|
||||
localStorage.setItem("menu.scrollTop", menu.scrollTop);
|
||||
});
|
||||
menu.scrollTop = localStorage.getItem("menu.scrollTop");
|
||||
})();
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
{
|
||||
"flowchart": {
|
||||
"useMaxWidth":true
|
||||
},
|
||||
"theme": "default"
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
$gray-100: rgba(255, 255, 255, 0.1);
|
||||
$gray-200: rgba(255, 255, 255, 0.2);
|
||||
|
||||
$body-background: #343a40;
|
||||
$body-font-color: #e9ecef;
|
||||
|
||||
$color-link: #84b2ff;
|
||||
$color-visited-link: #b88dff;
|
||||
|
|
@ -1,14 +1,12 @@
|
|||
$startLevel: 1;
|
||||
$endLevel: 6;
|
||||
|
||||
.book-page .markdown.book-article {
|
||||
@for $currentLevel from $startLevel through $endLevel {
|
||||
h#{$currentLevel} {
|
||||
counter-increment: h#{$currentLevel};
|
||||
counter-reset: h#{$currentLevel + 1};
|
||||
.book-page {
|
||||
.markdown {
|
||||
@for $h from 1 through 6 {
|
||||
> h#{$h} {
|
||||
counter-increment: h#{$h};
|
||||
counter-reset: h#{$h + 1};
|
||||
|
||||
$content: "";
|
||||
@for $n from $startLevel through $currentLevel {
|
||||
@for $n from 1 through $h {
|
||||
$content: $content + 'counter(h#{$n})"."';
|
||||
}
|
||||
|
||||
|
|
@ -19,16 +17,7 @@ $endLevel: 6;
|
|||
}
|
||||
}
|
||||
|
||||
.book-toc nav#TableOfContents ul {
|
||||
counter-reset: item;
|
||||
|
||||
li {
|
||||
counter-increment: item;
|
||||
|
||||
&:before {
|
||||
content: counters(item, ".") ". ";
|
||||
float: left;
|
||||
margin-inline-end: $padding-4;
|
||||
}
|
||||
+ .book-toc nav ul {
|
||||
list-style: decimal;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,26 +0,0 @@
|
|||
@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,27 @@
|
|||
'use strict';
|
||||
|
||||
(function() {
|
||||
const indexCfg = {{ with .Scratch.Get "bookSearchConfig" }}
|
||||
{{ . }};
|
||||
{{ else }}
|
||||
{};
|
||||
{{ end }}
|
||||
|
||||
indexCfg.doc = {
|
||||
id: 'id',
|
||||
field: ['title', 'content'],
|
||||
store: ['title', 'href'],
|
||||
};
|
||||
|
||||
const index = FlexSearch.create('balance', indexCfg);
|
||||
window.bookSearchIndex = index;
|
||||
|
||||
{{ range $index, $page := .Site.Pages }}
|
||||
index.add({
|
||||
'id': {{ $index }},
|
||||
'href': '{{ $page.RelPermalink }}',
|
||||
'title': {{ (partial "docs/title" $page) | jsonify }},
|
||||
'content': {{ $page.Plain | jsonify }}
|
||||
});
|
||||
{{- end -}}
|
||||
})();
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
[
|
||||
{{- $pages := where .Site.Pages "Kind" "in" (slice "page" "section") -}}
|
||||
{{- $pages = where $pages "Params.bookSearchExclude" "!=" true -}}
|
||||
{{/* Remove until we know why it does not work, see https://github.com/alex-shpak/hugo-book/issues/528 */}}
|
||||
{{/*- $pages = where $pages "Content" "not in" (slice nil "") -*/}}
|
||||
{{- $pages = where $pages "Content" "!=" "" -}}
|
||||
|
||||
{{ range $index, $page := $pages }}
|
||||
{{ if gt $index 0}},{{end}} {
|
||||
"id": {{ $index }},
|
||||
"href": "{{ $page.RelPermalink }}",
|
||||
"title": {{ (partial "docs/title" $page) | jsonify }},
|
||||
"section": {{ (partial "docs/title" $page.Parent) | jsonify }},
|
||||
"content": {{ $page.Plain | jsonify }}
|
||||
}
|
||||
{{- end -}}
|
||||
]
|
||||
|
|
@ -1,82 +1,24 @@
|
|||
'use strict';
|
||||
|
||||
{{ $searchDataFile := printf "%s.search-data.json" .Language.Lang }}
|
||||
{{ $searchData := resources.Get "search-data.json" | resources.ExecuteAsTemplate $searchDataFile . | resources.Minify | resources.Fingerprint }}
|
||||
{{ $searchConfig := i18n "bookSearchConfig" | default "{}" }}
|
||||
{{ $searchDataFile := printf "%s.search-data.js" .Language.Lang }}
|
||||
{{ $searchData := resources.Get "search-data.js" | resources.ExecuteAsTemplate $searchDataFile . | resources.Minify | resources.Fingerprint }}
|
||||
|
||||
(function() {
|
||||
const searchDataURL = '{{ $searchData.RelPermalink }}';
|
||||
const indexConfig = Object.assign({{ $searchConfig }}, {
|
||||
includeScore: true,
|
||||
useExtendedSearch: true,
|
||||
fieldNormWeight: 1.5,
|
||||
threshold: 0.2,
|
||||
ignoreLocation: true,
|
||||
keys: [
|
||||
{
|
||||
name: 'title',
|
||||
weight: 0.7
|
||||
},
|
||||
{
|
||||
name: 'content',
|
||||
weight: 0.3
|
||||
}
|
||||
]
|
||||
});
|
||||
|
||||
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 (event.target.value !== undefined) {
|
||||
return;
|
||||
}
|
||||
|
||||
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;
|
||||
|
||||
fetch(searchDataURL)
|
||||
.then(pages => pages.json())
|
||||
.then(pages => {
|
||||
window.bookSearchIndex = new Fuse(pages, indexConfig);
|
||||
})
|
||||
.then(() => input.required = false)
|
||||
.then(search);
|
||||
loadScript('{{ "flexsearch.min.js" | relURL }}');
|
||||
loadScript('{{ $searchData.RelPermalink }}', function() {
|
||||
input.required = false;
|
||||
search();
|
||||
});
|
||||
}
|
||||
|
||||
function search() {
|
||||
|
|
@ -88,26 +30,25 @@
|
|||
return;
|
||||
}
|
||||
|
||||
const searchHits = window.bookSearchIndex.search(input.value).slice(0,10);
|
||||
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');
|
||||
const li = document.createElement('li'),
|
||||
a = li.appendChild(document.createElement('a'));
|
||||
|
||||
a.href = page.item.href;
|
||||
a.textContent = page.item.title;
|
||||
small.textContent = page.item.section;
|
||||
a.href = page.href;
|
||||
a.textContent = page.title;
|
||||
|
||||
results.appendChild(li);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {String} content
|
||||
* @returns {Node}
|
||||
*/
|
||||
function element(content) {
|
||||
const div = document.createElement('div');
|
||||
div.innerHTML = content;
|
||||
return div.firstChild;
|
||||
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);
|
||||
}
|
||||
})();
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
{{- $swJS := resources.Get "sw.js" | resources.ExecuteAsTemplate "sw.js" . -}}
|
||||
if (navigator.serviceWorker) {
|
||||
navigator.serviceWorker.register(
|
||||
"{{ $swJS.RelPermalink }}",
|
||||
{ scope: "{{ "./" | relURL }}" }
|
||||
);
|
||||
}
|
||||
55
assets/sw.js
55
assets/sw.js
|
|
@ -1,55 +0,0 @@
|
|||
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));
|
||||
});
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
:root {
|
||||
@include theme-light;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
@include theme-dark;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
:root {
|
||||
@include theme-dark;
|
||||
}
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
:root {
|
||||
@include theme-light;
|
||||
}
|
||||
|
|
@ -1,4 +1,3 @@
|
|||
/* You can add custom styles here. */
|
||||
|
||||
// @import "plugins/numbered";
|
||||
// @import "plugins/scrollbars";
|
||||
|
|
|
|||
|
|
@ -1 +1,3 @@
|
|||
/* You can override SASS variables here. */
|
||||
|
||||
// @import "plugins/dark";
|
||||
|
|
|
|||
|
|
@ -0,0 +1,71 @@
|
|||
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
|
||||
|
||||
baseURL = 'https://example.com/'
|
||||
title = 'Hugo Book'
|
||||
theme = 'hugo-book'
|
||||
disableKinds = ['taxonomy', 'taxonomyTerm']
|
||||
|
||||
# Book configuration
|
||||
disablePathToLower = true
|
||||
enableGitInfo = true
|
||||
|
||||
# Code highlight
|
||||
# pygmentsStyle = 'monokailight'
|
||||
pygmentsCodeFences = true
|
||||
|
||||
# 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.cn]
|
||||
languageName = 'Chinese'
|
||||
contentDir = 'content.cn'
|
||||
weight = 3
|
||||
|
||||
[params]
|
||||
# (Optional, default 6) Set how many table of contents levels to be showed on page.
|
||||
# Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
|
||||
# You can also specify this parameter per page in front matter
|
||||
BookToC = 3
|
||||
|
||||
# (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 'content' directory of repo.
|
||||
BookEditPath = 'edit/master/exampleSite/content'
|
||||
|
||||
# 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.
|
||||
BookSearch = true
|
||||
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
|
||||
|
||||
baseURL: https://example.com/
|
||||
title: Hugo Book
|
||||
theme: hugo-book
|
||||
disableKinds: ['taxonomy', 'taxonomyTerm']
|
||||
|
||||
# Book configuration
|
||||
disablePathToLower: true
|
||||
enableGitInfo: true
|
||||
|
||||
# Code highlight
|
||||
# pygmentsStyle: monokailight
|
||||
pygmentsCodeFences: true
|
||||
|
||||
# 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
|
||||
cn:
|
||||
languageName: Chinese
|
||||
contentDir: content.cn
|
||||
weight: 3
|
||||
|
||||
params:
|
||||
# (Optional, default 6) Set how many table of contents levels to be showed on page.
|
||||
# Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
|
||||
# You can also specify this parameter per page in front matter
|
||||
BookToC: 3
|
||||
|
||||
# (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 'content' directory of repo.
|
||||
BookEditPath: edit/master/exampleSite/content
|
||||
|
||||
# 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.
|
||||
BookSearch: true
|
||||
|
|
@ -5,7 +5,7 @@ type: docs
|
|||
|
||||
# 中文索引页
|
||||
|
||||
{{% columns %}}
|
||||
{{< columns >}}
|
||||
## Astris ipse furtiva
|
||||
|
||||
Est in vagis et Pittheus tu arge accipiter regia iram vocatur nurus. Omnes ut
|
||||
|
|
@ -19,7 +19,7 @@ modo arsit? Utinam rapta fiducia valuere litora _adicit cursu_, ad facies
|
|||
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 %}}
|
||||
{{< /columns >}}
|
||||
|
||||
|
||||
## Tempora nisi nunc
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
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?
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
---
|
||||
bookCollapseSection: true
|
||||
weight: 20
|
||||
---
|
||||
|
|
@ -1,80 +0,0 @@
|
|||
# Columns
|
||||
|
||||
Columns help organize shorter pieces of content horizontally for readability.
|
||||
|
||||
## Example
|
||||
|
||||
```html
|
||||
{{%/* columns [ratio="1:1"] [class="..."] */%}} <!-- 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 */%}}
|
||||
```
|
||||
|
||||
{{% 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 %}}
|
||||
|
||||
## Settings size ratio for columns
|
||||
|
||||
```html
|
||||
{{%/* columns ratio="1:2" */%}} <!-- begin columns block -->
|
||||
|
||||
## x1 Column
|
||||
Lorem markdownum insigne...
|
||||
|
||||
<---> <!-- magic separator, between columns -->
|
||||
|
||||
## x2 Column
|
||||
Lorem markdownum insigne...
|
||||
|
||||
{{%/* /columns */%}}
|
||||
```
|
||||
|
||||
{{% columns ratio="1:2" %}}
|
||||
### x1 Column
|
||||
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.
|
||||
|
||||
<--->
|
||||
|
||||
### x2 Column
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter!
|
||||
|
||||
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 %}}
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
# 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 %}}
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
title: KaTeX
|
||||
---
|
||||
# KaTeX
|
||||
|
||||
KaTeX shortcode let you render math typesetting in markdown document. See [KaTeX](https://katex.org/)
|
||||
|
||||
## Example
|
||||
{{% columns %}}
|
||||
|
||||
```latex
|
||||
{{</* katex display=true >}}
|
||||
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
|
||||
{{< /katex */>}}
|
||||
```
|
||||
|
||||
<--->
|
||||
|
||||
{{< katex display=true >}}
|
||||
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=true >}}
|
||||
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
|
||||
{{< /katex >}}
|
||||
Text continues here.
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
# Mermaid Chart
|
||||
|
||||
[MermaidJS](https://mermaid-js.github.io/) is library for generating svg charts and diagrams from text.
|
||||
|
||||
{{% hint info %}}
|
||||
**Override Mermaid initialization config**
|
||||
To override the [initialization config](https://mermaid-js.github.io/mermaid/#/Setup) for Mermaid,
|
||||
create a `mermaid.json` file in your `assets` folder!
|
||||
{{% /hint %}}
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
{{% columns %}}
|
||||
|
||||
```tpl
|
||||
{{</* mermaid [class="..."] >}}
|
||||
stateDiagram-v2
|
||||
State1: The state with a note
|
||||
note right of State1
|
||||
Important information! You can write
|
||||
notes.
|
||||
end note
|
||||
State1 --> State2
|
||||
note left of State2 : This is the note to the left.
|
||||
{{< /mermaid */>}}
|
||||
```
|
||||
|
||||
<--->
|
||||
|
||||
{{<mermaid>}}
|
||||
stateDiagram-v2
|
||||
State1: The state with a note
|
||||
note right of State1
|
||||
Important information! You can write
|
||||
notes.
|
||||
end note
|
||||
State1 --> State2
|
||||
note left of State2 : This is the note to the left.
|
||||
{{</mermaid>}}
|
||||
|
||||
{{% /columns %}}
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
bookCollapseSection: true
|
||||
bookHidden: true
|
||||
---
|
||||
|
||||
# Section
|
||||
|
||||
Section renders pages in section as definition list, using title and description. Optional param `summary` can be used to show or hide page summary
|
||||
|
||||
## Example
|
||||
|
||||
```tpl
|
||||
{{</* section [summary] */>}}
|
||||
```
|
||||
|
||||
{{<section summary>}}
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
# First page
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
|
||||
|
||||
<!--more-->
|
||||
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
# Second Page
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
|
||||
|
||||
<!--more-->
|
||||
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
menu:
|
||||
after:
|
||||
name: blog
|
||||
weight: 5
|
||||
title: Blog
|
||||
---
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
title: Introduction
|
||||
type: docs
|
||||
---
|
||||
|
||||
# Example of RTL page
|
||||
|
||||
{{% 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,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,77 @@
|
|||
---
|
||||
title: Introduction
|
||||
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,23 @@
|
|||
---
|
||||
bookCollapseSection: true
|
||||
weight: 20
|
||||
---
|
||||
|
||||
# 2nd Level of Menu
|
||||
|
||||
## 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
|
||||
|
|
@ -2,12 +2,12 @@
|
|||
|
||||
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 */>}}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
{{< 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 sparator, between columns -->
|
||||
|
||||
# Mid Content
|
||||
Lorem markdownum insigne...
|
||||
|
||||
<---> <!-- magic sparator, 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,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 >}}
|
||||
|
|
@ -4,29 +4,29 @@ 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] */%}}
|
||||
{{</* 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 */%}}
|
||||
{{</* /hint */>}}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
{{% hint info %}}
|
||||
{{< 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 >}}
|
||||
|
||||
{{% hint warning %}}
|
||||
{{< 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 >}}
|
||||
|
||||
{{% hint danger %}}
|
||||
{{< hint danger >}}
|
||||
**Markdown content**
|
||||
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
|
||||
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
|
||||
{{% /hint %}}
|
||||
{{< /hint >}}
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# KaTeX
|
||||
|
||||
KaTeX shortcode let you render math typesetting in markdown document. See [KaTeX](https://katex.org/)
|
||||
|
||||
## Example
|
||||
{{< columns >}}
|
||||
|
||||
```latex
|
||||
{{</* katex [class="text-center"] */>}}
|
||||
x = \begin{cases}
|
||||
a &\text{if } b \\
|
||||
c &\text{if } d
|
||||
\end{cases}
|
||||
{{</* /katex */>}}
|
||||
```
|
||||
|
||||
<--->
|
||||
|
||||
{{< katex >}}
|
||||
x = \begin{cases}
|
||||
a &\text{if } b \\
|
||||
c &\text{if } d
|
||||
\end{cases}
|
||||
{{< /katex >}}
|
||||
|
||||
{{< /columns >}}
|
||||
|
||||
|
|
@ -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 >}}
|
||||
|
|
@ -3,18 +3,17 @@
|
|||
Tabs let you organize content by context, for example installation instructions for each supported platform.
|
||||
|
||||
```tpl
|
||||
{{</* tabs "id" */>}}
|
||||
{{%/* tab "MacOS" */%}} # MacOS Content {{%/* /tab */%}}
|
||||
{{%/* tab "Linux" */%}} # Linux Content {{%/* /tab */%}}
|
||||
{{%/* tab "Windows" */%}} # Windows Content {{%/* /tab */%}}
|
||||
{{</* tabs "uniqueid" */>}}
|
||||
{{</* tab "MacOS" */>}} # MacOS Content {{</* /tab */>}}
|
||||
{{</* tab "Linux" */>}} # Linux Content {{</* /tab */>}}
|
||||
{{</* tab "Windows" */>}} # Windows Content {{</* /tab */>}}
|
||||
{{</* /tabs */>}}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
{{< tabs >}}
|
||||
|
||||
{{% tab "MacOS" %}}
|
||||
{{< tabs "uniqueid" >}}
|
||||
{{< tab "MacOS" >}}
|
||||
# MacOS
|
||||
|
||||
This is tab **MacOS** content.
|
||||
|
|
@ -23,9 +22,10 @@ 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 >}}
|
||||
|
||||
{{< tab "Linux" >}}
|
||||
|
||||
{{% tab "Linux" %}}
|
||||
# Linux
|
||||
|
||||
This is tab **Linux** content.
|
||||
|
|
@ -34,9 +34,10 @@ 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 >}}
|
||||
|
||||
{{< tab "Windows" >}}
|
||||
|
||||
{{% tab "Windows" %}}
|
||||
# Windows
|
||||
|
||||
This is tab **Windows** content.
|
||||
|
|
@ -45,6 +46,5 @@ 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 >}}
|
||||
{{< /tabs >}}
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
headless: true
|
||||
bookMenuLevels: 1
|
||||
---
|
||||
|
||||
- [**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" >}})
|
||||
- [2nd]({{< relref "/docs/example/2nd" >}})
|
||||
- [3rd]({{< relref "/docs/example/2nd/3rd" >}})
|
||||
- [4th]({{< relref "/docs/example/2nd/3rd/4th" >}})
|
||||
- **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" >}})
|
||||
- [**Blog**]({{< relref "/posts" >}})
|
||||
|
|
@ -1,119 +0,0 @@
|
|||
# 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.en'
|
||||
weight = 1
|
||||
|
||||
[languages.zh]
|
||||
languageName = 'Chinese'
|
||||
contentDir = 'content.zh'
|
||||
weight = 2
|
||||
|
||||
[languages.he]
|
||||
languageName = 'Hebrew'
|
||||
contentDir = 'content.he'
|
||||
languageDirection = 'rtl'
|
||||
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/themes/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 favicon.png) Set the path to a favicon file.
|
||||
# If the favicon is /static/favicon.png then the path would be favicon.png
|
||||
# BookFavicon = 'favicon.png'
|
||||
|
||||
# (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 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'
|
||||
|
||||
# (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
|
||||
# commit hash for 'doc' page type.
|
||||
# Requires 'BookRepo' param.
|
||||
# Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
|
||||
# Github uses 'commit', Bitbucket uses 'commits'
|
||||
# BookCommitPath = 'commit'
|
||||
|
||||
# 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/main/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
|
||||
|
|
@ -1,115 +0,0 @@
|
|||
# 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.en
|
||||
weight: 1
|
||||
zh:
|
||||
languageName: Chinese
|
||||
contentDir: content.zh
|
||||
weight: 2
|
||||
he:
|
||||
languageName: Hebrew
|
||||
contentDir: content.he
|
||||
languageDirection: rtl
|
||||
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/themes/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 favicon.png) Set the path to a favicon file.
|
||||
# If the favicon is /static/favicon.png then the path would be favicon.png
|
||||
# BookFavicon: "favicon.png"
|
||||
|
||||
# (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 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
|
||||
|
||||
# (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
|
||||
# commit hash for 'doc' page type.
|
||||
# Requires 'BookRepo' param.
|
||||
# Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
|
||||
# Github uses 'commit', Bitbucket uses 'commits'
|
||||
# BookCommitPath: commit
|
||||
|
||||
# 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/main/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
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1 +0,0 @@
|
|||
{"Target":"book.min.6c8b9d2a1fc95075ed7da46ca81060b39add8fff6741ac51259f768929281e2c.css","MediaType":"text/css","Data":{"Integrity":"sha256-bIudKh/JUHXtfaRsqBBgs5rdj/9nQaxRJZ92iSkoHiw="}}
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1 @@
|
|||
{"Target":"book.min.0379377fb17315c9a560efd4d406aea4535c095a461b220fd9e3d2e9c05550e6.css","MediaType":"text/css","Data":{"Integrity":"sha256-A3k3f7FzFcmlYO/U1AaupFNcCVpGGyIP2ePS6cBVUOY="}}
|
||||
14
i18n/am.yaml
14
i18n/am.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: ፈልግ
|
||||
|
||||
- id: Edit this page
|
||||
translation: ይህንን ገጽ አስተካክል
|
||||
|
||||
- id: Last modified by
|
||||
translation: መጨረሻ የከለሰው ሰው
|
||||
|
||||
- id: Expand
|
||||
translation: አስፋ
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
14
i18n/bn.yaml
14
i18n/bn.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: অনুসন্ধান
|
||||
|
||||
- id: Edit this page
|
||||
translation: এই পৃষ্ঠাটি সম্পাদনা করুন
|
||||
|
||||
- id: Last modified by
|
||||
translation: সর্বশেষ সম্পাদনা করেছেন
|
||||
|
||||
- id: Expand
|
||||
translation: বিস্তৃত করা
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
|
|
@ -1,15 +1,11 @@
|
|||
# This should be removed in future, 'cn' is moved to `zh'
|
||||
- id: Search
|
||||
translation: 搜索
|
||||
|
||||
- id: Edit this page
|
||||
translation: 编辑本页
|
||||
translation: Edit this page
|
||||
|
||||
- id: Last modified by
|
||||
translation: 最后修改者
|
||||
|
||||
- id: Expand
|
||||
translation: 展开
|
||||
translation: Last modified by
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: |
|
||||
|
|
|
|||
14
i18n/cs.yaml
14
i18n/cs.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- 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 }'
|
||||
14
i18n/de.yaml
14
i18n/de.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- 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 }'
|
||||
|
|
@ -7,8 +7,5 @@
|
|||
- id: Last modified by
|
||||
translation: Last modified by
|
||||
|
||||
- id: Expand
|
||||
translation: Expand
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
|
|
|
|||
14
i18n/es.yaml
14
i18n/es.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- 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: Expandir
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
20
i18n/fa.yaml
20
i18n/fa.yaml
|
|
@ -1,20 +0,0 @@
|
|||
- id: Search
|
||||
translation: جستجو
|
||||
|
||||
- id: Edit this page
|
||||
translation: این صفحه را ویرایش کنید
|
||||
|
||||
- id: Last modified by
|
||||
translation: آخرین بار ویرایش شده توسط
|
||||
|
||||
- id: Expand
|
||||
translation: بسط دادن
|
||||
|
||||
- id: Categories
|
||||
translation: دسته بندی ها
|
||||
|
||||
- id: Tags
|
||||
translation: تگ ها
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true, encode: false, rtl: true, split: /\s+/, tokenize: "forward"}'
|
||||
14
i18n/fr.yaml
14
i18n/fr.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- 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 }'
|
||||
14
i18n/it.yaml
14
i18n/it.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Cerca
|
||||
|
||||
- id: Edit this page
|
||||
translation: Modifica questa pagina
|
||||
|
||||
- id: Last modified by
|
||||
translation: Ultima modifica di
|
||||
|
||||
- id: Expand
|
||||
translation: Espandi
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
20
i18n/ja.yaml
20
i18n/ja.yaml
|
|
@ -1,20 +0,0 @@
|
|||
- 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('');
|
||||
}
|
||||
}
|
||||
21
i18n/jp.yaml
21
i18n/jp.yaml
|
|
@ -1,21 +0,0 @@
|
|||
# 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('');
|
||||
}
|
||||
}
|
||||
20
i18n/ko.yaml
20
i18n/ko.yaml
|
|
@ -1,20 +0,0 @@
|
|||
- 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('');
|
||||
}
|
||||
}
|
||||
14
i18n/nb.yaml
14
i18n/nb.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- 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 }'
|
||||
14
i18n/nl.yaml
14
i18n/nl.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Zoeken
|
||||
|
||||
- id: Edit this page
|
||||
translation: Bewerk deze pagina
|
||||
|
||||
- id: Last modified by
|
||||
translation: Laatst gewijzigd door
|
||||
|
||||
- id: Expand
|
||||
translation: Uitbreiden
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
14
i18n/oc.yaml
14
i18n/oc.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Recercar
|
||||
|
||||
- id: Edit this page
|
||||
translation: Modificar aquesta pagina
|
||||
|
||||
- id: Last modified by
|
||||
translation: Darrièra modificacion per
|
||||
|
||||
- id: Expand
|
||||
translation: Desplegar
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
14
i18n/pl.yaml
14
i18n/pl.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Szukaj
|
||||
|
||||
- id: Edit this page
|
||||
translation: Edytuj stronę
|
||||
|
||||
- id: Last modified by
|
||||
translation: Ostatnia modyfikacja
|
||||
|
||||
- id: Expand
|
||||
translation: Rozwiń
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
14
i18n/pt.yaml
14
i18n/pt.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Buscar
|
||||
|
||||
- id: Edit this page
|
||||
translation: Editar página
|
||||
|
||||
- id: Last modified by
|
||||
translation: Última modificação por
|
||||
|
||||
- id: Expand
|
||||
translation: Expandir
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
|
|
@ -2,13 +2,10 @@
|
|||
translation: Поиск
|
||||
|
||||
- id: Edit this page
|
||||
translation: Редактировать эту страницу
|
||||
translation: Редактировать эту сраницу
|
||||
|
||||
- id: Last modified by
|
||||
translation: Последнее изменение от
|
||||
|
||||
- id: Expand
|
||||
translation: Развернуть
|
||||
translation: Last modified by
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ split: /[^a-zа-яё0-9\w]/gi }'
|
||||
|
|
|
|||
14
i18n/sv.yaml
14
i18n/sv.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Sök
|
||||
|
||||
- id: Edit this page
|
||||
translation: Redigera denna sida
|
||||
|
||||
- id: Last modified by
|
||||
translation: Senast modifierad av
|
||||
|
||||
- id: Expand
|
||||
translation: Expandera
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
14
i18n/tr.yaml
14
i18n/tr.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Arama
|
||||
|
||||
- id: Edit this page
|
||||
translation: Bu sayfayı düzenle
|
||||
|
||||
- id: Last modified by
|
||||
translation: Son düzenleyen
|
||||
|
||||
- id: Expand
|
||||
translation: Genişlet
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ cache: true }'
|
||||
14
i18n/uk.yaml
14
i18n/uk.yaml
|
|
@ -1,14 +0,0 @@
|
|||
- id: Search
|
||||
translation: Пошук
|
||||
|
||||
- id: Edit this page
|
||||
translation: Редагувати цю сторінку
|
||||
|
||||
- id: Last modified by
|
||||
translation: Остання зміна від
|
||||
|
||||
- id: Expand
|
||||
translation: Розгорнути
|
||||
|
||||
- id: bookSearchConfig
|
||||
translation: '{ split: /[^a-zа-яё0-9\w]/gi }'
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
- 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('');
|
||||
}
|
||||
}
|
||||
20
i18n/zh.yaml
20
i18n/zh.yaml
|
|
@ -1,20 +0,0 @@
|
|||
- 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('');
|
||||
}
|
||||
}
|
||||
|
|
@ -4,31 +4,15 @@
|
|||
<head>
|
||||
{{ partial "docs/html-head" . }}
|
||||
{{ partial "docs/inject/head" . }}
|
||||
|
||||
<style>
|
||||
.not-found {
|
||||
text-align: center;
|
||||
}
|
||||
.not-found h1 {
|
||||
margin: .25em 0 0 0;
|
||||
opacity: .25;
|
||||
font-size: 40vmin;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<main class="flex justify-center not-found">
|
||||
<div>
|
||||
<h1>404</h1>
|
||||
<h2>Page Not Found</h2>
|
||||
<h3>
|
||||
<a href="{{ .Site.Home.RelPermalink }}">{{ .Site.Title }}</a>
|
||||
</h3>
|
||||
</div>
|
||||
<main class="flex justify-center">
|
||||
<h1>404 Not Found</h1>
|
||||
</main>
|
||||
|
||||
{{ partial "docs/inject/body" . }}
|
||||
{{ template "_internal/google_analytics_async.html" . }}
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
<h{{ .Level }} id="{{ .Anchor | safeURL }}">
|
||||
{{ .Text | safeHTML }}
|
||||
<a class="anchor" href="#{{ .Anchor | safeURL }}">#</a>
|
||||
</h{{ .Level }}>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue