hugo-theme-relearn/exampleSite/content/configuration/sidebar/shortcutmenu/_index.en.md
2024-10-12 19:28:32 +02:00

4.6 KiB

+++ categories = ["howto"] description = "Add additional shortcut links to the sidebar" options = ["disableShortcutsTitle"] title = "Shortcut Menu" weight = 4 +++

The sidebar contains your content's navigation menu, but you can also add extra menu entries or shortcuts in a separate section.

For internal links, use the pageRef property instead of url. Learn more about Hugo's menu configuration.

Title

{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} By default, the shortcut menu has a title ("More" in English).

You can disable this title with disableShortcutsTitle=true.

{{< multiconfig file=hugo >}} [params] disableShortcutsTitle = true {{< /multiconfig >}}

To change the title, update your local i18n translation file.

[Shortcuts-Title]
other = "Other Great Stuff"

Single Language Example

Edit hugo.toml and add [[menu.shortcuts]] entries for each link:

{{< multiconfig file=hugo >}} menu.shortcuts name = ' GitHub Repo' identifier = 'ds' url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10

menu.shortcuts name = ' Showcases' pageRef = '/showcase' weight = 11

menu.shortcuts name = ' Hugo Documentation' identifier = 'hugodoc' url = 'https://gohugo.io/' weight = 20

menu.shortcuts name = ' Credits' pageRef = '/more/credits' weight = 30

menu.shortcuts name = ' Tags' pageRef = '/tags' weight = 40 {{< /multiconfig >}}

Multilingual Example

For multilingual sites, set different menus for each language in hugo.toml:

{{< multiconfig file=hugo >}} [languages] [languages.en] title = 'Hugo Relearn Theme' weight = 1 languageName = 'English'

languages.en.menu.shortcuts name = ' GitHub Repo' identifier = 'ds' url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10

languages.en.menu.shortcuts name = ' Showcases' pageRef = '/showcase' weight = 11

languages.en.menu.shortcuts name = ' Hugo Documentation' identifier = 'hugodoc' url = 'https://gohugo.io/' weight = 20

languages.en.menu.shortcuts name = ' Credits' pageRef = '/more/credits' weight = 30

languages.en.menu.shortcuts name = ' Tags' pageRef = '/tags' weight = 40

[languages.pir] title = 'Captain Hugo Relearrrn Theme' weight = 2 languageName = 'Arrr! Pirrratish'

languages.pir.menu.shortcuts name = ' GitHub Repo' identifier = 'ds' url = 'https://github.com/McShelby/hugo-theme-relearn' weight = 10

languages.pir.menu.shortcuts name = ' Showcases' pageRef = '/showcase' weight = 11

languages.pir.menu.shortcuts name = ' Captain Hugo Documentation' identifier = 'hugodoc' url = 'https://gohugo.io/' weight = 20

languages.pir.menu.shortcuts name = ' Crrredits' pageRef = '/more/credits' weight = 30

languages.pir.menu.shortcuts name = ' Arrr! Tags' pageRef = '/tags' weight = 40 {{< /multiconfig >}}

Displaying Pages Only in the Shortcuts Menu

To show pages only in the shortcuts menu you have two choices

  1. Create a headless branch bundle, _index.md in its own folder with the below front matter. The branch bundle will not be contained in the sitemap.

    {{< multiconfig fm=true file="content/showcase/_index.en.md" >}} title = 'Showcase' [_build] render = 'always' list = 'never' publishResources = true {{< /multiconfig >}}

  2. Or, put a child page inside a headless branch bundle with the following front matter in the bundle. This causes the child but not the branch bundle to be contained in the sitemap.

    {{< multiconfig fm=true file="content/more/_index.en.md" >}} [_build] render = 'never' list = 'never' publishResources = false {{< /multiconfig >}}

    The child page can be any type of content.

    {{< multiconfig fm=true file="content/more/credits_index.en.md" >}} title = 'Credits' {{< /multiconfig >}}