HUGO中文文档

  • 文档
  • 关于Hugo
  • 用例
  • 新闻
  • 官方主题
  • 官方网站
  • 99元/年云主机
  • 关于Hugo
    • 概述
    • 什么是Hugo
    • Hugo 功能特点
    • 静态网站生成器
    • Hugo安全模型
    • Hugo和GDPR
    • 许可证
  • 安装
    • 概述
    • macOS
    • Linux
    • Windows
    • BSD
  • 起步
    • 概述
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记语言
    • 术语表
    • 外部学习资源
  • 内容管理
    • 概述
    • 组织
    • 页面捆绑
    • 内容格式
    • 图表
    • 前置格式
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • Sections
    • 内容类型
    • 雏形
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL管理
    • 菜单
    • 静态文件
    • 目录
    • 评论
    • 多语言
    • 语法高亮
  • 模板
    • 概述
    • 模板化
    • 模板查找顺序
    • 基础模板与块
    • 单页模板
    • 列表模板
    • 首页模板
    • 章节模板
    • 分类模板
    • 分页
    • 内容视图模板
    • 部分模板
    • 短代码模板
    • 菜单模板
    • 数据模板
    • RSS 模板
    • 网站地图模板
    • 本地文件模板
    • 内部模板
    • 渲染钩子
    • 自定义输出格式
    • 404页面
    • Robots.txt
    • 模板调试
  • 函数
    • 概述
    • global
    • Go模板
    • Hugo
    • JavaScript
    • lang
    • math
    • os
    • safe
    • URL
    • 加密
    • 反射
    • 图像
    • 字符串
    • 数据
    • 时间
    • 格式化
    • 模板
    • 比较
    • 编码
    • 词形变化
    • 调试
    • 资源
    • 路径
    • 转换
    • 转换函数
    • 部分函数
    • 集合
  • 方法
    • 概览
    • 持续时间
    • 时间
    • 网站
    • 菜单项
    • 页面
  • 快速参考
    • 概览
    • 函数
    • 方法
  • 变量
    • 概述
    • 文件变量
    • Git变量
    • 菜单项变量
    • 页面变量
    • 页面集合变量
    • 短代码变量
    • 网站变量
    • 分类变量
  • Hugo模块
    • 概述
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo管道
    • 概述
    • 简介
    • 将Sass转译为CSS
    • PostCSS
    • PostProcess
    • JavaScript构建
    • 资源压缩
    • 合并资源
    • 指纹和SRI哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行
  • 故障排除
    • 概览
    • 常见问题
    • 构建性能
  • 开发者工具
    • 概述
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 概述
    • Hugo部署
    • 使用Rclone部署
    • 使用Rsync进行部署
    • 在 Azure 静态 Web 应用上托管
    • 在 Cloudflare Pages 上托管
    • 在 GitHub Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 在21YunBox上进行托管
    • 在AWS Amplify上托管
    • 在Firebase上托管
    • 在GitLab Pages上托管
    • 在KeyCDN上托管
  • 贡献
    • 概述
    • 开发
    • 文档
    • 主题
  • 维护
开始使用

术语表

文档中常用的术语。

action

参见 模板行动。

archetype

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

argument

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

array

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

bool

参见 布尔。

boolean

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

branch bundle

带有 _index.md 文件和零个或多个资源的页面包。与物理分支相类似,分支包可能有包括普通页面、叶片包和其他分支包在内的子包。请参见详情。

build

生成包含HTML文件和诸如图像、CSS和 JavaScript等资源的静态站点。构建过程包括渲染和资源转换。

bundle

参见页面包。

cache

存储数据的软件组件,使得对同样数据的未来请求更快。

chain

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

collection

数组,切片或映射。

content format

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

content type

从顶级目录名称或在前置参数中设置的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函数。

flag

传递给命令行程序的选项,以一个或两个短横线开始。参见详情。

float

参见 浮点。

floating point

带有小数部分的数字数据类型。例如,3.14159。

fragment

