Bjørn Erik Pedersen
0c2fa2460f
80dd7b067 theme: Fix border class in render-codeblock template 0d3fde6c9 content: Fix typo 23a4adb29 content: More site => project changes 9243e9f6b content: Rename site configuration to project configuration (phase 2) 330aa2249 content: Miscellaneous edits 25ce893be content: Clarify sort order with PAGE.Rotate b398506dc content: Various dimension improvements c54573d13 content: Use singular form in method section descriptions d9a95fe54 content: Improve description of PAGE.Rotate 154f30600 content: Fix link c71bd2776 content: Address Markdown linting error 72c88e68e content: Improve pages related to content dimensions b85afa645 content: Fix formatting 7aaca8947 content: More site-to-project changes 8e1579030 content: Update quick start guide f7ba1fde2 content: Make new-in into a note 8b9d51584 theme: Address TailwindCSS warnings 3a4c2a25c theme: Address Hugo v0.156.0 deprecations 4f1a2bd7b content: Improve glossary entries 21bcd23a6 content: Update glossary entry c72ef1116 content: Update quick start guide c0737ffab content: Add typography plugin to TailwindCSS example 80bcb868e content: Remove Site.AllPages from examples 2b9ba5831 content: Replace Page.Sites and Site.Sites with hugo.Sites 2cdcc2556 content: Remove outdated badges 5a4beb530 content: Replace Site.Data with hugo.Data de4651b5d content: Update glossary entry 2302825a7 content: Add hugo.Data and note other deprecations bac5da4b5 content: Add hugo.Sites and update the other Sites methods 0f7d99153 content: Add Site.IsDefault f888f33bb content: Update glossary entries 65311c2de content: Include the "build" subcommand where appropriate 4991320d2 content: Standard shell language code in info strings b16d9f162 theme: Style todo lists f121450c6 content: Update version references 5a81dd8c2 content: Update CLI documentation f3ae0ce86 content: Rename site configuration to project configuration (phase 1) 9c8327119 content: Miscellaneous edits fbff91e22 Update HUGO_VERSION to 0.156.0 2ec625ae8 content: Restore snap installation instructions fc8c246b8 content: Clarify module initialization git-subtree-dir: docs git-subtree-split: 80dd7b067c31c28b13c51f3ac4636890509a4bb7
2.7 KiB
title, description, categories, keywords, aliases
| title | description | categories | keywords | aliases | |
|---|---|---|---|---|---|
| Menus | Create menus by defining entries, localizing each entry, and rendering the resulting data structure. |
|
Overview
To create a menu for your site:
Create multiple menus, either flat or nested. For example, create a main menu for the header, and a separate menu for the footer.
There are three ways to define menu entries:
- Automatically
- In front matter
- In your project configuration
Note
Although you can use these methods in combination when defining a menu, the menu will be easier to conceptualize and maintain if you use one method throughout the site.
Define automatically
To automatically define a menu entry for each top-level section of your site, enable the section pages menu in your project configuration.
{{< code-toggle file=hugo >}} sectionPagesMenu = "main" {{< /code-toggle >}}
This creates a menu structure that you can access with site.Menus.main in your templates. See menu templates for details.
Define in front matter
To add a page to the "main" menu:
{{< code-toggle file=content/about.md fm=true >}} title = 'About' menus = 'main' {{< /code-toggle >}}
Access the entry with site.Menus.main in your templates. See menu templates for details.
To add a page to the "main" and "footer" menus:
{{< code-toggle file=content/contact.md fm=true >}} title = 'Contact' menus = ['main','footer'] {{< /code-toggle >}}
Access the entry with site.Menus.main and site.Menus.footer in your templates. See menu templates for details.
Note
The configuration key in the examples above is
menus. Themenu(singular) configuration key is an alias formenus.
Properties
Use these properties when defining menu entries in front matter:
{{% include "/_common/menu-entry-properties.md" %}}
Example
This front matter menu entry demonstrates some of the available properties:
{{< code-toggle file=content/products/software.md fm=true >}} title = 'Software' [menus.main] parent = 'Products' weight = 20 pre = '' [menus.main.params] class = 'center' {{< /code-toggle >}}
Access the entry with site.Menus.main in your templates. See menu templates for details.
Define in project configuration
See configure menus.
Localize
Hugo provides two methods to localize your menu entries. See multilingual.
Render
See menu templates.