You can do this:
- Place content in one or many menus
- Handle nested menus with unlimited depth
- Create menu entries without being attached to any content
- Distinguish active element (and active branch)
What is a Menu in Hugo?
A menu is a named array of menu entries accessible by name via the
.Site.Menus site variable. For example, you can access your site’s
main menu via
A menu entry has the following properties (i.e., variables) available to it:
Note that menus also have the following functions available as well:
Additionally, there are some relevant functions available to menus on a page:
- (menu string, menuEntry *MenuEntry ) boolean
- (menu string, menuEntry *MenuEntry) boolean
Add content to menus
Hugo allows you to add content to a menu via the content’s front matter.
If all you need to do is add an entry to a menu, the simple form works well.
A Single Menu
--- menu: "main" ---
--- menu: ["main", "footer"] ---
--- menu: docs: parent: 'extras' weight: 20 ---
Add Non-content Entries to a Menu
You can also add entries to menus that aren’t attached to a piece of content. This takes place in your Hugo project’s
Here’s an example snippet pulled from a
[[menu.main]] name = "about hugo" pre = "<i class='fa fa-heart'></i>" weight = -110 identifier = "about" url = "/about/" [[menu.main]] name = "getting started" pre = "<i class='fa fa-road'></i>" weight = -100 url = "/getting-started/"
Here’s the equivalent snippet in a
--- menu: docs: - Name: "about hugo" Pre: "<i class='fa fa-heart'></i>" Weight: -110 Identifier: "about" URL: "/about/" - Name: "getting started" Pre: "<i class='fa fa-road'></i>" Weight: -100 URL: "/getting-started/" ---
All nesting of content is done via the
The parent of an entry should be the identifier of another entry. The identifier should be unique (within a menu).
The following order is used to determine an Identifier:
.Name > .LinkTitle > .Title
This means that
.Title will be used unless
.LinkTitle is present, etc. In practice,
.Identifier are only used to structure relationships and therefore never displayed.
In this example, the top level of the menu is defined in your site
config file). All content entries are attached to one of these entries via the
See Menu Templates for information on how to render your site menus within your templates.