lwd/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn synced 2025-04-30 11:29:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: document all theme front matter below [params] #1064

Browse Source
This commit is contained in:
Sören Weber 2025-03-21 12:27:29 +01:00
parent 7701bac055
commit e2a1704c3c
No known key found for this signature in database
GPG Key ID: BEC6D55545451B6D
34 changed files with 196 additions and 252 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/config/_default/params.toml
View File

@ -9,33 +9,24 @@
# Hugo # Hugo
# These options usually apply to other themes as well. # These options usually apply to other themes as well.
# The title to be used for links to the main page
# Default: not set
# This name will be used for the link to the main page in the upper section
# of the menu. If not set, `title` from the Hugo settings will be used.
linkTitle = 'Relearn'
# The author of your site. # The author of your site.
# Default: not set # Default: not set
# This will be used in HTML meta tags, the open graph protocol and twitter # This will be used in HTML meta tags, the open graph protocol and twitter
# cards. # cards.
# You can also set `author.email` if you want to publish this information.
author.name = 'Sören Weber' author.name = 'Sören Weber'
# The author's email address of your site.
# Default: not set
# This will be used in HTML meta tags, the open graph protocol and twitter
# cards.
author.emailname = ''
# The social media image of your site. # The social media image of your site.
# Default: not set # Default: not set
# This is used for generating social media meta information for the opengraph # This is used for generating social media meta information for the opengraph
# protocol and twitter cards. # protocol and twitter cards.
# This can be overridden in the page's frontmatter. # This can be overridden in the page's frontmatter.
images = [ 'images/hero.png' ] images = [ 'images/hero.png' ]
# 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 # Relearn Theme
# These options are specific to the Relearn theme. # These options are specific to the Relearn theme.
@ -44,6 +35,12 @@ social.twitter = ''
# Branding # Branding
# These options set your overall visual appearance. # These options set your overall visual appearance.
# The title to be used for links to the main page
# Default: not set
# This name will be used for the link to the main page in the upper section
# of the menu. If not set, `title` from the Hugo settings will be used.
linkTitle = 'Relearn'
# Used color variants. # Used color variants.
# Default: 'auto' # Default: 'auto'
# This sets one or more color variants, available to your readers to choose # This sets one or more color variants, available to your readers to choose

6
docs/content/authoring/frontmatter/linking/index.en.md
View File

