83bef6955e
e161ea09d Add one more Chinese file to workaround reflect: Zero(nil) b595b3a21 Add more Chinese translation 56e4e95d9 Use lang.Merge to "fill in the gaps" for untranslated pages ef079406c Merge commit '650fac3a4e7d256f4505402ab44cfc3c804b8dea' 650fac3a4 Squashed 'themes/gohugoioTheme/' changes from a1768ebb..f31a3dc8 322eff899 Add Chinese language for menus d90b886e0 Fix Markdown table syntax in previous commit 737f3dfca Update the leaf bundle vs branch bundle table 09fa1bc4e Clarify that `.Now` is obsolete 879ea3f6a Make release notes somewhat more consistent 0113e2051 Move 0.40.2-relnotes into content/en/news 77578f5bf Move content/ into new contentDir content/en/ 4dcf7c709 Fix "reflect: Zero(nil)" error in showcase 63dd25505 Release 0.40.2 2076c0d56 releaser: Prepare repository for 0.41-DEV 070fe565e releaser: Add release notes to /docs for release of 0.40.2 4ce52e913 releaser: Bump versions for release of 0.40.2 41907c487 Fix typos in syntax-highlighting.md 91753ef3d Add missing backtick b77274301 Remove duplicate release notes (0.27, 0.27.1, 0.35) 6e00da316 Remove obsolete content/release-notes/ directory 00a6d8c02 Change en dash back to `--` in 0.38.2-relnotes 51b32dc00 Update archetypes.md d0e5c2307 Release 0.40.1 4538a6d5b releaser: Prepare repository for 0.41-DEV 91b391d70 releaser: Add release notes to /docs for release of 0.40.1 e0979d143 releaser: Bump versions for release of 0.40.1 7983967c2 Clean images fe3fdd77d Polish showcase for Flesland Flis e6dde3989 Showcase - Flesland Flis AS by Absoluttweb 73aa62290 Revive @spf13's special Hugo font add67b335 Release Hugo 0.40 c0a26e5a6 Merge branch 'temp40' beeabaaae releaser: Prepare repository for 0.41-DEV e67d5e985 releaser: Add release notes to /docs for release of 0.40 6cdd95273 releaser: Bump versions for release of 0.40 bee21fb9b Revive the other Hugo logos too 4f45e8fe1 Fix the link type attribute for RSS in examples 8c67dc89a Fix example in delimit doc e7f6c00d5 Revive the logo used on the forum 82b0cd26e Merge commit 'a215abf70e018f4bf40d6c09d8bd148d8684b33d' 119c8ca58 Merge commit 'd2ec1a06df8ab6b17ad05cb008d5701b40327d47' db4683bd2 Improve .Get docs 05260b886 .Get function: fix syntax signature git-subtree-dir: docs git-subtree-split: e161ea09d33e3199f4998e4d2e9068d5a850f042
3.9 KiB
| title | linktitle | description | date | publishdate | lastmod | categories | keywords | draft | menu | weight | aliases | toc | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Menus | Menus | Hugo has a simple yet powerful menu system. | 2017-02-01 | 2017-02-01 | 2017-03-31 |
|
|
false |
|
120 |
|
true |
{{% note "Lazy Blogger"%}} If all you want is a simple menu for your sections, see the "Section Menu for Lazy Bloggers" in Menu Templates. {{% /note %}}
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 .Site.Menus.main.
{{% note "Menus on Multilingual Sites" %}} If you make use of the multilingual feature, you can define language-independent menus. {{% /note %}}
A menu entry has the following properties (i.e., variables) available to it:
.URL- string
.Name- string
.Menu- string
.Identifier- string
.Pre- template.HTML
.Post- template.HTML
.Weight- int
.Parent- string
.Children- Menu
Note that menus also have the following functions available as well:
.HasChildren- boolean
Additionally, there are some relevant functions available to menus on a page:
.IsMenuCurrent- (menu string, menuEntry *MenuEntry ) boolean
.HasMenuCurrent- (menu string, menuEntry *MenuEntry) boolean
Add content to menus
Hugo allows you to add content to a menu via the content's front matter.
Simple
If all you need to do is add an entry to a menu, the simple form works well.
A Single Menu
---
menu: "main"
---
Multiple Menus
---
menu: ["main", "footer"]
---
Advanced
---
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 config file.
Here’s an example snippet pulled from a configuration file:
{{< code-toggle file="config.toml" >}} menu.main name = "about hugo" pre = "" weight = -110 identifier = "about" url = "/about/" menu.main name = "getting started" pre = "" weight = -100 url = "/getting-started/" {{< /code-toggle >}}
{{% note %}}
The URLs must be relative to the context root. If the baseURL is https://example.com/mysite/, then the URLs in the menu must not include the context root mysite. Using an absolute URL will override the baseURL. If the value used for URL in the above example is https://subdomain.example.com/, the output will be https://subdomain.example.com.
{{% /note %}}
Nesting
All nesting of content is done via the parent field.
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, .Name and .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 .Parent field.
Render Menus
See Menu Templates for information on how to render your site menus within your templates.