HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
CONTENT MANAGEMENT

章节

将内容组织成章节。

概述

一个 section(章节)是一个顶级内容目录,或者任何包含 _index.md 文件的内容目录。包含 _index.md 文件的内容目录也被称为 分支包 。章节模板接收一个或多个页面 集合 作为 上下文 。

尽管没有 _index.md 文件的顶级目录也是章节,但我们建议在 所有 章节中创建 _index.md 文件。

一个典型的站点由一个或多个章节组成。例如:

content/
├── articles/             <-- 章节 (顶级目录)
│   ├── 2022/
│   │   ├── article-1/
│   │   │   ├── cover.jpg
│   │   │   └── index.md
│   │   └── article-2.md
│   └── 2023/
│       ├── article-3.md
│       └── article-4.md
├── products/             <-- 章节 (顶级目录)
│   ├── product-1/        <-- 章节 (包含 _index.md 文件)
│   │   ├── benefits/     <-- 章节 (包含 _index.md 文件)
│   │   │   ├── _index.md
│   │   │   ├── benefit-1.md
│   │   │   └── benefit-2.md
│   │   ├── features/     <-- 章节 (包含 _index.md 文件)
│   │   │   ├── _index.md
│   │   │   ├── feature-1.md
│   │   │   └── feature-2.md
│   │   └── _index.md
│   └── product-2/        <-- 章节 (包含 _index.md 文件)
│       ├── benefits/     <-- 章节 (包含 _index.md 文件)
│       │   ├── _index.md
│       │   ├── benefit-1.md
│       │   └── benefit-2.md
│       ├── features/     <-- 章节 (包含 _index.md 文件)
│       │   ├── _index.md
│       │   ├── feature-1.md
│       │   └── feature-2.md
│       └── _index.md
├── _index.md
└── about.md

上面的例子有两个顶级章节:articles 和 products。articles 下面的目录都不是章节,而 products 下面的所有目录都是章节。章节内的章节称为嵌套章节或子章节。

解释

章节和非章节的行为不同。

章节 非章节
目录名称成为 URL 段 ✔️ ✔️
具有逻辑祖先和后代 ✔️ ❌
具有列表页面 ✔️ ❌

使用 上面的例子 中的文件结构:

  1. articles 章节的列表页面包含所有文章,无论目录结构如何;没有子目录是章节。

  2. articles/2022 和 articles/2023 目录没有列表页面;它们不是章节。

  3. products 章节的列表页面默认包含 product-1 和 product-2,但不包含它们的后代页面。要包含后代页面,请在列表模板中使用 RegularPagesRecursive 方法而不是 Pages 方法。

  1. products 章节中的所有目录都有列表页面;每个目录都是一个章节。

模板选择

Hugo 有一个定义好的 查找顺序 来确定渲染页面时使用哪个模板。 查找规则 考虑顶级章节名称;在选择模板时不考虑子章节名称。

使用 上面的例子 中的文件结构:

内容目录 章节模板
content/products layouts/products/list.html
content/products/product-1 layouts/products/list.html
content/products/product-1/benefits layouts/products/list.html
内容目录 单个模板
content/products layouts/products/single.html
content/products/product-1 layouts/products/single.html
content/products/product-1/benefits layouts/products/single.html

如果您需要为子章节使用不同的模板,请在 front matter 中指定 type 和/或 layout 。

祖先和后代

一个章节有一个或多个祖先(包括主页),以及零个或多个后代。使用 上面的例子 中的文件结构:

content/products/product-1/benefits/benefit-1.md

内容文件 (benefit-1.md) 有四个祖先:benefits、product-1、products 和主页。这种逻辑关系允许我们使用 .Parent 和 .Ancestors 方法来遍历站点结构。

例如,使用 .Ancestors 方法来渲染面包屑导航。

layouts/partials/breadcrumb.html
<nav aria-label="breadcrumb" class="breadcrumb">
  <ol>
    {{ range .Ancestors.Reverse }}
      <li>
        <a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a>
      </li>
    {{ end }}
    <li class="active">
      <a aria-current="page" href="{{ .RelPermalink }}">{{ .LinkTitle }}</a>
    </li>
  </ol>
</nav>

使用此 CSS:

.breadcrumb ol {
  padding-left: 0;
}

.breadcrumb li {
  display: inline;
}

.breadcrumb li:not(:last-child)::after {
  content: "»";
}

Hugo 渲染这个,其中每个面包屑都是指向相应页面的链接:

主页 » 产品 » 产品 1 » 优点 » 优点 1

See also

  • 内容类型
  • 组织
  • 评论
  • Front matter (前置 matter)
  • 数学公式

On this page

  • 概述
  • 解释
  • 模板选择
  • 祖先和后代
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 快速上手
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • Hugo 模块
  • Hugo 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护