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

术语表

文档中常用术语。

A   B   C   D   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U   V   W   Z  

action

参见 模板操作 。

archetype

新内容的模板。参见 详情 。

argument

传递给 函数 、 方法 或 短代码 的 标量 、 数组 、 切片 、 映射 或 对象 。

array

编号的元素序列。与 Go 的 切片 数据类型不同,数组具有固定长度。数组中的 元素 可以是 标量 、切片、 映射 、页面或其他数组。详情参见 Go 文档 。

bool

参见 布尔值 。

boolean

具有两个可能值的数据类型, true 或 false 。

branch bundle

包含 _index.md 文件和零个或多个 资源 的目录。类似于物理分支,分支包可能有子项,包括叶子包和其他分支包。带有或不带有 _index.md 文件的顶级目录也是分支包。这包括主页。参见 详情 。

build

生成静态站点,其中包括 HTML 文件和资产,例如图像、CSS 和 JavaScript。构建过程包括渲染和资源转换。

bundle

参见 页面包 。

cache

存储数据以加快将来对相同数据的请求的软件组件。

chain

在模板中,用点连接一个或多个 标识符 。标识符可以表示方法、对象或字段。例如, .Site.Params.author.name 或 .Date.UTC.Hour 。

CJK

汉语、日语和韩语的统称。参见 详情 。

CLI

命令行界面。

collection

数组 、 切片 或 映射 。

content adapter

在构建站点时动态创建页面的模板。例如,使用内容适配器从远程数据源(例如 JSON、TOML、YAML 或 XML)创建页面。参见 详情 。

content format

用于创建内容的标记语言。通常是 Markdown,但也可能是 HTML、AsciiDoc、Org、Pandoc 或 reStructuredText。参见 详情 。

content type

从顶级目录名称或 前置 matter 中设置的 type 推断出的内容分类。内容目录根目录中的页面(包括主页)的类型为“page”。在 模板 中通过 .Page.Type 访问。参见 详情 。

content view

使用 .Page.Render 方法调用的模板。参见 详情 。

context

在 模板操作 中用点 “.” 表示,上下文是数据结构中的当前位置。例如,在迭代页面 集合 时,每次迭代中的上下文是页面的数据结构。每个模板接收的上下文取决于模板类型和/或调用方式。参见 详情 。

default sort order

页面集合的默认排序顺序。Hugo 按 权重 排序,然后按日期(降序)排序,然后按链接标题排序,然后按文件路径排序。

element

切片或数组的成员。

environment

通常是 development 、 staging 或 production 之一,每个环境可能会根据配置和模板逻辑表现出不同的行为。例如,在生产环境中,您可能会缩小和指纹 CSS,但这在开发环境中可能没有意义。

使用 hugo server 命令运行内置开发服务器时,环境设置为 development 。使用 hugo 命令构建站点时,环境设置为 production 。要覆盖环境值,请使用 --environment 命令行标志或 HUGO_ENVIRONMENT 环境变量。

要在模板中确定当前环境,请使用 hugo.Environment 函数。

field

前置 matter 中预定义的键值对,例如 date 或 title 。另见 参数 。

flag

传递给命令行程序的选项,以一个或两个连字符开头。参见 详情 。

float

参见 浮点数 。

floating point

具有小数部分的数值数据类型。例如, 3.14159 。

fragment

