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 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
TEMPLATES

模板类型

创建不同类型的模板来渲染您的内容、资源和数据。

网站结构图

结构

在项目根目录下的 layouts 目录中创建模板。

尽管您的站点可能不需要所有这些模板,但下面的示例对于中等复杂度的站点来说是典型的。

layouts/
├── _default/
│   ├── _markup/
│   │   ├── render-image.html   <-- 渲染钩子
│   │   └── render-link.html    <-- 渲染钩子
│   ├── baseof.html
│   ├── home.html
│   ├── section.html
│   ├── single.html
│   ├── taxonomy.html
│   └── term.html
├── articles/
│   └── card.html               <-- 内容视图
├── partials/
│   ├── footer.html
│   └── header.html
└── shortcodes/
    ├── audio.html
    └── video.html

Hugo 的 模板查找顺序 决定了模板路径,允许您为任何页面创建唯一的模板。

创建模板时,您必须彻底了解 模板查找顺序 。模板选择基于模板类型、页面种类、内容类型、章节、语言和输出格式。

下面描述每种模板类型的用途。

基础模板

基础模板通过在 shell 内包装其他模板来减少重复代码。

例如,下面的基础模板调用 局部模板 函数包含每个页面的 head 、 header 和 footer 元素的局部模板,并使用 block 函数在每个页面的 main 元素内包含 home 、 single 、 section 、 taxonomy 和 term 模板。

layouts/_default/baseof.html
<!DOCTYPE html>
<html lang="{{ or site.Language.LanguageCode }}" dir="{{ or site.Language.LanguageDirection `ltr` }}">
<head>
  {{ partial "head.html" . }}
</head>
<body>
  <header>
    {{ partial "header.html" . }}
  </header>
  <main>
    {{ block "main" . }}{{ end }}
  </main>
  <footer>
    {{ partial "footer.html" . }}
  </footer>
</body>
</html>

了解更多关于 基础模板 的信息。

首页模板

首页模板渲染您站点的首页。对于单页站点,这是唯一必需的模板。

例如,下面的首页模板从基础模板继承站点的 shell,并使用页面列表渲染首页内容。

layouts/_default/home.html
{{ define "main" }}
  {{ .Content }}
  {{ range site.RegularPages }}
    <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ end }}
{{ end }}

页面集合快速参考指南 描述了过滤、排序和分组页面集合的方法和函数。

了解更多关于 首页模板 的信息。

单页模板

单页模板渲染单个页面。

例如,下面的单页模板从基础模板继承站点的 shell,并渲染每个页面的标题和内容。

layouts/_default/single.html
{{ define "main" }}
  <h1>{{ .Title }}</h1>
  {{ .Content }}
{{ end }}

了解更多关于 单页模板 的信息。

章节模板

章节模板通常渲染章节内的页面列表。

例如,下面的章节模板从基础模板继承站点的 shell,并渲染当前章节中的页面列表。

layouts/_default/section.html
{{ define "main" }}
  <h1>{{ .Title }}</h1>
  {{ .Content }}
  {{ range .Pages }}
    <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ end }}
{{ end }}

页面集合快速参考指南 描述了过滤、排序和分组页面集合的方法和函数。

了解更多关于 章节模板 的信息。

分类模板

分类模板渲染 分类 中的术语列表。

例如,下面的分类模板从基础模板继承站点的 shell,并渲染当前分类中的术语列表。

layouts/_default/taxonomy.html
{{ define "main" }}
  <h1>{{ .Title }}</h1>
  {{ .Content }}
  {{ range .Pages }}
    <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ end }}
{{ end }}

页面集合快速参考指南 描述了过滤、排序和分组页面集合的方法和函数。

了解更多关于 分类模板 的信息。

术语模板

术语模板渲染与 术语 关联的页面列表。

例如,下面的术语模板从基础模板继承站点的 shell,并渲染与当前术语关联的页面列表。

layouts/_default/term.html
{{ define "main" }}
  <h1>{{ .Title }}</h1>
  {{ .Content }}
  {{ range .Pages }}
    <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ end }}
{{ end }}

页面集合快速参考指南 描述了过滤、排序和分组页面集合的方法和函数。

了解更多关于 术语模板 的信息。

局部模板

局部模板通常用于渲染站点的组件,但您也可以创建返回值的局部模板。

与其他模板类型不同,您不能创建局部模板来定位特定页面种类、内容类型、章节、语言或输出格式。局部模板不遵循 Hugo 的 模板查找顺序 。

例如,下面的局部模板渲染版权信息。

layouts/partials/footer.html
<p>Copyright {{ now.Year }}. All rights reserved.</p>

了解更多关于 局部模板 的信息。

内容视图

内容视图模板类似于局部模板,通过调用 Page 对象上的 Render 方法来调用。与局部模板不同,内容视图模板:

  • 自动继承当前页面的上下文
  • 遵循查找顺序,允许您定位给定的内容类型或章节

例如,下面的首页模板从基础模板继承站点的 shell,并为站点“articles”章节中的每个页面渲染一个卡片组件。

layouts/_default/home.html
{{ define "main" }}
  {{ .Content }}
  <ul>
    {{ range where site.RegularPages "Section" "articles" }}
      {{ .Render "card" }}
    {{ end }}
  </ul>
{{ end }}
layouts/articles/card.html
<div class="card">
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ .Summary }}
</div>

了解更多关于 内容视图模板 的信息。

渲染钩子

渲染钩子模板覆盖 Markdown 到 HTML 的转换。

例如,下面的渲染钩子模板为外部链接添加 rel 属性。

layouts/_default/_markup/render-link.html
{{- $u := urls.Parse .Destination -}}
<a href="{{ .Destination | safeURL }}"
  {{- with .Title }} title="{{ . }}"{{ end -}}
  {{- if $u.IsAbs }} rel="external"{{ end -}}
>
  {{- with .Text | safeHTML }}{{ . }}{{ end -}}
</a>
{{- /* chomp trailing newline */ -}}

了解更多关于 渲染钩子模板 的信息。

短代码

短代码模板用于渲染站点的组件。与局部模板不同,短代码模板是从内容页面调用的。

例如,下面的短代码模板从 全局资源 渲染音频元素。

layouts/shortcodes/audio.html
{{ with resources.Get (.Get "src") }}
  <audio controls preload="auto" src="{{ .RelPermalink }}"></audio>
{{ end }}

从您的内容页面调用短代码:

content/example.md
{{< audio src="audio/test.mp3" >}}

了解更多关于 短代码模板 的信息。

其他

使用其他专用模板创建:

  • 站点地图
  • RSS 订阅
  • 404 错误页面
  • robots.txt 文件

See also

  • 术语表
  • 方法
  • 组织
  • 分页
  • 文件

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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护