URL的最后部分,以井号(#)开头,引用页面上的HTML元素的id属性。

front matter

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

function

在模板行动中用到,函数接收一个或多个参数并返回值。与方法不同,函数不与对象相关联。参见详情。

global resource

在assets目录中的文件,或安装到assets目录的任何目录的文件。使用resources.Get,resources.GetMatch,resources.Match,或resources.ByType函数获取一个或多个全局资源。

identifier

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

int

参见 整数。

integer

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

internationalization

使得本地化成为可能的软件设计和开发工作。参见W3C的定义。被称作i18n。

kind

参见 页面类型。

layout

参见 模板。

leaf bundle

带有 index.md 文件和零个或多个资源的页面包。类比于物理叶子,叶子包位于分支的尾部。Hugo忽略叶子包下面的内容(但不忽略资源)。详见详情。

list page

接收页面集合作为上下文的任何页面类型。包括主页,section pages,分类页面和词条页面。

localization

根据语言和地区要求进行网站改动。包括翻译,特定语言的媒体文件,日期和货币格式等。参见详情和 W3C的定义。被简写为l10n。

map

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

markdown attribute

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

marshal

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

method

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

module

像主题一样,模块是原型,资产,内容,数据,模板,翻译表,静态文件或配置设置的集合。模块可以作为新站点的基础,或者可以增加现有站点的功能。详见详情。

object

带有或不带有相关方法的数据结构。

ordered taxonomy

在分类对象(即一种映射)上调用Alphabetical或ByCount方法创建,创建出一个切片,其中每个元素都是包含词条和其加权页面切片的对象。

output format

当构建网站时,Hugo会为每个页面生成一个或多个文件。例如,当渲染主页、章节、分类和术语页面时,Hugo会生成一个HTML文件和一个RSS文件。HTML和RSS都是内置的_output格式_。可以创建多个输出格式,并根据页面种类进行生成控制,或者为一个或多个页面启用一个或多个输出格式。请参阅详细信息。

page bundle

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

page kind

页面的分类,是home,page,section,taxonomy或term中的一种。参见详情。

注意还有RSS,sitemap,robotsTXT和404这些页面类型,但这些只在渲染每个各自页面类型时可用,因此在任何Pages集合中都不可用。

page resource

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

pager

在分页时创建,pager包含一部分的section列表,和导向其他pager的导航链接。

paginate

将section列表分为两个或更多的pager。参见详情。

pagination

把section列表进行分页的过程。

parameter

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

partial

从任何其他模板(包括短代码,渲染钩子和其他部分)调用的模板。部分模板或渲染某些东西,或者返回某些东西。部分模板还可以调用其本身,例如要遍历一个数据结构。

permalink

已发布资源或渲染页面的绝对URL,包括scheme和host。

pipe

参见 管道。

pipeline

在模板行动内,管道是值,函数调用或方法调用的可能链式序列。管道中的函数和方法可能需要多个参数。

可以通过将一系列命令和管道字符 “|” 分隔开来实现管道的链式操作。在链式管道中,每个命令的结果作为下一个命令的最后一个参数传递。管道中最后一个命令的输出是管道的值。更多信息参见Go文档。

publish

参见build。

regular page

“page"类型的页面类型的内容。参见 section page。

relative permalink

已发布资源或渲染页面的相对于host的URL。

render hook

能覆盖标准markdown渲染的模板。详见详情。

remote resource

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

resource

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

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

scalar

单一的值,是字符串,整数,浮点,或布尔中的一种。

scratch pad

概念上,带有方法用以设置,获取,更新,和删除值的映射。使用Scratch或Store方法将数据结构连接到Page对象,或者使用newScratch函数创建一个局部的scratch pad。

section

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

section page

“section"类型的页面类型的内容。通常列出当前区段内的普通页面和/或区段页面。参见普通页面。

shortcode

从markdown内部调用的模板,接收零个或多个参数。详见详情。

slice

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

string

一个字节序列。例如,"What is 6 times 7?"。

taxonomic weight

在前置参数定义,对每个分类都是唯一的,这个权重决定了分类对象中的页面集合的排序顺序。参见详情。

taxonomy

用于对内容进行分类的相关词条的群体。例如,“colors"分类可能包括"red”, “green”, 和 “blue”. 参见详情。

taxonomy object

一个映射,包括词条以及与每个词条相关联的加权页面。

taxonomy page

“taxonomy"类型的页面类型的内容。通常列出给定分类内的词条。

template

在项目,主题,或模块的布局目录里,含有 模板行动 的文件。参见详情。

template action

在模板中的数据评估或控制结构,由 “{{" 和 ”}}” 限定。参见 Go 文档 了解详情。

term

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

term page

“term"类型的页面类型的内容。通常列出具有给定词条的普通页面和section pages。

theme

打包组合了原型,资产,内容,数据,模板,翻译表,静态文件或配置设置。主题可能用作新站点的基础,或者用以增加现有站点的功能。参见模块。

token

在格式字符串中的标识符,以冒号开头,在渲染时被一个值代替。例如,在permalinks和日期的格式字符串中使用令牌。

type

参找 内容类型。

unmarshal

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

variable

用户在模板行动内定义的以符号$为前缀的标识符,代表的是任何数据类型的值。例如,$foo和$bar是变量。

walk

递归地遍历嵌套的数据结构。例如,呈现多级菜单。

weight

用来在按权重排序的集合中确定元素的位置。使用非零整数赋予权重。轻的项目飘至顶部,而重的项目沉到底部。无权重或零权重的元素被放置在集合的末尾。权重通常被赋予页面,菜单条目,语言和输出格式。

weighted page

包含在分类对象内,加权页面是一个映射,带有两个元素:一个Page对象,和在前置参数中定义的分类权重。使用Page和Weight键访问元素。

See also

  • 术语表
  • 配置 Hugo
  • 配置 Hugo
  • 内容组织
  • 内容组织
Last updated: January 2, 2024: add pagefind for search (5a7343596)
Improve this page
 
 

copyright © opendocs.io 2024

本站点基于hugo官方文档翻译而来,感谢hugo官方团队的贡献和提供如此出色的工具

  • 文档
  • 关于Hugo
  • 用例
  • 新闻
  • 官方主题
  • 官方网站
  • 99元/年云主机
  • 关于Hugo
  • 安装
  • 起步
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 快速参考
  • 变量
  • Hugo模块
  • Hugo管道
  • 命令行
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护