From 0b9fae5d6340be1d480ec713c09da9eaa570b6a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Sat, 17 Feb 2024 12:46:23 +0100 Subject: [PATCH] docs: deprecation for menuTitle #714 --- exampleSite/content/basics/migration/_index.en.md | 2 ++ exampleSite/content/cont/frontmatter/_index.en.md | 13 +++---------- 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/exampleSite/content/basics/migration/_index.en.md b/exampleSite/content/basics/migration/_index.en.md index 098f6efa34b..8bca33eadb4 100644 --- a/exampleSite/content/basics/migration/_index.en.md +++ b/exampleSite/content/basics/migration/_index.en.md @@ -26,6 +26,8 @@ This document shows you what's new in the latest release and flags it with one o - {{% badge style="note" title=" " %}}Change{{% /badge %}} The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlightning in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as [described here](basics/branding#modify-shipped-variants). +- {{% badge style="note" title=" " %}}Change{{% /badge %}} The frontmatter option `menuTitle` is now deprecated in favor for Hugo's own `linkTitle`. You don't need to change anything as the old `menuTitle` option is still supported. + - {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} You now can configure additional options for every theme variant in your `hugo.toml`. This allows for optional [advanced functionality](basics/branding#theme-variant-advanced). You don't need to change anything as the old configuration options will still work (but may generate warnings now). The advanced functionality allows you to set an explicit name for a theme variant and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings. diff --git a/exampleSite/content/cont/frontmatter/_index.en.md b/exampleSite/content/cont/frontmatter/_index.en.md index ab0b5c165b1..87e7fb81ea7 100644 --- a/exampleSite/content/cont/frontmatter/_index.en.md +++ b/exampleSite/content/cont/frontmatter/_index.en.md @@ -78,12 +78,6 @@ editURL = "" # Menu # These options modify the menu apperance. -# The title in main menu. -# Default: -# If set, this will be used for the page's menu entry instead of the `title` -# option. -menuTitle = "" - # 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. @@ -306,17 +300,16 @@ weight = 5 ### Using a Custom Title for Menu Entries -By default, the Relearn theme will use a page's `title` attribute for the menu item (or `linkTitle` if defined). +By default, the Relearn theme will use a page's `title` attribute for the menu item. -But a page's title has to be descriptive on its own while the menu is a hierarchy. -We've added the `menuTitle` parameter for that purpose: +But a page's title has to be descriptive on its own while the menu is a hierarchy. Hugo adds the `linkTitle` parameter for that purpose: For example (for a page named `content/install/linux.md`): ````toml +++ title = "Install on Linux" -menuTitle = "Linux" +linkTitle = "Linux" +++ ````