Shortcut Menu
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
Option By default, the shortcut menu has a title ("More" in English).
You can disable this title with disableShortcutsTitle=true
.
[params]
disableShortcutsTitle = true
params:
disableShortcutsTitle: true
{
"params": {
"disableShortcutsTitle": true
}
}
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:
[menu]
[[menu.shortcuts]]
identifier = 'ds'
name = '<i class="fa-fw fab fa-github"></i> GitHub Repo'
url = 'https://github.com/McShelby/hugo-theme-relearn'
weight = 10
[[menu.shortcuts]]
name = '<i class="fa-fw fas fa-camera"></i> Showcases'
pageRef = '/showcase'
weight = 11
[[menu.shortcuts]]
identifier = 'hugodoc'
name = '<i class="fa-fw fas fa-bookmark"></i> Hugo Documentation'
url = 'https://gohugo.io/'
weight = 20
[[menu.shortcuts]]
name = '<i class="fa-fw fas fa-bullhorn"></i> Credits'
pageRef = '/more/credits'
weight = 30
[[menu.shortcuts]]
name = '<i class="fa-fw fas fa-tags"></i> Tags'
pageRef = '/tags'
weight = 40
menu:
shortcuts:
- identifier: ds
name: <i class="fa-fw fab fa-github"></i> GitHub Repo
url: https://github.com/McShelby/hugo-theme-relearn
weight: 10
- name: <i class="fa-fw fas fa-camera"></i> Showcases
pageRef: /showcase
weight: 11
- identifier: hugodoc
name: <i class="fa-fw fas fa-bookmark"></i> Hugo Documentation
url: https://gohugo.io/
weight: 20
- name: <i class="fa-fw fas fa-bullhorn"></i> Credits
pageRef: /more/credits
weight: 30
- name: <i class="fa-fw fas fa-tags"></i> Tags
pageRef: /tags
weight: 40
{
"menu": {
"shortcuts": [
{
"identifier": "ds",
"name": "\u003ci class=\"fa-fw fab fa-github\"\u003e\u003c/i\u003e GitHub Repo",
"url": "https://github.com/McShelby/hugo-theme-relearn",
"weight": 10
},
{
"name": "\u003ci class=\"fa-fw fas fa-camera\"\u003e\u003c/i\u003e Showcases",
"pageRef": "/showcase",
"weight": 11
},
{
"identifier": "hugodoc",
"name": "\u003ci class=\"fa-fw fas fa-bookmark\"\u003e\u003c/i\u003e Hugo Documentation",
"url": "https://gohugo.io/",
"weight": 20
},
{
"name": "\u003ci class=\"fa-fw fas fa-bullhorn\"\u003e\u003c/i\u003e Credits",
"pageRef": "/more/credits",
"weight": 30
},
{
"name": "\u003ci class=\"fa-fw fas fa-tags\"\u003e\u003c/i\u003e Tags",
"pageRef": "/tags",
"weight": 40
}
]
}
}
Multilingual Example
For multilingual sites, set different menus for each language in hugo.toml
:
[languages]
[languages.en]
languageName = 'English'
title = 'Hugo Relearn Theme'
weight = 1
[languages.en.menu]
[[languages.en.menu.shortcuts]]
identifier = 'ds'
name = '<i class="fa-fw fab fa-github"></i> GitHub Repo'
url = 'https://github.com/McShelby/hugo-theme-relearn'
weight = 10
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fas fa-camera"></i> Showcases'
pageRef = '/showcase'
weight = 11
[[languages.en.menu.shortcuts]]
identifier = 'hugodoc'
name = '<i class="fa-fw fas fa-bookmark"></i> Hugo Documentation'
url = 'https://gohugo.io/'
weight = 20
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fas fa-bullhorn"></i> Credits'
pageRef = '/more/credits'
weight = 30
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fas fa-tags"></i> Tags'
pageRef = '/tags'
weight = 40
[languages.pir]
languageName = 'Arrr! Pirrratish'
title = 'Captain Hugo Relearrrn Theme'
weight = 2
[languages.pir.menu]
[[languages.pir.menu.shortcuts]]
identifier = 'ds'
name = '<i class="fa-fw fab fa-github"></i> GitHub Repo'
url = 'https://github.com/McShelby/hugo-theme-relearn'
weight = 10
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fas fa-camera"></i> Showcases'
pageRef = '/showcase'
weight = 11
[[languages.pir.menu.shortcuts]]
identifier = 'hugodoc'
name = '<i class="fa-fw fas fa-bookmark"></i> Captain Hugo Documentation'
url = 'https://gohugo.io/'
weight = 20
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fas fa-bullhorn"></i> Crrredits'
pageRef = '/more/credits'
weight = 30
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fas fa-tags"></i> Arrr! Tags'
pageRef = '/tags'
weight = 40
languages:
en:
languageName: English
menu:
shortcuts:
- identifier: ds
name: <i class="fa-fw fab fa-github"></i> GitHub Repo
url: https://github.com/McShelby/hugo-theme-relearn
weight: 10
- name: <i class="fa-fw fas fa-camera"></i> Showcases
pageRef: /showcase
weight: 11
- identifier: hugodoc
name: <i class="fa-fw fas fa-bookmark"></i> Hugo Documentation
url: https://gohugo.io/
weight: 20
- name: <i class="fa-fw fas fa-bullhorn"></i> Credits
pageRef: /more/credits
weight: 30
- name: <i class="fa-fw fas fa-tags"></i> Tags
pageRef: /tags
weight: 40
title: Hugo Relearn Theme
weight: 1
pir:
languageName: Arrr! Pirrratish
menu:
shortcuts:
- identifier: ds
name: <i class="fa-fw fab fa-github"></i> GitHub Repo
url: https://github.com/McShelby/hugo-theme-relearn
weight: 10
- name: <i class="fa-fw fas fa-camera"></i> Showcases
pageRef: /showcase
weight: 11
- identifier: hugodoc
name: <i class="fa-fw fas fa-bookmark"></i> Captain Hugo Documentation
url: https://gohugo.io/
weight: 20
- name: <i class="fa-fw fas fa-bullhorn"></i> Crrredits
pageRef: /more/credits
weight: 30
- name: <i class="fa-fw fas fa-tags"></i> Arrr! Tags
pageRef: /tags
weight: 40
title: Captain Hugo Relearrrn Theme
weight: 2
{
"languages": {
"en": {
"languageName": "English",
"menu": {
"shortcuts": [
{
"identifier": "ds",
"name": "\u003ci class=\"fa-fw fab fa-github\"\u003e\u003c/i\u003e GitHub Repo",
"url": "https://github.com/McShelby/hugo-theme-relearn",
"weight": 10
},
{
"name": "\u003ci class=\"fa-fw fas fa-camera\"\u003e\u003c/i\u003e Showcases",
"pageRef": "/showcase",
"weight": 11
},
{
"identifier": "hugodoc",
"name": "\u003ci class=\"fa-fw fas fa-bookmark\"\u003e\u003c/i\u003e Hugo Documentation",
"url": "https://gohugo.io/",
"weight": 20
},
{
"name": "\u003ci class=\"fa-fw fas fa-bullhorn\"\u003e\u003c/i\u003e Credits",
"pageRef": "/more/credits",
"weight": 30
},
{
"name": "\u003ci class=\"fa-fw fas fa-tags\"\u003e\u003c/i\u003e Tags",
"pageRef": "/tags",
"weight": 40
}
]
},
"title": "Hugo Relearn Theme",
"weight": 1
},
"pir": {
"languageName": "Arrr! Pirrratish",
"menu": {
"shortcuts": [
{
"identifier": "ds",
"name": "\u003ci class=\"fa-fw fab fa-github\"\u003e\u003c/i\u003e GitHub Repo",
"url": "https://github.com/McShelby/hugo-theme-relearn",
"weight": 10
},
{
"name": "\u003ci class=\"fa-fw fas fa-camera\"\u003e\u003c/i\u003e Showcases",
"pageRef": "/showcase",
"weight": 11
},
{
"identifier": "hugodoc",
"name": "\u003ci class=\"fa-fw fas fa-bookmark\"\u003e\u003c/i\u003e Captain Hugo Documentation",
"url": "https://gohugo.io/",
"weight": 20
},
{
"name": "\u003ci class=\"fa-fw fas fa-bullhorn\"\u003e\u003c/i\u003e Crrredits",
"pageRef": "/more/credits",
"weight": 30
},
{
"name": "\u003ci class=\"fa-fw fas fa-tags\"\u003e\u003c/i\u003e Arrr! Tags",
"pageRef": "/tags",
"weight": 40
}
]
},
"title": "Captain Hugo Relearrrn Theme",
"weight": 2
}
}
}
Displaying Pages Only in the Shortcuts Menu
To show pages only in the shortcuts menu you have two choices
-
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.content/showcase/_index.en.md+++ title = 'Showcase' [_build] list = 'never' publishResources = true render = 'always' +++
--- _build: list: never publishResources: true render: always title: Showcase ---
{ "_build": { "list": "never", "publishResources": true, "render": "always" }, "title": "Showcase" }
-
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.
content/more/_index.en.md+++ [_build] list = 'never' publishResources = false render = 'never' +++
--- _build: list: never publishResources: false render: never ---
{ "_build": { "list": "never", "publishResources": false, "render": "never" } }
The child page can be any type of content.
content/more/credits_index.en.md+++ title = 'Credits' +++
--- title: Credits ---
{ "title": "Credits" }