文档章节

Menu 方法

在遍历菜单条目时使用这些方法:排序、反转、限量。

难度
参考
预计用时
10 分钟

开始之前,你需要

  • 知道菜单条目从哪里来:项目配置里的 [[menus.…]]、页面前置元数据里的 menus,或页面自动加入菜单;不熟先看菜单。
  • 会写最简的菜单循环:{{ range site.Menus.main }};写法见菜单模板。

读完之后你能

  • 分清菜单(site.Menus.main,类型 navigation.Menu)与菜单条目(循环里的 .,类型 navigation.MenuEntry);
  • 按名字排序用 ByName,按 weight 排序用 ByWeight(这正是菜单的默认顺序),倒序用 Reverse,只取前 N 个用 Limit;
  • 把方法链起来:site.Menus.main.ByName.Reverse.Limit 3 读作「按名字排 → 倒过来 → 取前 3 个」;
  • 知道条目自身的属性(.Name、.URL、.Children…)在 Menu entry 方法 一章。

接着读:Menu entry · 菜单 · 菜单模板

本章导读

菜单(menu)是「一组导航条目」的容器:项目配置里的 [[menus.main]]、页面前置元数据里的 menus、以及 Hugo 为页面自动生成的条目,最终都会汇进 site.Menus.<菜单名>。

这一章收录的是作用在整个菜单上的四个方法。它们都返回 navigation.Menu,所以可以链式串联:

方法 作用
ByName 按条目的 name 排序(大小写不敏感)
ByWeight 按 weight 升序,再按 name、identifier;这是菜单的默认顺序
Reverse 反转当前顺序
Limit 只保留前 N 个条目

链式调用从左到右执行。site.Menus.main.ByName.Reverse.Limit 3 的含义是:取出 main 菜单 → 按名字排序 → 倒过来 → 留前三个。

阅读顺序

  1. 先读 ByWeight,理解菜单的默认顺序(以及为什么「没写 weight 的条目排在最后」);
  2. 再读 ByName,按显示名字重排;
  3. 最后用 Reverse 与 Limit 微调输出。

条目自身的属性(Name、URL、Children…)见 Menu entry 方法;菜单条目怎么写、怎么自动生成,见菜单与菜单模板。

本章内容

  • ByName 返回给定菜单,其条目按 name 排序。 (今天)
  • ByWeight 返回给定菜单,其条目先按 weight、再按 name、最后按 identifier 排序。 (今天)
  • Limit 返回给定菜单,并限制为前 N 个条目。 (今天)
  • Reverse 返回给定菜单,并反转其条目的排序顺序。 (今天)