URL 的最后一段,以哈希( # )标记开头,引用页面上 HTML 元素的 id 属性。

front matter

每个内容页开头处的元数据,通过特定于格式的分隔符与内容分隔。参见 详情 。

function

在 模板操作 中使用,函数接受一个或多个 参数 并返回一个值。与 方法 不同,函数不与 对象 关联。参见 详情 。

global resource

资产目录中或 挂载 到资产目录的任何目录中的文件。使用 resources.Get 、 resources.GetMatch 、 resources.Match 或 resources.ByType 函数捕获一个或多个全局资源。

headless bundle

一个未发布的叶子或分支包,其内容和资源可以包含在其他页面中。参见 构建选项 。

identifier

表示变量、方法、对象或字段的字符串。它必须符合 Go 的 语言规范 ,以字母或下划线开头,后跟零个或多个字母、数字或下划线。

int

参见 整数 。

integer

没有小数部分的数值数据类型。例如, 42 。

internationalization

启用 本地化 的软件设计和开发工作。参见 W3C 定义 。缩写为 i18n。

interval

区间 是两个端点之间的一系列数字:闭合、开放或半开放。

  • 闭合区间,用方括号表示,包含其端点。例如,[0, 1] 是 0 <= x <= 1 的区间。

  • 开放区间,用圆括号表示,不包含其端点。例如,(0, 1) 是 0 < x < 1 的区间。

  • 半开区间只包含其端点之一。例如,(0, 1] 是 0 < x <= 1 的左开区间,而 [0, 1) 是 0 <= x < 1 的右开区间。

kind

参见 页面种类 。

layout

参见 模板 。

leaf bundle

包含 index.md 文件和零个或多个 资源 的目录。类似于物理叶子,叶子包位于分支的末端。它没有子项。参见 详情 。

lexer

一个软件组件,它识别输入文本中编程语言的基本构建块,例如关键字、标识符、运算符和数字。

list page

任何在 上下文 中接收页面 集合 的 页面种类 。这包括主页、 章节页面 、 分类页面 和 术语页面 。

list template

渲染 列表页面 的任何模板。这包括 主页 、 章节 、 分类 和 术语 模板。

localization

使站点适应语言和区域要求。这包括翻译、特定于语言的媒体、日期和货币格式等。参见 详情 和 W3C 定义 。缩写为 l10n。

logical path
New in v0.123.0

从文件路径派生的页面或页面资源标识符,不包括其扩展名和语言标识符。此值既不是文件路径也不是 URL。从相对于内容目录的文件路径开始,Hugo 通过去除文件扩展名和语言标识符、转换为小写,然后将空格替换为连字符来确定逻辑路径。 参见 示例 。

map

元素的无序组,每个元素都由一个唯一的键索引。参见 Go 文档 以了解详情。

Markdown attribute

属性列表,包含一个或多个键值对,用空格或逗号分隔,并用大括号括起来。将 Markdown 属性应用于图像和块级元素,包括块引用、围栏代码块、标题、水平线、列表、段落和表格。参见 详情 。

marshal

将数据结构转换为序列化对象。例如,将 映射 转换为 JSON 字符串。参见 unmarshal 。

method

在 模板操作 中使用并与 对象 关联,方法接受零个或多个 参数 ,并返回一个值或执行一个操作。例如, .IsHome 是 .Page 对象上的一个方法,如果当前页面是主页,则返回 true 。另见 函数 。

module

像 主题 一样,模块是 原型 、资产、内容、数据、 模板 、翻译表、静态文件或配置设置的打包组合。模块可以作为新站点的基础,也可以用于增强现有站点。参见 详情 。

node

一类 页面种类 ,包括 home 、 section 、 taxonomy 和 term 。

noop

“无操作”的缩写形式,noop 是一个什么也不做的语句。

object

具有或不具有关联 方法 的数据结构。

ordered taxonomy

通过在 Taxonomy 对象(一个 映射 )上调用 Alphabetical 或 ByCount 方法创建,有序分类是一个 切片 ,其中每个元素都是一个包含 术语 及其 加权页面 切片的对象。

output format

Hugo 在构建站点时,每个页面会生成一个或多个文件。例如,在渲染主页、 章节 、 分类 和 术语 页面时,Hugo 会生成一个 HTML 文件和一个 RSS 文件。HTML 和 RSS 都是内置的 输出格式 。您可以创建多个输出格式,并根据 页面类型 控制生成,或者为一个或多个页面启用一个或多个输出格式。详情请参见 此处 。

page bundle

封装内容和关联 资源 的目录。页面包有两种类型: 叶子包 和 分支包 。参见 详情 。

page collection

Page 对象的切片。

page kind

页面的分类,其中之一为 home 、 page 、 section 、 taxonomy 或 term 。参见 详情 。

请注意,还有 RSS 、 sitemap 、 robotsTXT 和 404 页面种类,但这些仅在其各自页面种类渲染期间可用,因此在任何 Pages 集合中都不可用。

page resource

页面包 中的文件。使用 Page 对象上的任何 Resources 方法捕获一个或多个页面资源。

pager

在 分页 期间创建,分页器包含列表页面的子集以及其他分页器的导航链接。

paginate

将列表页面拆分为两个或多个子集。

pagination

分页 列表页面的过程。参见 详情 。

paginator

分页器 的集合。

parameter

通常是站点或页面级别的用户定义键值对,但也可能指配置设置或 参数 。另见 字段 。

partial

从任何其他模板(包括 短代码 、 渲染钩子 和其他局部模板)调用的 模板 。局部模板要么渲染某些内容,要么返回某些内容。局部模板还可以调用自身,例如,遍历 数据结构 。

permalink

已发布资源或已渲染页面的绝对 URL,包括方案和主机。

pipe

参见 管道 。

pipeline

在 模板操作 中,管道是值、 函数 调用或 方法 调用的可能链式序列。管道中的函数和方法可能接受多个 参数 。

管道可以通过用管道字符 “|” 分隔命令序列来进行链式连接。在链式管道中,每个命令的结果作为最后一个参数传递给下一个命令。管道中最终命令的输出是管道的值。详情参见 Go 文档 。

publish

参见 build 。

regular page

具有 “page” 页面种类 的内容。另见 章节页面 。

relative permalink

已发布资源或已渲染页面的主机相关 URL。

render hook

覆盖标准 Markdown 渲染的 模板 。参见 详情 。

remote resource

远程服务器上的文件,可通过 HTTP 或 HTTPS 使用 resources.GetRemote 函数访问。

resource

构建过程中使用的任何文件,用于增强或生成内容、结构、行为或演示文稿。例如:图像、视频、内容片段、CSS、Sass、JavaScript 和数据。

Hugo 支持三种类型的资源: 全局 、 页面 和 远程

resource type

资源 媒体类型 的主要类型。内容文件(如 Markdown、HTML、AsciiDoc、Pandoc、reStructuredText 和 Emacs Org Mode)的资源类型为 page 。其他资源类型包括 image 、 video 等。使用 Resource 对象上的 ResourceType 方法检索资源类型。

scalar

单个值,其中之一为 字符串 、 整数 、 浮点数 或 布尔值 。

scratch pad

从概念上讲,一个具有 方法 来设置、获取、更新和删除值的 映射 。使用 Scratch 或 Store 方法将数据结构附加到 Page 对象,或使用 newScratch 函数创建一个局部作用域的 scratch pad。

section

顶级内容目录,或任何带有 _index.md 文件的内容目录。带有 _index.md 文件的内容目录也称为 分支包 。章节模板在 上下文 中接收一个或多个页面 集合 。参见 详情 。

section page

具有 “section” 页面种类 的内容。通常是当前 章节 中的 常规页面 和/或 章节页面 的列表。另见 常规页面 。

shortcode

从 Markdown 中调用的 模板 ,接受零个或多个 参数 。参见 详情 。

slice

编号的元素序列。与 Go 的 数组 数据类型不同,切片是动态大小的。切片中的 元素 可以是 标量 、 数组 、 映射 、页面或其他切片。详情参见 Go 文档 。

string

字节序列。例如, "6 乘以 7 等于多少?"  。

string literal (interpreted)

解释的字符串字面量是双引号之间的字符序列,例如 “foo”。在引号内,任何字符都可以出现,除了换行符和未转义的双引号。引号之间的文本构成字面量的值,并解释反斜杠转义。参见 详情 。

string literal (raw)

原始字符串字面量是反引号之间的字符序列,例如 bar 。在反引号内,任何字符都可以出现,除了反引号。反斜杠没有特殊含义,字符串可以包含换行符。原始字符串字面量中的回车符 (’\r’) 将从原始字符串值中删除。参见 详情 。

taxonomic weight

在 front matter 中定义,并且对每个分类都是唯一的,此 权重 决定包含在 Taxonomy 对象中的页面集合的排序顺序。参见 详情 。

taxonomy

用于对内容进行分类的相关 术语 的组。例如,“颜色”分类可能包含“红色”、“绿色”和“蓝色”等术语。参见 详情 。

taxonomy object

术语 和与每个术语关联的 加权页面 的 映射 。

taxonomy page

具有 “taxonomy” 页面种类 的内容。通常是在给定 分类 中的 术语 列表。

template

包含 模板操作 的文件,位于项目、主题或模块的 layouts 目录中。参见 详情 。

template action

模板 中的数据评估或控制结构,用 “{{” 和 “}}” 分隔。详情参见 Go 文档 。

term

分类 的成员,用于对内容进行分类。参见 详情 。

term page

具有 “term” 页面种类 的内容。通常是具有给定 术语 的 常规页面 和 章节页面 的列表。

theme

原型 、资产、内容、数据、 模板 、翻译表、静态文件或配置设置的打包组合。主题可以作为新站点的基础,也可以用于增强现有站点。另见 模块 。

token

格式字符串中的标识符,以冒号开头,在渲染时替换为值。例如,在 永久链接 和 日期 的格式字符串中使用标记。

type

参见 内容类型 。

unmarshal

将序列化对象转换为数据结构。例如,将 JSON 文件转换为可在模板中访问的 映射 。参见 marshal 。

variable

以 $ 符号开头的用户定义 标识符 ,表示任何数据类型的变量,在 模板操作 中初始化或赋值。例如, $foo  和  $bar 是变量。

walk

递归遍历嵌套数据结构。例如,渲染多级菜单。

weight

用于定位按权重排序的集合中的元素。使用非零整数分配权重。较轻的项目浮到顶部,而较重的项目沉到底部。未加权或零权重的元素放置在集合的末尾。权重通常分配给页面、菜单项、语言和输出格式。

weighted page

包含在 Taxonomy 对象中,加权页面是一个 映射 ,包含两个元素:一个 Page 对象及其在 front matter 中定义的 分类权重 。使用 Page 和 Weight 键访问元素。

zero time

零时间 是 UTC 时间 0001 年 1 月 1 日 00:00:00。根据 RFC3339 格式化, 零时间 为 0001-01-01T00:00:00-00:00。

See also

  • 模板类型
  • 配置
  • Front matter (前置 matter)
  • 方法
  • transform.Unmarshal
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 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护