docs: add ambiguity to examples combining front matter and options #567

This commit is contained in:
Sören Weber 2024-10-13 15:01:50 +02:00
parent c71bc520d7
commit a68b5ec4d1
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
9 changed files with 25 additions and 21 deletions

View file

@ -13,7 +13,7 @@ weight = 3
For example, this will open links in the same tab For example, this will open links in the same tab
{{< multiconfig fm=true >}} {{< multiconfig >}}
externalLinkTarget = '_self' externalLinkTarget = '_self'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -27,7 +27,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 fm=true >}} {{< multiconfig >}}
link.errorlevel = 'warning' link.errorlevel = 'warning'
image.errorlevel = 'warning' image.errorlevel = 'warning'
{{< /multiconfig >}} {{< /multiconfig >}}

View file

@ -26,11 +26,15 @@ 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 >}}
alwaysopen = false
{{< /multiconfig >}}
## Expander for Nested Sections ## Expander for Nested Sections
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Set `collapsibleMenu=true` to add an expander for submenus. This shows submenus as collapsible trees with a clickable expander. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Set `collapsibleMenu=true` to add an expander for submenus. This shows submenus as collapsible trees with a clickable expander.
{{< multiconfig fm=true >}} {{< multiconfig >}}
collapsibleMenu = true collapsibleMenu = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -56,7 +60,7 @@ weight = 5
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Using the `weight` for sorting can get cumbersome if you, for example, just want to sort alphabetically. Each time you add a new page in the set of pages, you may have to renumber some or all of them to make space for the new page. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Using the `weight` for sorting can get cumbersome if you, for example, just want to sort alphabetically. Each time you add a new page in the set of pages, you may have to renumber some or all of them to make space for the new page.
{{< multiconfig fm=true >}} {{< multiconfig >}}
ordersectionsby = 'linktitle' ordersectionsby = 'linktitle'
{{< /multiconfig >}} {{< /multiconfig >}}

View file

@ -24,7 +24,7 @@ Your topbar contains the following elements. Some of them are configuarable:
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Set `disableToc=true` to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page's front matter. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Set `disableToc=true` to hide the TOC button on all pages. If the button is hidden, also the keyboard shortcut is disabled. This can be overridden in a page's front matter.
{{< multiconfig fm=true >}} {{< multiconfig >}}
disableToc = true disableToc = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -34,7 +34,7 @@ disableToc = true
Further breadcrumbs settings can be found in the [content configuration section](configuration/content/titles). Further breadcrumbs settings can be found in the [content configuration section](configuration/content/titles).
{{< multiconfig fm=true >}} {{< multiconfig >}}
disableBreadcrumb = true disableBreadcrumb = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -44,7 +44,7 @@ disableBreadcrumb = true
The value can contain the macro `${FilePath}` which will be replaced by the file path of your displayed page. If no `${FilePath}` is given in the value, the value is treated as if the `${FilePath}` was appended at the end of the value. This can be overridden in the pages front matter. The value can contain the macro `${FilePath}` which will be replaced by the file path of your displayed page. If no `${FilePath}` is given in the value, the value is treated as if the `${FilePath}` was appended at the end of the value. This can be overridden in the pages front matter.
{{< multiconfig fm=true >}} {{< multiconfig >}}
editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -52,6 +52,6 @@ editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide the previous/next buttons by setting `disableNextPrev=true`. If the buttons are hidden, also the keyboard shortcuts are disabled. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide the previous/next buttons by setting `disableNextPrev=true`. If the buttons are hidden, also the keyboard shortcuts are disabled.
{{< multiconfig fm=true >}} {{< multiconfig >}}
disableNextPrev = true disableNextPrev = true
{{< /multiconfig >}} {{< /multiconfig >}}

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 fm=true >}} {{< multiconfig >}}
highlightWrap=false highlightWrap=false
{{< /multiconfig >}} {{< /multiconfig >}}

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 fm=true >}} {{< multiconfig >}}
include.errorlevel = 'warning' include.errorlevel = 'warning'
{{< /multiconfig >}} {{< /multiconfig >}}

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 fm=true >}} {{< multiconfig >}}
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 fm=true >}} {{< multiconfig >}}
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 fm=true >}} {{< multiconfig >}}
math = true math = true
{{< /multiconfig >}} {{< /multiconfig >}}

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 fm=true >}} {{< multiconfig >}}
mermaidZoom = true mermaidZoom = true
{{< /multiconfig >}} {{< /multiconfig >}}
@ -88,7 +88,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 fm=true >}} {{< multiconfig >}}
mermaidInitialize = '{ "securityLevel": "loose" }' mermaidInitialize = '{ "securityLevel": "loose" }'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -98,7 +98,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 fm=true >}} {{< multiconfig >}}
customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js' customMermaidURL = 'https://unpkg.com/mermaid/dist/mermaid.min.js'
{{< /multiconfig >}} {{< /multiconfig >}}
@ -108,7 +108,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 fm=true >}} {{< multiconfig >}}
mermaid.force = true mermaid.force = true
{{< /multiconfig >}} {{< /multiconfig >}}

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 fm=true >}} {{< multiconfig >}}
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 fm=true >}} {{< multiconfig >}}
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 fm=true >}} {{< multiconfig >}}
openapi.force = true openapi.force = true
{{< /multiconfig >}} {{< /multiconfig >}}

View file

@ -1 +1 @@
6.4.0+11bc52f2df72bf90413142902cd9fe98c7374cc6 6.4.0+c71bc520d76cddfc7f09bd4294fef8c4270bab16