2019-10-27 11:58:58 +01:00
|
|
|
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
|
2018-10-08 20:56:06 +02:00
|
|
|
|
2019-05-22 10:23:34 +02:00
|
|
|
baseURL = 'https://example.com/'
|
2020-07-07 23:07:28 +02:00
|
|
|
title = 'Hugo Book'
|
2019-05-22 10:23:34 +02:00
|
|
|
theme = 'hugo-book'
|
2018-09-30 01:31:24 +02:00
|
|
|
|
|
|
|
# Book configuration
|
2019-05-22 10:23:34 +02:00
|
|
|
disablePathToLower = true
|
|
|
|
enableGitInfo = true
|
2018-09-30 01:31:24 +02:00
|
|
|
|
2019-12-01 14:54:37 +01:00
|
|
|
# Needed for mermaid/katex shortcodes
|
2019-12-09 11:10:55 +01:00
|
|
|
[markup]
|
2019-12-01 14:54:37 +01:00
|
|
|
[markup.goldmark.renderer]
|
2019-12-09 11:10:55 +01:00
|
|
|
unsafe = true
|
|
|
|
|
|
|
|
[markup.tableOfContents]
|
|
|
|
startLevel = 1
|
2019-03-29 16:15:43 +01:00
|
|
|
|
2019-11-19 23:56:45 +01:00
|
|
|
# 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
|
2019-11-09 23:27:11 +01:00
|
|
|
[languages]
|
2019-11-10 14:35:07 +01:00
|
|
|
[languages.en]
|
|
|
|
languageName = 'English'
|
2019-11-19 23:56:45 +01:00
|
|
|
contentDir = 'content'
|
2019-11-10 14:35:07 +01:00
|
|
|
weight = 1
|
|
|
|
|
|
|
|
[languages.ru]
|
|
|
|
languageName = 'Russian'
|
2019-11-19 23:56:45 +01:00
|
|
|
contentDir = 'content.ru'
|
2019-11-10 14:35:07 +01:00
|
|
|
weight = 2
|
|
|
|
|
2020-04-21 23:38:30 +02:00
|
|
|
[languages.zh]
|
2019-11-10 14:35:07 +01:00
|
|
|
languageName = 'Chinese'
|
2020-04-21 23:38:30 +02:00
|
|
|
contentDir = 'content.zh'
|
2019-11-10 14:35:07 +01:00
|
|
|
weight = 3
|
2019-11-09 23:27:11 +01:00
|
|
|
|
2020-02-12 22:12:41 +01:00
|
|
|
[menu]
|
|
|
|
# [[menu.before]]
|
|
|
|
[[menu.after]]
|
|
|
|
name = "Github"
|
|
|
|
url = "https://github.com/alex-shpak/hugo-book"
|
|
|
|
weight = 10
|
|
|
|
|
|
|
|
[[menu.after]]
|
|
|
|
name = "Hugo Themes"
|
|
|
|
url = "https://themes.gohugo.io/hugo-book/"
|
|
|
|
weight = 20
|
|
|
|
|
2019-05-22 10:23:34 +02:00
|
|
|
[params]
|
2020-09-14 00:02:55 +02:00
|
|
|
# (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'
|
|
|
|
|
2020-01-24 00:07:47 +01:00
|
|
|
# (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
|
2018-09-30 01:31:24 +02:00
|
|
|
|
2019-09-01 20:05:34 +02:00
|
|
|
# (Optional, default none) Set the path to a logo for the book. If the logo is
|
2019-09-05 23:01:40 +02:00
|
|
|
# /static/logo.png then the path would be logo.png
|
|
|
|
# BookLogo = 'logo.png'
|
2019-09-01 20:05:34 +02:00
|
|
|
|
2019-02-20 00:27:25 +01:00
|
|
|
# (Optional, default none) Set leaf bundle to render as side menu
|
|
|
|
# When not specified file structure and weights will be used
|
2019-10-09 01:00:26 +02:00
|
|
|
# BookMenuBundle = '/menu'
|
2018-09-30 01:31:24 +02:00
|
|
|
|
2020-04-11 14:35:29 +02:00
|
|
|
# (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 '/'
|
2020-04-11 14:37:47 +02:00
|
|
|
BookSection = 'docs'
|
2019-02-20 00:27:25 +01:00
|
|
|
|
2018-12-15 04:53:50 +01:00
|
|
|
# Set source repository location.
|
|
|
|
# Used for 'Last Modified' and 'Edit this page' links.
|
2019-05-22 10:23:34 +02:00
|
|
|
BookRepo = 'https://github.com/alex-shpak/hugo-book'
|
2018-12-15 04:53:50 +01:00
|
|
|
|
2021-04-11 17:50:54 +02:00
|
|
|
# (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'
|
|
|
|
|
2018-12-03 08:22:05 +01:00
|
|
|
# Enable "Edit this page" links for 'doc' page type.
|
2018-12-15 04:53:50 +01:00
|
|
|
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
|
2020-04-16 17:40:17 +02:00
|
|
|
# Edit path must point to root directory of repo.
|
|
|
|
BookEditPath = 'edit/master/exampleSite'
|
2019-03-29 16:59:00 +01:00
|
|
|
|
|
|
|
# Configure the date format used on the pages
|
|
|
|
# - In git information
|
|
|
|
# - In blog posts
|
2020-04-11 14:35:29 +02:00
|
|
|
BookDateFormat = 'January 2, 2006'
|
2019-07-15 18:25:21 +02:00
|
|
|
|
2019-11-14 00:23:01 +01:00
|
|
|
# (Optional, default true) Enables search function with flexsearch,
|
2019-07-16 14:34:02 +02:00
|
|
|
# Index is built on fly, therefore it might slowdown your website.
|
2020-02-04 22:24:36 +01:00
|
|
|
# Configuration for indexing can be adjusted in i18n folder per language.
|
2019-07-15 18:25:21 +02:00
|
|
|
BookSearch = true
|
2019-10-27 11:58:58 +01:00
|
|
|
|
2020-01-17 21:44:25 +01:00
|
|
|
# (Optional, default true) Enables comments template on pages
|
|
|
|
# By default partals/docs/comments.html includes Disqus template
|
2020-01-13 17:55:24 +01:00
|
|
|
# See https://gohugo.io/content-management/comments/#configure-disqus
|
|
|
|
# Can be overwritten by same param in page frontmatter
|
2020-01-17 21:44:25 +01:00
|
|
|
BookComments = true
|
2020-03-07 18:47:16 +01:00
|
|
|
|
|
|
|
# /!\ 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
|
2020-04-12 20:50:03 +02:00
|
|
|
|
|
|
|
# /!\ 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
|
2021-01-21 11:42:26 +01:00
|
|
|
|
|
|
|
# /!\ 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.
|
2021-01-29 10:54:35 +01:00
|
|
|
BookTranslatedOnly = false
|