From cb7fdcef9f467564aa96c5396c917ca2f4d279b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Sat, 2 Mar 2024 14:19:46 +0100 Subject: [PATCH] docs: fix further code formatting #788 --- .../content/basics/customization/_index.en.md | 4 +-- .../content/basics/migration/_index.en.md | 35 +++++++++---------- .../content/basics/topbar/_index.en.md | 4 +-- exampleSite/content/cont/i18n/_index.en.md | 1 - exampleSite/content/cont/menushortcuts.en.md | 2 +- exampleSite/content/cont/taxonomy.en.md | 4 +-- .../content/shortcodes/siteparam.en.md | 6 ++-- 7 files changed, 27 insertions(+), 29 deletions(-) diff --git a/exampleSite/content/basics/customization/_index.en.md b/exampleSite/content/basics/customization/_index.en.md index e7e08b1ed8..153b4dd005 100644 --- a/exampleSite/content/basics/customization/_index.en.md +++ b/exampleSite/content/basics/customization/_index.en.md @@ -174,12 +174,12 @@ You can you use this mechanism in your own shortcodes. Say you want to add a sho 1. Add the following snippet to your `hugo.toml` - ````go + {{< multiconfig file=hugo >}} [params.relearn.dependencies] [params.relearn.dependencies.myshortcode] name = "MyShortcode" location = "footer" - ```` + {{< /multiconfig >}} 1. Add the dependency loader file `layouts/partials/dependencies/myshortcode.html`. The loader file will be appended to your header or footer, dependend on the `location` setting in your `hugo.toml`. diff --git a/exampleSite/content/basics/migration/_index.en.md b/exampleSite/content/basics/migration/_index.en.md index b58c5dafb0..0943007553 100644 --- a/exampleSite/content/basics/migration/_index.en.md +++ b/exampleSite/content/basics/migration/_index.en.md @@ -74,17 +74,17 @@ This document shows you what's new in the latest release and flags it with one o Change your previous setting from - ````toml + {{< multiconfig file=hugo >}} [params] author = "Hugo" - ```` + {{< /multiconfig >}} to - ````toml + {{< multiconfig file=hugo >}} [params] author.name = "Hugo" - ```` + {{< /multiconfig >}} - {{% badge style="note" title=" " %}}Change{{% /badge %}} Taxonomy [term pages](https://gohugo.io/content-management/taxonomies#add-custom-metadata-to-a-taxonomy-or-term) now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your `hugo.toml` by adding `disableTermBreadcrumbs=true`. @@ -287,8 +287,8 @@ This document shows you what's new in the latest release and flags it with one o So how to adjust the position of tags starting from the theme's default where tags are only shown above the title? 1. Hide tags above title: Overwrite `content-header.html` with an empty file. - 2. Show tags between title and content: Overwrite `heading-post.html` and add `{{- partial "tags.html" . }}` to it. - 3. Show tags below content: Overwrite `content-footer.html` and add `{{- partial "tags.html" . }}` to it. + 2. Show tags between title and content: Overwrite `heading-post.html` and add `{{ partial "tags.html" . }}` to it. + 3. Show tags below content: Overwrite `content-footer.html` and add `{{ partial "tags.html" . }}` to it. - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The new parameter `breadcrumbSeparator` is now available in your `hugo.toml` to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything. @@ -310,7 +310,7 @@ This document shows you what's new in the latest release and flags it with one o The theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your `frontmatter.json` like this - ````json + ````json {title="frontmatter.json"} { ... "frontMatter.extends": [ @@ -332,7 +332,7 @@ This document shows you what's new in the latest release and flags it with one o In case you made changes to the theme that are dependend on this library you can place a copy of jQuery into your `static/js` directory and load it from your own `layouts/partials/custom-header.html` like this: - ````html + ````html {title="layouts/partials/custom-header.html"} ```` @@ -378,29 +378,28 @@ This document shows you what's new in the latest release and flags it with one o 1. Make the page file a [headless branch bundle](https://gohugo.io/content-management/page-bundles/#headless-bundle) (contained in its own subdirectory and called `_index.md`) and add the following frontmatter configuration to the file (see exampleSite's `content/showcase/_index.en.md`). This causes its content to **not** be ontained in the sitemap. - ````toml + {{< multiconfig fm=true >}} title = "Showcase" [_build] render = "always" list = "never" publishResources = true - ```` + {{< /multiconfig >}} - 2. Store the page file for below a parent headless branch bundle and add the following frontmatter to he **parent** (see exampleSite's `content/more/_index.en.md`). + 2. Store the page file for below a parent headless branch bundle and add the following frontmatter to he **parent** (see exampleSite's `content/more/_index.en.md`). **Don't give this page a `title`** as this will cause it to be shown in the breadcrumbs - a thing you most likely don't want. - ````toml - # title = "More" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want + {{< multiconfig fm=true >}} [_build] render = "never" list = "never" publishResources = false - ```` + {{< /multiconfig >}} In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite's `content/more/credits.en.md`). This causes its content to be contained in the sitemap. - ````toml + {{< multiconfig fm=true >}} title = "Credits" - ```` + {{< /multiconfig >}} - {{% badge style="note" title=" " %}}Change{{% /badge %}} The required folder name for the [`attachments` shortcode](shortcodes/attachments) was changed for leaf bundles. @@ -516,7 +515,7 @@ This document shows you what's new in the latest release and flags it with one o You can revert this behavior by overwriting the `print` output format setting in your `hugo.toml`to: - ````toml + {{< multiconfig file=hugo >}} [outputFormats] [outputFormats.print] name= "print" @@ -525,7 +524,7 @@ This document shows you what's new in the latest release and flags it with one o isHTML = true mediaType = 'text/html' permalinkable = false - ```` + {{< /multiconfig >}} --- diff --git a/exampleSite/content/basics/topbar/_index.en.md b/exampleSite/content/basics/topbar/_index.en.md index f10b5bc43d..dbc342dcd1 100644 --- a/exampleSite/content/basics/topbar/_index.en.md +++ b/exampleSite/content/basics/topbar/_index.en.md @@ -49,8 +49,8 @@ The below example sets an explicit value for the `onempty` parameter, overriding ````go {{ partial "topbar/button/more.html" (dict - "page" . - "onempty" "disable" + "page" . + "onempty" "disable" )}} ```` diff --git a/exampleSite/content/cont/i18n/_index.en.md b/exampleSite/content/cont/i18n/_index.en.md index 8c4123389a..4a3b1dcbdb 100644 --- a/exampleSite/content/cont/i18n/_index.en.md +++ b/exampleSite/content/cont/i18n/_index.en.md @@ -97,6 +97,5 @@ Just set `disableLanguageSwitchingButton=true` in your `hugo.toml` {{< multiconfig file=hugo >}} [params] - # When using multilingual website, disable the switch language button. disableLanguageSwitchingButton = true {{< /multiconfig >}} diff --git a/exampleSite/content/cont/menushortcuts.en.md b/exampleSite/content/cont/menushortcuts.en.md index 92dbc1b139..ba96c6b0d5 100644 --- a/exampleSite/content/cont/menushortcuts.en.md +++ b/exampleSite/content/cont/menushortcuts.en.md @@ -145,7 +145,7 @@ If you have shortcuts to pages inside of your project and you don't want them to publishResources = true {{< /multiconfig >}} -2. Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he **parent** (see exampleSite's `content/more/_index.en.md`). _Don't give this page a `title` as this will cause it to be in the breadcrumbs - a thing you most likely don't want. +2. Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he **parent** (see exampleSite's `content/more/_index.en.md`). **Don't give this page a `title`** as this will cause it to be shown in the breadcrumbs - a thing you most likely don't want. {{< multiconfig fm=true >}} [_build] diff --git a/exampleSite/content/cont/taxonomy.en.md b/exampleSite/content/cont/taxonomy.en.md index d50aea7461..df84ae9293 100644 --- a/exampleSite/content/cont/taxonomy.en.md +++ b/exampleSite/content/cont/taxonomy.en.md @@ -43,8 +43,8 @@ url = "/categories" If you define [custom taxonomies](https://gohugo.io/content-management/taxonomies/#configure-taxonomies) and want to display a list of them somewhere on your page (often in the `layouts/partials/content-footer.html`) you can call a partial that does the job for you: -````md -{{- partial "term-list.html" (dict +````go +{{ partial "term-list.html" (dict "page" . "taxonomy" "categories" "icon" "layer-group" diff --git a/exampleSite/content/shortcodes/siteparam.en.md b/exampleSite/content/shortcodes/siteparam.en.md index e69501bf46..4837ccc605 100644 --- a/exampleSite/content/shortcodes/siteparam.en.md +++ b/exampleSite/content/shortcodes/siteparam.en.md @@ -58,15 +58,15 @@ To use formatted parameter, add this in your `hugo.toml`: {{< multiconfig file=hugo >}} [markup.goldmark.renderer] - unsafe = true + unsafe = true {{< /multiconfig >}} Now values containing Markdown will be formatted correctly. {{< multiconfig file=hugo >}} [params] - [params.siteparam.test] - text = "A **nested** parameter with formatting" + [params.siteparam.test] + text = "A **nested** parameter with formatting" {{< /multiconfig >}} ```go