theme: unsupport description in hugo.toml

This commit is contained in:
Sören Weber 2024-04-24 22:40:39 +02:00
parent bc13ade3e1
commit 79b42f95a8
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
11 changed files with 19 additions and 19 deletions
exampleSite/content/basics/migration

View file

@ -32,6 +32,12 @@ This document shows you what's new in the latest release and flags it with one o
--CODE-theme: monokai;
````
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The parameter `description` in your `hugo.toml` will now been ignored.
With the newly introduces unified handling of descriptions throughout the theme, the only place the old parameter would have been used was your home page.
For migration, move the `description` parameter of your `hugo.toml` into the frontmatter section of your home page.
- {{% badge style="warning" title=" " %}}Breaking{{% /badge %}} The frontmatter option `menuTitle` is now unsupported in favor for Hugos own `linkTitle`.
Additionally, if set `linkTitle` will now be used instead of `title` to generate the breadcrumb.
@ -46,8 +52,6 @@ This document shows you what's new in the latest release and flags it with one o
Previously, the summary erroneously was ignored which now can lead to different output if you set `description=true` as a parameter.
In addition, all places where descriptions are printed, now behave in the same way.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The [`include` shortcode](shortcodes/include) is now able to resolve links to resources as well as to files in the file system (the old behavior). You can configure to generate warnings or errors during build by setting `include.errorlevel` to either `warning` or `error` in your `hugo.toml` if a path can not be resolved.
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} Math is now usable without enclosing it in a shortcode or codefence by using Hugo's [passthrough configuration](shortcodes/math#passthrough-configuration).