mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
262 lines
9.9 KiB
TOML
262 lines
9.9 KiB
TOML
# If an option value is said to be not set, you can achieve the same behavior
|
|
# by given it an empty string value.
|
|
|
|
###############################################################################
|
|
# Hugo
|
|
# These options usually apply to other themes aswell.
|
|
|
|
# The social media image of your page.
|
|
# Default: not set
|
|
# This is used for generating social media meta information for the opengraph
|
|
# protocol and twitter cards.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
images = [ "images/hero.png" ]
|
|
|
|
# The title of your page.
|
|
# Default: not set
|
|
# A page without a title is treated as a hidden page.
|
|
title = "Example Page"
|
|
|
|
# The description of your page.
|
|
# Default: not set
|
|
# This is used for generating HTML meta tags, social media meta information
|
|
# for the opengraph protocol and twitter cards.
|
|
# If not set, the set value of your site's hugo.toml is used for the html
|
|
# meta tag, social media meta information for the opengraph protocol and
|
|
# twitter cards.
|
|
description = ""
|
|
|
|
###############################################################################
|
|
# Relearn Theme
|
|
# These options are specific to the Relearn theme.
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# Topbar
|
|
# These options modify the topbar appearance.
|
|
|
|
# Hide the table of contents button.
|
|
# Default: false
|
|
# If the TOC button is hidden, also the keyboard shortcut is disabled.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
disableToc = false
|
|
|
|
# Hide the breadcrumbs.
|
|
# Default: false
|
|
# If the breadcrumbs are hidden, the title of the displayed page will still be
|
|
# shown in the topbar.
|
|
disableBreadcrumb = false
|
|
|
|
# Hide Next and Previous navigation buttons.
|
|
# Default: false
|
|
# If the navigation buttons are hidden, also the keyboard shortcuts are
|
|
# disabled.
|
|
disableNextPrev = false
|
|
|
|
# The URL prefix to edit a page.
|
|
# Default: not set
|
|
# If set, an edit button will be shown in the topbar. If the button is hidden,
|
|
# also the keyboard shortcuts are disabled. The value can contain the macro
|
|
# `${FilePath}` which will be replaced by the file path of your displayed page.
|
|
# If not set, the set value of your site's hugo.toml is used. If the global
|
|
# parameter is given but you want to hide the button for the displayed page,
|
|
# you can set the value to an empty string. If instead of hiding you want to have
|
|
# an disabled button, you can set the value to a string containing just spaces.
|
|
# This is useful if you want to give the opportunity for people to create merge
|
|
# request for your content.
|
|
editURL = ""
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# Menu
|
|
# These options modify the menu apperance.
|
|
|
|
# Prefix for the title in main menu.
|
|
# Default: not set
|
|
# The title of the page in the menu will be prefixed by this HTML content.
|
|
menuPre = ""
|
|
|
|
# Suffix for the title in main menu.
|
|
# Default: not set
|
|
# The title of the page in the menu will be suffixed by this HTML content.
|
|
menuPost = ""
|
|
|
|
# The order of main menu submenus.
|
|
# Default: "weight"
|
|
# Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",
|
|
# "expirydate", "publishdate", "date", "length" or "default" (adhering to
|
|
# Hugo's default sort order).
|
|
# If not set, the value of the parent menu entry is used.
|
|
ordersectionsby = "weight"
|
|
|
|
# The initial expand state of submenus.
|
|
# Default: not set
|
|
# This controls whether submenus will be expanded (true), or collapsed (false)
|
|
# in the menu. If not set, the first menu level is set to false, all others
|
|
# levels are set to true. If not set, the value of the parent menu entry is used.
|
|
# If the displayed page has submenus, they will always been displayed expanded
|
|
# regardless of this option.
|
|
alwaysopen = ""
|
|
|
|
# Shows expander for submenus.
|
|
# Default: false
|
|
# If set to true, a submenu in the sidebar will be displayed in a collapsible
|
|
# tree view and a clickable expander is set in front of the entry.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
collapsibleMenu = true
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# Hidden pages
|
|
# These options configure how hidden pages are treated.
|
|
# A page flagged as hidden, is only removed from the main menu if you are
|
|
# currently not on this page or the hidden page is not part of current page's
|
|
# ancestors. For all other functionality in Hugo a hidden page behaves like any
|
|
# other page if not otherwise configured.
|
|
|
|
# Hide a page's menu entry.
|
|
# Default: false
|
|
# If this value is true, the page is hidden from the menu.
|
|
hidden = false
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# Content
|
|
# These options modify how your content is displayed.
|
|
|
|
# Prefix for the title in the content area.
|
|
# Default: not set
|
|
# The title of the page heading will be prefixed by this HTML content.
|
|
headingPre = ""
|
|
|
|
# Suffix for the title in the content area.
|
|
# Default: not set
|
|
# The title of the page heading will be suffixed by this HTML content.
|
|
headingPost = ""
|
|
|
|
# Display name of the page's last editor.
|
|
# Default: not set
|
|
# If set, it will be displayed in the default footer.
|
|
LastModifierDisplayName = ""
|
|
|
|
# Email address of the page's last editor.
|
|
# Default: not set
|
|
# If set together with LastModifierDisplayName, it will be displayed in the
|
|
# default footer.
|
|
LastModifierEmail = ""
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# Highlight
|
|
# These options configure how 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.
|
|
# If not set, the set value of your site's hugo.toml is used or given as a
|
|
# parameter to individual code blocks.
|
|
highlightWrap = true
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# Images
|
|
# These options configure how images are displayed.
|
|
|
|
# Image effects.
|
|
# See the documentation for how you can even add your own arbitrary effects to
|
|
# the list.
|
|
# All effect values default to the values of your site's hugo.toml and can be
|
|
# overridden thru URL parameter given to the image. See the documentation for
|
|
# details.
|
|
|
|
# Default: false
|
|
imageEffects.border = true
|
|
# Default: true
|
|
imageEffects.lazy = true
|
|
# Default: true
|
|
imageEffects.lightbox = true
|
|
# Default: false
|
|
imageEffects.shadow = false
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# MathJax
|
|
# These options configure how math formulae are displayed.
|
|
|
|
# Initialization options for MathJax.
|
|
# Default: not set
|
|
# A JSON value. See the MathJaxdocumentation for possible parameter.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
mathJaxInitialize = "{}"
|
|
|
|
# Only load MathJax if needed.
|
|
# Default: true
|
|
# If a Math shortcode is found, the option will be ignored and
|
|
# MathJax will be loaded regardlessly. The option is still useful in case you
|
|
# are using scripting to set up your graph. In this case no shortcode or
|
|
# codefence is involved and the library is not loaded by default. In this case
|
|
# you can set `disableMathJax=false` in your frontmatter to force the library to
|
|
# be loaded.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
disableMathJax = true
|
|
|
|
# URL for external MathJax library.
|
|
# Default: not set
|
|
# Specifies the remote location of the MathJax library. By default the shipped
|
|
# version will be used.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# Mermaid
|
|
# These options configure how Mermaid graphs are displayed.
|
|
|
|
# Make graphs panable and zoomable
|
|
# Default: false
|
|
# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
|
|
# with a reset button for the zoom.
|
|
# If not set, the set value of your site's hugo.toml is used or given as a
|
|
# parameter to individual graphs.
|
|
mermaidZoom = true
|
|
|
|
# Initialization options for Mermaid.
|
|
# Default: not set
|
|
# A JSON value. See the Mermaid documentation for possible parameter.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
|
|
|
|
# Only load Mermaid if needed.
|
|
# Default: true
|
|
# If a Mermaid shortcode or codefence is found, the option will be ignored and
|
|
# Mermaid will be loaded regardlessly. The option is still useful in case you
|
|
# are using scripting to set up your graph. In this case no shortcode or
|
|
# codefence is involved and the library is not loaded by default. In this case
|
|
# you can set `disableMermaid=false` in your frontmatter to force the library to
|
|
# be loaded.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
disableMermaid = true
|
|
|
|
# URL for external Mermaid library.
|
|
# Default: not set
|
|
# Specifies the remote location of the Mermaid library. By default the shipped
|
|
# version will be used.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"
|
|
|
|
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
# OpenApi
|
|
# These options configure how OpenAPI specifications are displayed.
|
|
|
|
# Only load OpenAPI if needed.
|
|
# Default: true
|
|
# If a OpenAPI shortcode is found, the option will be ignored and
|
|
# OpenAPI will be loaded regardlessly. The option is still useful in case you
|
|
# are using scripting to set up your graph. In this case no shortcode or
|
|
# codefence is involved and the library is not loaded by default. In this case
|
|
# you can set `disableOpenapi=false` in your frontmatter to force the library to
|
|
# be loaded.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
disableOpenapi = true
|
|
|
|
# URL for external OpenAPI library.
|
|
# Default: not set
|
|
# Specifies the remote location of the OpenAPI library. By default the shipped
|
|
# version will be used.
|
|
# If not set, the set value of your site's hugo.toml is used.
|
|
customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
|