docs: add some missing options of config.toml #721

This commit is contained in:
Sören Weber 2023-11-17 00:30:09 +01:00
parent fcb255caf7
commit f2af6bf607
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D

View file

@ -17,7 +17,7 @@ author.name = "Sören Weber"
# This is used for generating social media meta information for the opengraph
# protocol and twitter cards.
# This can be overridden in the page's frontmatter.
images = ["images/hero.png"]
images = [ "images/hero.png" ]
# The description of your site.
# Default: not set
@ -26,6 +26,13 @@ images = ["images/hero.png"]
# This can be overridden in the page's frontmatter.
description = "Documentation for Hugo Relearn Theme"
# Admin options for social media.
# Default: not set
# Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's
# implementation. See the Hugo docs for possible values.
social.facebook_admin = ""
social.twitter = ""
###############################################################################
# Relearn Theme
# These options are specific to the Relearn theme.
@ -78,6 +85,14 @@ disableAssetsBusting = false
# meta tag into your home page anyways.
disableGeneratorVersion = false
# Avoid unique IDs.
# Default: false
# In various situations the theme generates non stable unique ids to be used
# in HTML fragment links. This can be undesirable for example when testing
# the output for changes. If you disable the random id generation, the theme
# may not function correctly anymore.
disableRandomIds = false
# Generate link URLs the Hugo way.
# Default: false
# If set to true, the theme behaves like a standard Hugo installation and
@ -156,7 +171,7 @@ ordersectionsby = "weight"
# levels are set to true. This can be overridden in the page's frontmatter.
# If the displayed page has submenus, they will always been displayed expanded
# regardless of this option.
alwaysopen = "" # this has the effect as if not set at all
alwaysopen = ""
# Shows expander for submenus.
# Default: false
@ -263,6 +278,20 @@ disableHoverBlockCopyToClipBoard = false
# to open those links in the same tab, use "_self".
externalLinkTarget = "_blank"
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Highlight
# These options configure how syntaxhighlighted code is displayed.
# Wrap for code blocks.
# Default: true
# By default lines of code blocks wrap around if the line is too long to be
# displayed on screen. If you dislike this behavior, you can reconfigure it
# here.
# Note that lines always wrap in print mode regardless of this option.
# This can be overridden in the page's frontmatter or given as a parameter to
# individual code blocks.
highlightWrap = true
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Images
# These options configure how images are displayed.