Why your menu won’t be served

The missing menu

The sectionPagesMenu config setting may not work as you might expect in Hugo menus. I struggled with this for quite a while, but now a long-lasting mystery has been solved, finally. Time to share this, so your struggle may be shorter, or, if you just stumbled upon the problem and immediately found this article here, even nonexistent.

You follow the instructions in the Hugo documentation (https://gohugo.io/content-management/menus/) and see that you can define a menu in the config file (config.toml).

You have the setting in your config, like so:

sectionPagesMenu = 'main'

You have some pages, written in Markdown. You may even have some directories with an index.md file inside.

In your partial template for the header (<theme>/layouts/partials/header.html), you have a code block that should show the menu. It may look similar to this:

  {{ range site.Menus.main }}
  <li><a href="{{ .URL }}">{{ .Name }}</a></li>
  {{ end }}

So you think that stuff should show up in the menu. But there is no menu.

The reason is that this only works for sections.^[1] Sections are directories that contain an _index.md file. They are also called branch bundles. Directories which contain an index.md (note the missing underscore at the beginning of the filename) file are called leaf bundles. They are not sections, so they will not appear in the menu, only branch bundles will.

Leaf bundles and branch bundles are the two forms of page bundles. More about the different kinds of bundles can be found here: https://gohugo.io/content-management/page-bundles/.

The Hugo documentation is not overly supportive here. After telling you that you can use the setting, it says:

This creates a menu structure that you can access with site.Menus.main in your
templates. See menu templates for details.

A hint that this only works with branch bundles would be nice.^[2] After all, it took me some months (which I of course not only spent solving this one problem) to find out what the problem was.

Of course I was not completely blocked by this, as there are other ways to get your menu. One way is to define the menu for a page in the front matter of your page (the stuff right at the beginning of the page), the other is to explicitly define the menu with all its entries in the config (which is what I do, because right now I’m only creating small sites with Hugo).

The menu is served, but the plate is empty

When this problem is solved, a new problem can appear.^[3] It may happen that your branch bundle appears in the menu, but when you click on the link, you only see an empty page. The reason is that your list template (which can be found in <theme>/layouts/_defaults/list.html) is empty, because you created a fresh theme with hugo new theme <themename>, but you have not yet implemented the list template.

Branch bundles are considered to be lists by Hugo, so they are processed using the list template. Putting some minimalistic code into your list.html is enough to make the branch bundle render. Something like

{{ define "main" }}
  {{ .Content }}
{{ end }}

will do for starters.

Finally, a hint: Making your menus with sectionPagesMenu only works for top-level sections. Subsections like content/livingthings/mushrooms/_index.md will not appear in the menu, whereas content/dinosaurs/_index.md will show up in the menu.

1. Here’s the official definition of a section from Hugo’s documentation: https://gohugo.io/content-management/sections/.

2. What’s even better than complaining? Making a suggestion to improve the situation. So I created a pull request: https://github.com/gohugoio/hugoDocs/pull/2440.

3. Ah, isn’t that the essence of IT that we all love so much?

Other articles

Tracing a sketch for a t-shirt in Inkscape

Published: Mo 12 Februar 2024
By Nik

In IT.

tags: inkscape t-shirt english

Tracing a sketch for a t-shirt in Inkscape

Or for other purposes. The following assumes that you have a pencil sketch or so and want to make a t-shirt-able SVG from it. After some amount of probing, the following path^[1] seems to be the most promising for me:

Import …
read more
Static binaries in Python

Published: Mo 08 Januar 2024
By Nik

In IT.

tags: python static haskell rust go hugo english

Static binaries in Python

Do you envy developers that use Go, Rust or Haskell for their static binaries? Just one file that can be passed around, like the binary of the static^[1] website generator Hugo, written in Go?

No need to install libraries (of course you need to install …
read more
Face Improvement

Published: Mo 11 Dezember 2023
By Nik

In Notizen.

tags: geschichte wirtschaft überwachung sicherheit

Mit dem Prospekt hatte alles angefangen. Edel aufgemacht, aber erkennbar eine Massensendung. Wie wichtig heutzutage das Aussehen sei. Ein perfektes Gesicht die Eintrittskarte in ein erfolgreiches Berufs- und Privatleben. Erfolg. Schönheit. Und da ließe sich heute so viel machen. Jedes Gesicht sei verbesserbar. Zu günstigen Preisen. Wer da nicht mitmache …
read more
Java package does not match path
Published: Di 22 August 2023
By Nik

In IT.

tags: java english maven netbeans eclipse
Java package does not match path
Say we have a Java source file with the following package definition at the beginning:

package evil.weylandyutani.xenomorph;

, but the file lives in the following directory: …/evil/weylandyutani/xenomorph/alien. So, the path to the file does not correspond to the package components …
read more
The Random Walker and the PI Searcher

Published: Mi 21 Juni 2023
By Nik

In IT.

tags: arduino c cplusplus english

Why?

A while ago I started researching^[1] microcontrollers, using mainly Arduinos and the STM32 Nucleo boards.

So, naturally, I have a bunch of Arduino Pro Minis lying around. Originally, they were meant for a measuring device that records …
read more
Compare output in shell

Published: So 18 Juni 2023
By Nik

In IT.

tags: shell testing tap git english

Compare output in shell

We need to compare output when we want to test command line programs. There are tools for this like Bats^[1], Cram^[2] or Aruba^[3], but you can also roll your own. All that you need is to check if output of programs is what …
read more
Benzin

Published: Do 09 März 2023
By Nik

In Notizen.

tags: geschichten sciencefiction

Joe Smith fuhr mit seinem Traktor den staubigen Feldweg entlang. Zwei Uhr nachmittags in Kentucky. Die Sonne brannte herunter. Weidezäune verlegen war heute angesagt. Nicht seine Lieblingsarbeit, aber es musste ja auch getan werden. Und es war seine Farm. Seit dem Tod seiner Frau Sarah war er allein, wer also …
read more
Should I quote the name argument to find?

Published: Di 07 März 2023
By Nik

In IT.

tags: shell find commandline linux english

Should I quote the name argument to find?

To formulate a bit more explicitely: Should I quote the argument of the name option^[1] of the Unix find command? Can anything bad happen if I don’t quote? Or can I save the extra finger wear caused by typing (unnecessary …
read more
Straftatbestand Datensabotage

Published: Mi 22 Februar 2023
By Nik

In Notizen.

tags: geschichten it ki ai bigdata

"Das Gericht ist vollständig versammelt. Die Sitzung ist hiermit eröffnet."

Der Richter warf einen kurzen Blick auf sein JusticePad. Diese Tablets wurden der Justiz von der Firma JusticeHero zur Verfügung gestellt. Alle Abläufe der Justiz waren von dieser Firma übernommen worden, nur die hoheitlichen Handlungen, wie etwa Urteilsverkündungen, wurden noch …
read more

Other articles

Tracing a sketch for a t-shirt in Inkscape

Static binaries in Python

Java package does not match path

Why?

Compare output in shell

Should I quote the name argument to find?

links

social