@ -15,7 +15,7 @@ To set default values for all links, use [link effects](authoring/linking/linkef
For example, this will open links in the same tab For example, this will open links in the same tab
{{< multiconfig >}} {{< multiconfig section=params >}}
externalLinkTarget = '_self' externalLinkTarget = '_self'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -29,7 +29,7 @@ Please note that this can not resolve files inside of your `static` directory. T
Link warnings are also available for the [include](shortcodes/include#enabling-link-warnings) and [openapi](shortcodes/openapi#enabling-link-warnings) shortcodes. Link warnings are also available for the [include](shortcodes/include#enabling-link-warnings) and [openapi](shortcodes/openapi#enabling-link-warnings) shortcodes.
{{< multiconfig >}} {{< multiconfig section=params >}}
link.errorlevel = 'warning' link.errorlevel = 'warning'
image.errorlevel = 'warning' image.errorlevel = 'warning'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -38,6 +38,6 @@ image.errorlevel = 'warning'
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} In case you want to use link warnings but are bothered by false negatives, you can configure an ignore list of regular expressions. The referenced address will be checked against all regexes of this list. If the address matches at least one regex, no output will be written to the console. The check uses [Hugo's `findRE` function](https://gohugo.io/functions/strings/findre/). {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} In case you want to use link warnings but are bothered by false negatives, you can configure an ignore list of regular expressions. The referenced address will be checked against all regexes of this list. If the address matches at least one regex, no output will be written to the console. The check uses [Hugo's `findRE` function](https://gohugo.io/functions/strings/findre/).
{{< multiconfig >}} {{< multiconfig section=params >}}
errorignore = [ '^/authoring/', '^/configuration/' ] errorignore = [ '^/authoring/', '^/configuration/' ]
{{< /multiconfig >}} {{< /multiconfig >}}

5
docs/content/authoring/frontmatter/reference/_index.en.md
View File

@ -14,7 +14,7 @@ Throughout the documentation, theme-specific front matter is marked with a {{% b
Add theme front matter directly to the root of your page's front matter. For example: Add theme front matter directly to the root of your page's front matter. For example:
{{< multiconfig fm=true >}} {{< multiconfig fm=true section=params >}}
math = true math = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -26,7 +26,7 @@ Add theme front matter directly to the root of your page's front matter. For exa
Here's a list of all available front matter with example values. Default values are described in the [annotated example](#annotated-front-matter) below or in each front matter's documentation. Here's a list of all available front matter with example values. Default values are described in the [annotated example](#annotated-front-matter) below or in each front matter's documentation.
{{< multiconfig fm=true >}} {{< multiconfig fm=true section=params >}}
{{% include "frontmatter.toml" %}} {{% include "frontmatter.toml" %}}
{{< /multiconfig >}} {{< /multiconfig >}}
@ -34,5 +34,6 @@ Here's a list of all available front matter with example values. Default values
````toml {title="toml"} ````toml {title="toml"}
+++ +++
[params]
{{% include "frontmatter.toml" %}}+++ {{% include "frontmatter.toml" %}}+++
```` ````

8
docs/content/authoring/frontmatter/reference/frontmatter.toml
View File

@ -10,12 +10,12 @@
# This is used for generating social media meta information for the opengraph # This is used for generating social media meta information for the opengraph
# protocol and twitter cards. # protocol and twitter cards.
# If not set, the set value of your site's hugo.toml is used. # If not set, the set value of your site's hugo.toml is used.
images = [ 'images/hero.png' ] # images = [ 'images/hero.png' ]
# The title of your page. # The title of your page.
# Default: not set # Default: not set
# A page without a title is treated as a hidden page. # A page without a title is treated as a hidden page.
title = 'Example Page' # title = 'Example Page'
# The description of your page. # The description of your page.
# Default: not set # Default: not set
@ -24,13 +24,13 @@ title = 'Example Page'
# If not set, the set value of your site's hugo.toml is used for the html # 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 # meta tag, social media meta information for the opengraph protocol and
# twitter cards. # twitter cards.
description = '' # description = ''
# The page design to be used # The page design to be used
# Default: not set # Default: not set
# This decides the layout of your page. The theme ships 'home', 'chapter' and # This decides the layout of your page. The theme ships 'home', 'chapter' and
# 'default'. If not set, 'default' is taken. # 'default'. If not set, 'default' is taken.
type = '' # type = ''
############################################################################### ###############################################################################
# Relearn Theme # Relearn Theme

30
docs/content/authoring/linking/imageeffects.en.md
View File

@ -32,20 +32,18 @@ If an effect accepts boolean values, only setting the parameter name without a v
Without any settings in your `hugo.toml` `imageEffects` defaults to Without any settings in your `hugo.toml` `imageEffects` defaults to
{{< multiconfig >}} {{< multiconfig >}}
[imageEffects] imageEffects.border = false
border = false imageEffects.dataurl = false
dataurl = false imageEffects.inlinecontent = false
inlinecontent = false imageEffects.lazy = true
lazy = true imageEffects.lightbox = true
lightbox = true imageEffects.shadow = false
shadow = false
{{< /multiconfig >}} {{< /multiconfig >}}
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} This can be overridden in a pages front matter for example by {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} This can be overridden in a pages front matter for example by
{{< multiconfig fm=true >}} {{< multiconfig fm=true section=params >}}
[imageEffects] imageEffects.lazy = false
lazy = false
{{< /multiconfig >}} {{< /multiconfig >}}
Or by explicitly override settings by URL query parameter Or by explicitly override settings by URL query parameter
@ -57,10 +55,10 @@ Or by explicitly override settings by URL query parameter
The settings applied to the above image would be The settings applied to the above image would be
{{< multiconfig >}} {{< multiconfig >}}
border = true imageEffects.border = true
dataurl = false imageEffects.dataurl = false
inlinecontent = false imageEffects.inlinecontent = false
lazy = true imageEffects.lazy = true
lightbox = false imageEffects.lightbox = false
shadow = false imageEffects.shadow = false
{{< /multiconfig >}} {{< /multiconfig >}}

14
docs/content/authoring/linking/linkeffects.en.md
View File

@ -28,16 +28,14 @@ If an effect accepts boolean values, only setting the parameter name without a v
Without any settings in your `hugo.toml` `linkEffects` defaults to Without any settings in your `hugo.toml` `linkEffects` defaults to
{{< multiconfig >}} {{< multiconfig >}}
[linkEffects] linkEffects.download = false
download = false linkEffects.target = false
target = false
{{< /multiconfig >}} {{< /multiconfig >}}
{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} This can be overridden in a pages front matter for example by {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} This can be overridden in a pages front matter for example by
{{< multiconfig fm=true >}} {{< multiconfig fm=true section=params >}}
[linkEffects] linkEffects.target = '_blank'
target = '_blank'
{{< /multiconfig >}} {{< /multiconfig >}}
Or by explicitly override settings by URL query parameter Or by explicitly override settings by URL query parameter
@ -49,6 +47,6 @@ Or by explicitly override settings by URL query parameter
The settings applied to the above link would be The settings applied to the above link would be
{{< multiconfig >}} {{< multiconfig >}}
download = false linkEffects.download = false
target = '_self' linkEffects.target = '_self'
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/authoring/meta/_index.en.md
View File

@ -42,7 +42,7 @@ images = [ 'images/hero.png' ]
[See how you can further configure visibility](configuration/content/hidden) throughout your site. [See how you can further configure visibility](configuration/content/hidden) throughout your site.
{{< multiconfig fm=true >}} {{< multiconfig fm=true section=params >}}
hidden = true hidden = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -52,7 +52,7 @@ hidden = true
You also may want to [apply further CSS](configuration/customization/extending#adding-javascript-or-stylesheets-to-all-pages) in this case. You also may want to [apply further CSS](configuration/customization/extending#adding-javascript-or-stylesheets-to-all-pages) in this case.
{{< multiconfig fm=true >}} {{< multiconfig fm=true section=params >}}
headingPre = '<i class="fab fa-github"></i> ' headingPre = '<i class="fab fa-github"></i> '
{{< /multiconfig >}} {{< /multiconfig >}}
@ -66,7 +66,7 @@ headingPre = '<i class="fab fa-github"></i> '
See how to further [configure this information](configuration/content/meta) on a site-wide basis. See how to further [configure this information](configuration/content/meta) on a site-wide basis.
{{< multiconfig fm=true >}} {{< multiconfig fm=true section=params >}}
LastModifierDisplayName = 'Santa Claus' LastModifierDisplayName = 'Santa Claus'
LastModifierEmail = 'santa@example.com' LastModifierEmail = 'santa@example.com'
date = 2000-12-24T00:00:00-12:00 date = 2000-12-24T00:00:00-12:00

32
docs/content/configuration/branding/colors/_index.en.md
View File

@ -43,8 +43,7 @@ The theme offers the recommended [advanced configuration mode](#theme-variant-ad
Set `themeVariant` to your theme CSS file name: Set `themeVariant` to your theme CSS file name:
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
themeVariant = 'relearn-light' themeVariant = 'relearn-light'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -56,8 +55,7 @@ In the above example, the path of your theme file must be `assets/css/theme-rele
To let the reader choose between multiple variants by displaying a variant switcher, set `themeVariant` like this: To let the reader choose between multiple variants by displaying a variant switcher, set `themeVariant` like this:
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
themeVariant = [ 'relearn-light', 'relearn-dark' ] themeVariant = [ 'relearn-light', 'relearn-dark' ]
{{< /multiconfig >}} {{< /multiconfig >}}
@ -69,8 +67,7 @@ If you want to have more control, where the variant switcher is positioned or yo
Use the `auto` value to match OS light/dark settings. Usually it makes sense to set it in the first position and make it the default. Use the `auto` value to match OS light/dark settings. Usually it makes sense to set it in the first position and make it the default.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
themeVariant = [ 'auto', 'red' ] themeVariant = [ 'auto', 'red' ]
{{< /multiconfig >}} {{< /multiconfig >}}
@ -80,8 +77,7 @@ Default is `relearn-light` for light and `relearn-dark` for dark mode. These def
You can override the default with `themeVariantAuto`: You can override the default with `themeVariantAuto`:
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
themeVariantAuto = [ 'learn', 'neon' ] themeVariantAuto = [ 'learn', 'neon' ]
{{< /multiconfig >}} {{< /multiconfig >}}
@ -93,19 +89,17 @@ Like with the [multiple variants](#multiple-variants) option, you are defining y
Again, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry. Again, in this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer if the array contains more than one entry.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
themeVariant = [ 'relearn-light', 'relearn-dark' ] themeVariant = [ 'relearn-light', 'relearn-dark' ]
{{< /multiconfig >}} {{< /multiconfig >}}
you now write it that way: you now write it that way:
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params] themeVariant = [
[[params.themeVariant]] {identifier = 'relearn-light'},
identifier = 'relearn-light' {identifier = 'relearn-dark'}
[[params.themeVariant]] ]
identifier = 'relearn-dark'
{{< /multiconfig >}} {{< /multiconfig >}}
The `identifier` option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below. The `identifier` option is mandatory and equivalent to the string in the first example. Further options can be configured, see the table below.
@ -120,8 +114,7 @@ The `identifier` option is mandatory and equivalent to the string in the first e
#### Example Configuration #### Example Configuration
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
themeVariant = [ themeVariant = [
{ identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [] }, { identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [] },
{ identifier = 'relearn-light' }, { identifier = 'relearn-light' },
@ -164,8 +157,7 @@ In case you like a shipped variant but only want to tweak some aspects, you have
Afterwards, put this in your `hugo.toml` to use your new variant: Afterwards, put this in your `hugo.toml` to use your new variant:
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
themeVariant = 'my-branding' themeVariant = 'my-branding'
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/configuration/content/headings/index.en.md
View File

@ -14,8 +14,7 @@ You can change what happens when you click the anchor icon in your `hugo.toml` f
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `disableAnchorCopy=true` to prevent copying the anchor link when you click the icon. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `disableAnchorCopy=true` to prevent copying the anchor link when you click the icon.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableAnchorCopy = true disableAnchorCopy = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -23,7 +22,6 @@ You can change what happens when you click the anchor icon in your `hugo.toml` f
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `disableAnchorScrolling=true` to stop the page from scrolling to the heading when you click the anchor icon. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set `disableAnchorScrolling=true` to stop the page from scrolling to the heading when you click the anchor icon.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableAnchorScrolling = true disableAnchorScrolling = true
{{< /multiconfig >}} {{< /multiconfig >}}

9
docs/content/configuration/content/hidden/_index.en.md
View File

@ -20,8 +20,7 @@ By default, hidden pages are only hidden from human visitors. Search engines can
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To remove hidden pages from search results, use `disableSearchHiddenPages=true`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To remove hidden pages from search results, use `disableSearchHiddenPages=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableSearchHiddenPages = true disableSearchHiddenPages = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -29,8 +28,7 @@ By default, hidden pages are only hidden from human visitors. Search engines can
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To hide pages from search engines by removing them from the sitemap, RSS feed and [make them `nofollow`](https://developers.google.com/search/docs/crawling-indexing/robots-meta-tag#directives), use `disableSeoHiddenPages=true`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To hide pages from search engines by removing them from the sitemap, RSS feed and [make them `nofollow`](https://developers.google.com/search/docs/crawling-indexing/robots-meta-tag#directives), use `disableSeoHiddenPages=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableSeoHiddenPages = true disableSeoHiddenPages = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -38,7 +36,6 @@ By default, hidden pages are only hidden from human visitors. Search engines can
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To prevent hidden pages from appearing on taxonomy and term pages, use `disableTagHiddenPages=true`. If this makes a term's count zero, an empty term page will still be created but not linked. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To prevent hidden pages from appearing on taxonomy and term pages, use `disableTagHiddenPages=true`. If this makes a term's count zero, an empty term page will still be created but not linked.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableTagHiddenPages = true disableTagHiddenPages = true
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/configuration/content/linking/index.en.md
View File

@ -16,8 +16,7 @@ If you're only using a web server scenario and dislike this, you can reset to Hu
For the file system scenario, you are not allowed to change this value. For the file system scenario, you are not allowed to change this value.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableExplicitIndexURLs = true disableExplicitIndexURLs = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -37,7 +36,6 @@ In configurations using a **baseURL** with a **subdirectory** and having **relat
To work around this, you can activate a patched version of the shortcode by setting `disableDefaultRelref=true`. To work around this, you can activate a patched version of the shortcode by setting `disableDefaultRelref=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableDefaultRelref = true disableDefaultRelref = true
{{< /multiconfig >}} {{< /multiconfig >}}

12
docs/content/configuration/content/meta/index.en.md
View File

@ -16,8 +16,7 @@ In cases where Git information is not available, the theme falls back to `LastMo
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can disable the output of an author's name and its according email address by setting this parameter to `true`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can disable the output of an author's name and its according email address by setting this parameter to `true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
hideAuthorName = true hideAuthorName = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -25,8 +24,7 @@ In cases where Git information is not available, the theme falls back to `LastMo
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} The author's email, when displayed, is presented as a clickable mailto link, providing a convenient way for readers to reach out. You can disable the output of an author's email address by setting this parameter to `true`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} The author's email, when displayed, is presented as a clickable mailto link, providing a convenient way for readers to reach out. You can disable the output of an author's email address by setting this parameter to `true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
hideAuthorEmail = true hideAuthorEmail = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -34,8 +32,7 @@ In cases where Git information is not available, the theme falls back to `LastMo
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} # If the standard content-footer finds an authoring date, you can disable its output by setting this parameter to `true`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} # If the standard content-footer finds an authoring date, you can disable its output by setting this parameter to `true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
hideAuthorDate = true hideAuthorDate = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -43,7 +40,6 @@ In cases where Git information is not available, the theme falls back to `LastMo
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can overwrite the default date format used when displaying a pages meta information. See [the Hugo docs](https://gohugo.io/functions/time/format/#localization) for possible values. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can overwrite the default date format used when displaying a pages meta information. See [the Hugo docs](https://gohugo.io/functions/time/format/#localization) for possible values.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
dateFormat = ':date_medium' dateFormat = ':date_medium'
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/configuration/content/titles/index.en.md
View File

@ -16,8 +16,7 @@ Learn how to turn off the breadcrumbs completely and further [configure the topb
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} By default the term pages of a taxonomy will display the breadcrumb for each page. Set `disableTermBreadcrumbs=true` to remove the breadcrumb if the term pages look to cluttered. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} By default the term pages of a taxonomy will display the breadcrumb for each page. Set `disableTermBreadcrumbs=true` to remove the breadcrumb if the term pages look to cluttered.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableRootBreadcrumb = true disableRootBreadcrumb = true
breadcrumbSeparator = '/' breadcrumbSeparator = '/'
disableTermBreadcrumbs = true disableTermBreadcrumbs = true
@ -27,7 +26,6 @@ Learn how to turn off the breadcrumbs completely and further [configure the topb
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can override the default title separator by using `titleSeparator='|'`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can override the default title separator by using `titleSeparator='|'`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
titleSeparator = '|' titleSeparator = '|'
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/configuration/customization/extending/_index.en.md
View File

@ -40,9 +40,9 @@ For example, to create a shortcode called `myshortcode` that needs the `jquery`
2. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Add this to your `hugo.toml`: 2. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Add this to your `hugo.toml`:
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params.relearn.dependencies] [relearn.dependencies]
[params.relearn.dependencies.myshortcode] [relearn.dependencies.myshortcode]
name = 'MyShortcode' name = 'MyShortcode'
{{< /multiconfig >}} {{< /multiconfig >}}

38
docs/content/configuration/customization/imageeffects.en.md
View File

@ -15,38 +15,34 @@ If you don't configure anything in your `hugo.toml`, the image effects default t
## Default Values ## Default Values
{{< multiconfig >}} {{< multiconfig >}}
[imageEffects] imageEffects.border = false
border = false imageEffects.dataurl = false
dataurl = false imageEffects.inlinecontent = false
inlinecontent = false imageEffects.lazy = true
lazy = true imageEffects.lightbox = true
lightbox = true imageEffects.shadow = false
shadow = false
{{< /multiconfig >}} {{< /multiconfig >}}
## Configuration ## Configuration
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can change these settings in your `hugo.toml` and add arbitrary custom effects as boolean values (like `bg-white` in the below snippet). {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can change these settings in your `hugo.toml` and add arbitrary custom effects as boolean values (like `bg-white` in the below snippet).
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params] imageEffects.bg-white = true
[params.imageEffects] imageEffects.border = true
bg-white = true imageEffects.lazy = false
border = true
lazy = false
{{< /multiconfig >}} {{< /multiconfig >}}
This would result in This would result in
{{< multiconfig >}} {{< multiconfig >}}
[imageEffects] imageEffects.bg-white = true
bg-white = true imageEffects.border = true
border = true imageEffects.dataurl = false
dataurl = false imageEffects.inlinecontent = false
inlinecontent = false imageEffects.lazy = false
lazy = false imageEffects.lightbox = true
lightbox = true imageEffects.shadow = false
shadow = false
{{< /multiconfig >}} {{< /multiconfig >}}
### Example ### Example

19
docs/content/configuration/customization/linkeffects.en.md
View File

@ -15,29 +15,26 @@ If you don't configure anything in your `hugo.toml`, the link effects default to
## Default Values ## Default Values
{{< multiconfig >}} {{< multiconfig >}}
[linkEffects] linkEffects.download = false
download = false linkEffects.target = false
target = false
{{< /multiconfig >}} {{< /multiconfig >}}
## Configuration ## Configuration
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can change these settings in your `hugo.toml` and add arbitrary custom effects as boolean values (like `bg-white` in the below snippet). {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} You can change these settings in your `hugo.toml` and add arbitrary custom effects as boolean values (like `bg-white` in the below snippet).
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params] linkEffects.bg-white = true
[params.linkEffects] linkEffects.target = '_blank'
bg-white = true
target = '_blank'
{{< /multiconfig >}} {{< /multiconfig >}}
This would result in This would result in
{{< multiconfig >}} {{< multiconfig >}}
[linkEffects] [linkEffects]
bg-white = true linkEffects.bg-white = true
download = false linkEffects.download = false
target = '_blank' linkEffects.target = '_blank'
{{< /multiconfig >}} {{< /multiconfig >}}
### Example ### Example

3
docs/content/configuration/reference/_index.en.md
View File

@ -13,8 +13,7 @@ Throughout the documentation, theme-specific options are marked with a {{% badge
Add theme options to the `params` section of your `hugo.toml`. For example: Add theme options to the `params` section of your `hugo.toml`. For example:
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
math = true math = true
{{< /multiconfig >}} {{< /multiconfig >}}

12
docs/content/configuration/sidebar/headerfooter/_index.en.md
View File

@ -10,8 +10,7 @@ weight = 2
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} With the [default partials](configuration/branding/logo#change-the-logo) for the logo, The site title will also be used for the text at the top of the sidebar. If you want to show a different text in the sidebar, you can overwrite `linkTitle`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} With the [default partials](configuration/branding/logo#change-the-logo) for the logo, The site title will also be used for the text at the top of the sidebar. If you want to show a different text in the sidebar, you can overwrite `linkTitle`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
linkTitle = 'Relearn' linkTitle = 'Relearn'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -23,8 +22,7 @@ By default, the theme displays a home button between search form and navigation
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To hide the Home button on the left menu, set `disableLandingPageButton=true`. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} To hide the Home button on the left menu, set `disableLandingPageButton=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableLandingPageButton = true disableLandingPageButton = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -43,8 +41,7 @@ By default, the theme displays a home button between search form and navigation
If this option isn't set for a specific language, it will use these default values If this option isn't set for a specific language, it will use these default values
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
landingPageName = '<i class="fa-fw fas fa-home"></i> Home' landingPageName = '<i class="fa-fw fas fa-home"></i> Home'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -58,8 +55,7 @@ If you want to have more control, where the history clearer is positioned or you
Note that checkmarks will disappear if you rebuild your site, as the page IDs may change. Note that checkmarks will disappear if you rebuild your site, as the page IDs may change.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
showVisitedLinks = true showVisitedLinks = true
{{< /multiconfig >}} {{< /multiconfig >}}

15
docs/content/configuration/sidebar/menus/_index.en.md
View File

@ -36,7 +36,7 @@ The theme generates the expand state based on the following rules:
- all [visible](authoring/meta#hidden) entries show their immediate child entries if `alwaysopen=true`; this proceeds recursively - all [visible](authoring/meta#hidden) entries show their immediate child entries if `alwaysopen=true`; this proceeds recursively
- all remaining entries are not shown - all remaining entries are not shown
{{< multiconfig >}} {{< multiconfig section=params >}}
alwaysopen = false alwaysopen = false
{{< /multiconfig >}} {{< /multiconfig >}}
@ -46,7 +46,7 @@ alwaysopen = false
{{% badge color="blueviolet" icon="bars" title=" " %}}Menu{{% /badge %}} For Hugo menus, you have to set `params.collapsibleMenu=true` instead. {{% badge color="blueviolet" icon="bars" title=" " %}}Menu{{% /badge %}} For Hugo menus, you have to set `params.collapsibleMenu=true` instead.
{{< multiconfig >}} {{< multiconfig section=params >}}
collapsibleMenu = true collapsibleMenu = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -77,7 +77,7 @@ Using the `weight` for sorting can get cumbersome if you, for example, just want
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Use `ordersectionsby` to sort by other aspects. See the [children shortcode](shortcodes/children#parameter) for a complete list. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Use `ordersectionsby` to sort by other aspects. See the [children shortcode](shortcodes/children#parameter) for a complete list.
{{< multiconfig >}} {{< multiconfig section=params >}}
ordersectionsby = 'linktitle' ordersectionsby = 'linktitle'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -106,6 +106,7 @@ The example below uses the GitHub icon for an entry of a page menu.
{{< multiconfig fm=true >}} {{< multiconfig fm=true >}}
title = 'GitHub Repo' title = 'GitHub Repo'
[params]
menuPre = '<i class="fab fa-github"></i> ' menuPre = '<i class="fab fa-github"></i> '
{{< /multiconfig >}} {{< /multiconfig >}}
@ -169,8 +170,7 @@ By default, the theme supports one additional Hugo menu below the page menu in t
You can disable this title with `disableShortcutsTitle=true`. You can disable this title with `disableShortcutsTitle=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableShortcutsTitle = true disableShortcutsTitle = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -240,7 +240,7 @@ If you don't set these options in your `hugo.toml`, the theme defaults as follow
However, if you decide to overwrite these options, the configuration for those features will not be taken into account anymore. For example, if you want to reorder the `sidebarfootermenus` by setting However, if you decide to overwrite these options, the configuration for those features will not be taken into account anymore. For example, if you want to reorder the `sidebarfootermenus` by setting
{{< multiconfig >}} {{< multiconfig section=params >}}
sidebarfootermenus = [ sidebarfootermenus = [
{ type = 'divider' }, { type = 'divider' },
{ type = 'custom', elements = [ { type = 'historyclearer' }, { type = 'variantswitcher' }, { type = 'languageswitcher' } ] } { type = 'custom', elements = [ { type = 'historyclearer' }, { type = 'variantswitcher' }, { type = 'languageswitcher' } ] }
@ -303,7 +303,7 @@ A horizontal ruler
The following example configures the language switcher and history clearer into the menu header, only shows the the page menu in the main sidebar section and keeps the menu footer empty: The following example configures the language switcher and history clearer into the menu header, only shows the the page menu in the main sidebar section and keeps the menu footer empty:
{{< multiconfig >}} {{< multiconfig section=params >}}
sidebarheadermenus = [ sidebarheadermenus = [
{ type = 'custom', elements = [ { type = 'custom', elements = [
{ type = 'languageswitcher' }, { type = 'languageswitcher' },
@ -390,6 +390,7 @@ For that create a new page with the following front matter
{{< multiconfig fm=true file="content/crows-nest-incident.md" >}} {{< multiconfig fm=true file="content/crows-nest-incident.md" >}}
title = "The Crow's Nest Incident" title = "The Crow's Nest Incident"
[params]
menuPageRef = '/log/third-day' menuPageRef = '/log/third-day'
{{< /multiconfig >}} {{< /multiconfig >}}

9
docs/content/configuration/sidebar/search/_index.en.md
View File

@ -22,8 +22,7 @@ Each level requires the previous one to be enabled. If no search is configured,
- Search popup: `disableSearchIndex=true` - Search popup: `disableSearchIndex=true`
- Dedicated search page: `disableSearchPage=true` - Dedicated search page: `disableSearchPage=true`
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableSearch = true disableSearch = true
disableSearchIndex = true disableSearchIndex = true
disableSearchPage = true disableSearchPage = true
@ -34,8 +33,7 @@ Each level requires the previous one to be enabled. If no search is configured,
- Search popup: `searchindex.js` set by `searchIndexURL` - Search popup: `searchindex.js` set by `searchIndexURL`
- Dedicated search page: `search/index.html` set by `searchPageURL` - Dedicated search page: `search/index.html` set by `searchPageURL`
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
searchIndexURL = 'omnisearchindex.js' searchIndexURL = 'omnisearchindex.js'
searchPageURL = 'omnisearch' searchPageURL = 'omnisearch'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -61,8 +59,7 @@ The [Lunr](https://lunrjs.com) search library doesn't support all languages of t
{{%badge style="cyan" icon="gears" title=" "%}}Option{{%/badge%}} In case your page's content contains text in multiple languages (for example, you are writing a Piratish documentation for your English API), you can set those languages in `additionalContentLanguage` to broaden the search. {{%badge style="cyan" icon="gears" title=" "%}}Option{{%/badge%}} In case your page's content contains text in multiple languages (for example, you are writing a Piratish documentation for your English API), you can set those languages in `additionalContentLanguage` to broaden the search.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
additionalContentLanguage = [ "en" ] additionalContentLanguage = [ "en" ]
{{< /multiconfig >}} {{< /multiconfig >}}

5
docs/content/configuration/sitemanagement/meta/_index.en.md
View File

@ -11,9 +11,8 @@ weight = 4
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} The theme uses author details in various parts of your site, like RSS feeds and meta tags. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} The theme uses author details in various parts of your site, like RSS feeds and meta tags.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params] [author]
[params.author]
name = 'Santa Claus' name = 'Santa Claus'
email = 'santa@example.com' email = 'santa@example.com'
{{< /multiconfig >}} {{< /multiconfig >}}

3
docs/content/configuration/sitemanagement/multilingual/_index.en.md
View File

@ -152,7 +152,6 @@ If you want to have more control, where the language switcher is positioned or y
To disable the language switcher set `disableLanguageSwitchingButton=true` To disable the language switcher set `disableLanguageSwitchingButton=true`
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableLanguageSwitchingButton = true disableLanguageSwitchingButton = true
{{< /multiconfig >}} {{< /multiconfig >}}

12
docs/content/configuration/sitemanagement/stableoutput/_index.en.md
View File

@ -14,8 +14,7 @@ This isn't a security risk and helps us support you better.
To turn this off, set `disableGeneratorVersion=true`. To turn this off, set `disableGeneratorVersion=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableGeneratorVersion = true disableGeneratorVersion = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -29,8 +28,7 @@ This is good for production sites but can be problematic during development. It
To disable this, set `disableAssetsBusting=true`. To disable this, set `disableAssetsBusting=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableAssetsBusting = true disableAssetsBusting = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -42,8 +40,7 @@ This is necessary for the theme to work properly, but it can make comparing outp
To turn this off, set `disableRandomIds=true`. Note, that this will result in a non-functional site!. To turn this off, set `disableRandomIds=true`. Note, that this will result in a non-functional site!.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableRandomIds = true disableRandomIds = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -51,7 +48,6 @@ To turn this off, set `disableRandomIds=true`. Note, that this will result in a
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If `minify=true`, further theme assets will be minified during build. If no value is set, the theme will avoid minification if you have started with `hugo server` and otherwise will minify. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} If `minify=true`, further theme assets will be minified during build. If no value is set, the theme will avoid minification if you have started with `hugo server` and otherwise will minify.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
minify = false minify = false
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/configuration/sitemanagement/versioning/_index.en.md
View File

@ -162,8 +162,7 @@ To stay with the above example, here's the configuration for your current versio
You can disable it be setting the `disableVersionWarning` option to `true` in your `hugo.toml`. You can disable it be setting the `disableVersionWarning` option to `true` in your `hugo.toml`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableVersionWarning = true disableVersionWarning = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -171,8 +170,7 @@ You can disable it be setting the `disableVersionWarning` option to `true` in yo
{{%badge style="cyan" icon="gears" title=" "%}}Option{{%/badge%}} The default URL for the version index can be changed with the `versionIndexURL` parameter {{%badge style="cyan" icon="gears" title=" "%}}Option{{%/badge%}} The default URL for the version index can be changed with the `versionIndexURL` parameter
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
versionIndexURL = 'myversionindex.js' versionIndexURL = 'myversionindex.js'
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/introduction/releasenotes/5/23.en.md
View File

@ -16,15 +16,13 @@ weight = -23
Change your previous setting from Change your previous setting from
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
author = 'Hugo' author = 'Hugo'
{{< /multiconfig >}} {{< /multiconfig >}}
to to
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
author.name = 'Hugo' author.name = 'Hugo'
{{< /multiconfig >}} {{< /multiconfig >}}

3
docs/content/introduction/releasenotes/6/1.en.md
View File

@ -28,8 +28,7 @@ weight = -1
The shortcode is deactivated by default and can be activated by setting The shortcode is deactivated by default and can be activated by setting
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableDefaultRelref = true disableDefaultRelref = true
{{< /multiconfig >}} {{< /multiconfig >}}

8
docs/content/shortcodes/highlight.en.md
View File

@ -111,7 +111,7 @@ If used together with wrapping of long lines, use this recommended settings. Oth
You can disable wrapping by setting `highlightWrap=false` or by setting the [`wrap` parameter](#parameter) individually for each code block. You can disable wrapping by setting `highlightWrap=false` or by setting the [`wrap` parameter](#parameter) individually for each code block.
{{< multiconfig >}} {{< multiconfig section=params >}}
highlightWrap=false highlightWrap=false
{{< /multiconfig >}} {{< /multiconfig >}}
@ -121,8 +121,7 @@ highlightWrap=false
If you want to disable this feature, set `disableInlineCopyToClipBoard=true`. If you want to disable this feature, set `disableInlineCopyToClipBoard=true`.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableInlineCopyToClipBoard = true disableInlineCopyToClipBoard = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -132,8 +131,7 @@ If you want to disable this feature, set `disableInlineCopyToClipBoard=true`.
Set `disableHoverBlockCopyToClipBoard=true` to disable the hover effect and always show the button. Set `disableHoverBlockCopyToClipBoard=true` to disable the hover effect and always show the button.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
disableHoverBlockCopyToClipBoard = true disableHoverBlockCopyToClipBoard = true
{{< /multiconfig >}} {{< /multiconfig >}}

2
docs/content/shortcodes/include/index.en.md
View File

@ -58,7 +58,7 @@ Please note that this can not resolve files inside of your `static` directory. T
Link warnings are also available for [images & links](authoring/frontmatter/linking#enabling-link-and-image-link-warnings) and the [openapi](shortcodes/openapi#enabling-link-warnings) shortcode. Link warnings are also available for [images & links](authoring/frontmatter/linking#enabling-link-and-image-link-warnings) and the [openapi](shortcodes/openapi#enabling-link-warnings) shortcode.
{{< multiconfig >}} {{< multiconfig section=params >}}
include.errorlevel = 'warning' include.errorlevel = 'warning'
{{< /multiconfig >}} {{< /multiconfig >}}

6
docs/content/shortcodes/math.en.md
View File

@ -74,7 +74,7 @@ You can overwrite the settings by providing a JSON object in `mathJaxInitialize`
Keep in mind that initialization settings of your pages front matter overwrite all settings of your configuration options. Keep in mind that initialization settings of your pages front matter overwrite all settings of your configuration options.
{{< multiconfig >}} {{< multiconfig section=params >}}
mathJaxInitialize = '{ "chtml": { "displayAlign": "left" }, { "tex": { "inlineMath": [["\(", "\)"], ["@", "@"]], displayMath: [["\[", "\]"], ["@@", "@@"]] }, "options": { "enableMenu": false }' mathJaxInitialize = '{ "chtml": { "displayAlign": "left" }, { "tex": { "inlineMath": [["\(", "\)"], ["@", "@"]], displayMath: [["\[", "\]"], ["@@", "@@"]] }, "options": { "enableMenu": false }'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -84,7 +84,7 @@ mathJaxInitialize = '{ "chtml": { "displayAlign": "left" }, { "tex": { "inlineMa
In case you want do use a different version of the MathJax library but don't want to override the shipped version, you can set `customMathJaxURL` to the URL of the external MathJax library. In case you want do use a different version of the MathJax library but don't want to override the shipped version, you can set `customMathJaxURL` to the URL of the external MathJax library.
{{< multiconfig >}} {{< multiconfig section=params >}}
customMathJaxURL = 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js' customMathJaxURL = 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -96,7 +96,7 @@ You can force loading the MathJax library if no shortcode or codefence was used
Instead of `math=true` you can also use the alias `math.force=true`. Instead of `math=true` you can also use the alias `math.force=true`.
{{< multiconfig >}} {{< multiconfig section=params >}}
math = true math = true
{{< /multiconfig >}} {{< /multiconfig >}}

8
docs/content/shortcodes/mermaid.en.md
View File

@ -74,7 +74,7 @@ By default this is disabled. Set `mermaidZoom=true` to enable it.
Individual settings of a graphs [`zoom` parameter](#parameter) have precedence over the page's front matter and configuration options in that order. Individual settings of a graphs [`zoom` parameter](#parameter) have precedence over the page's front matter and configuration options in that order.
{{< multiconfig >}} {{< multiconfig section=params >}}
mermaidZoom = true mermaidZoom = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -91,7 +91,7 @@ Keep in mind that initialization settings of your pages front matter overwrite a
In addition, you can merge settings for each individual graph through [diagram directives](https://mermaid-js.github.io/mermaid/#/directives?id=directives) on top of the settings of your page's front matter or configuration options. In addition, you can merge settings for each individual graph through [diagram directives](https://mermaid-js.github.io/mermaid/#/directives?id=directives) on top of the settings of your page's front matter or configuration options.
{{< multiconfig >}} {{< multiconfig section=params >}}
mermaidInitialize = '{ "securityLevel": "loose" }' mermaidInitialize = '{ "securityLevel": "loose" }'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -101,7 +101,7 @@ mermaidInitialize = '{ "securityLevel": "loose" }'
In case you want do use a different version of the Mermaid library but don't want to override the shipped version, you can set `customMermaidURL` to the URL of the external Mermaid library. In case you want do use a different version of the Mermaid library but don't want to override the shipped version, you can set `customMermaidURL` to the URL of the external Mermaid library.
{{< multiconfig >}} {{< multiconfig section=params >}}
customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js' customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -111,7 +111,7 @@ customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js'
You can force loading the Mermaid library if no shortcode or codefence was used by setting `mermaid.force=true`. If a shortcode or codefence was found, this option has no effect. This comes handy in case you are using scripting to render a graph. You can force loading the Mermaid library if no shortcode or codefence was used by setting `mermaid.force=true`. If a shortcode or codefence was found, this option has no effect. This comes handy in case you are using scripting to render a graph.
{{< multiconfig >}} {{< multiconfig section=params >}}
mermaid.force = true mermaid.force = true
{{< /multiconfig >}} {{< /multiconfig >}}

3
docs/content/shortcodes/notice.en.md
View File

@ -77,8 +77,7 @@ If you want to display a transparent expandable box without any border, you can
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Besides the predefined `style` values [from above](#parameter), you are able to define your own. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Besides the predefined `style` values [from above](#parameter), you are able to define your own.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params]
boxStyle = [ boxStyle = [
{ identifier = 'magic', i18n = '', title = 'Magic', icon = 'rainbow', color = 'gold' } { identifier = 'magic', i18n = '', title = 'Magic', icon = 'rainbow', color = 'gold' }
] ]

6
docs/content/shortcodes/openapi/_index.en.md
View File

@ -53,7 +53,7 @@ Please note that this can not resolve files inside of your `static` directory. T
Link warnings are also available for [images & links](authoring/frontmatter/linking#enabling-link-and-image-link-warnings) and the [include](shortcodes/include#enabling-link-warnings) shortcode. Link warnings are also available for [images & links](authoring/frontmatter/linking#enabling-link-and-image-link-warnings) and the [include](shortcodes/include#enabling-link-warnings) shortcode.
{{< multiconfig >}} {{< multiconfig section=params >}}
openapi.errorlevel = 'warning' openapi.errorlevel = 'warning'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -63,7 +63,7 @@ openapi.errorlevel = 'warning'
In case you want do use a different version of the Swagger UI library but don't want to override the shipped version, you can set `customOpenapiURL` to the URL of the external Swagger UI library. In case you want do use a different version of the Swagger UI library but don't want to override the shipped version, you can set `customOpenapiURL` to the URL of the external Swagger UI library.
{{< multiconfig >}} {{< multiconfig section=params >}}
customOpenapiURL = 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' customOpenapiURL = 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -73,7 +73,7 @@ customOpenapiURL = 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'
You can force loading the Swagger UI library if no shortcode or codefence was used by setting `openapi.force=true`. If a shortcode or codefence was found, the option has no effect. This comes handy in case you are using scripting to render a spec. You can force loading the Swagger UI library if no shortcode or codefence was used by setting `openapi.force=true`. If a shortcode or codefence was found, the option has no effect. This comes handy in case you are using scripting to render a spec.
{{< multiconfig >}} {{< multiconfig section=params >}}
openapi.force = true openapi.force = true
{{< /multiconfig >}} {{< /multiconfig >}}

5
docs/content/shortcodes/siteparam.en.md
View File

@ -62,9 +62,8 @@ To use formatted parameter, add this in your `hugo.toml`:
Now values containing Markdown will be formatted correctly. Now values containing Markdown will be formatted correctly.
{{< multiconfig file=hugo >}} {{< multiconfig file=hugo section=params >}}
[params] [siteparam.test]
[params.siteparam.test]
text = 'A **nested** parameter <b>with</b> formatting' text = 'A **nested** parameter <b>with</b> formatting'
{{< /multiconfig >}} {{< /multiconfig >}}

2
layouts/partials/version.txt
View File

@ -1 +1 @@
7.5.0+b825463f1897e63b27191f125fcfafd92a0a627a 7.5.0+7701bac055f1c664e3e449c82bf08a8aae677e9d