hugo-book-theme/exampleSite/config.yaml

78 lines
2.5 KiB
YAML
Raw Normal View History

2019-10-27 11:58:58 +01:00
# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
baseURL: https://example.com/
2018-10-30 15:56:42 +01:00
title: Hugo Book
theme: hugo-book
2018-09-30 01:31:24 +02:00
# Book configuration
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
markup:
goldmark:
renderer:
unsafe: true
2019-12-09 11:10:55 +01:00
tableOfContents:
startLevel: 1
# Multi-lingual mode config
# There are different options to translate files
# See https://gohugo.io/content-management/multilingual/#translation-by-filename
# And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
languages:
en:
languageName: English
contentDir: content
weight: 1
ru:
languageName: Russian
contentDir: content.ru
weight: 2
2019-11-10 00:23:06 +01:00
cn:
languageName: Chinese
contentDir: content.cn
2019-11-10 00:23:06 +01:00
weight: 3
2018-09-30 01:31:24 +02:00
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/)
2019-02-20 00:27:25 +01:00
# You can also specify this parameter per page in front matter
BookToC: 3
2018-09-30 01:31:24 +02:00
# (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
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
# BookMenuBundle: /menu
2018-09-30 01:31:24 +02:00
2019-02-20 00:27:25 +01:00
# (Optional, default docs) Specify section of content to render as menu
# You can also set value to '*' to render all sections to menu
2019-04-23 22:31:17 +02:00
BookSection: docs
2019-02-20 00:27:25 +01:00
# Set source repository location.
# Used for 'Last Modified' and 'Edit this page' links.
BookRepo: https://github.com/alex-shpak/hugo-book
2018-12-03 08:22:05 +01:00
# Enable "Edit this page" links for 'doc' page type.
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
2019-02-20 00:27:25 +01:00
# Path must point to 'content' directory of repo.
2019-01-01 14:39:06 +01:00
BookEditPath: edit/master/exampleSite/content
# Configure the date format used on the pages
# - In git information
# - In blog posts
2019-12-01 14:54:37 +01:00
BookDateFormat: "Jan 2, 2006"
2019-07-16 14:34:02 +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.
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