HUGO中文文档
文档
关于Hugo
用例
新闻
官方主题
官方网站
99元/年云主机
Search
关于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上托管
贡献
概述
开发
文档
主题
维护
页面方法
使用这些方法与页面对象配合使用。
AllTranslations
返回给定页面的所有翻译,包括给定的页面本身。
Read More »
AlternativeOutputFormats(备选输出格式)
返回一个
OutputFormat
对象的切片,不包括当前输出格式,每个对象表示给定页面启用的一个输出格式。
Read More »
BundleType(束类型)
返回给定页面的束类型,如果页面不是页面束,则返回空字符串。
Read More »
CodeOwners(代码所有者)
返回给定页面的代码所有者片段,从项目目录根目录中的CODEOWNERS文件中获取。
Read More »
CurrentSection
返回给定页面所在的部分的页面对象。
Read More »
Eq
判断两个Page对象是否相等。
Read More »
ExpiryDate(过期日期)
返回给定页面的过期日期。
Read More »
FuzzyWordCount(模糊字数统计)
返回给定页面内容中的字数,以100的倍数向上取整。
Read More »
GetPage
返回给定路径的Page对象。
Read More »
GetTerms
返回给定页面上给定分类法中定义的术语页面的集合,按照在frnt matter中出现的顺序排序。
Read More »
GitInfo
返回与给定页面的最后提交相关的Git信息。
Read More »
HasMenuCurrent
判断给定的页面对象是否与给定菜单中给定菜单项下关联的页面对象匹配。
Read More »
HasShortcode
判断给定页面是否调用了给定的短代码。
Read More »
HeadingsFiltered
返回与给定页面相关的每个页面的标题列表。
Read More »
InSection
判断给定页面是否在给定的部分中。
Read More »
IsAncestor
报告PAGE1是否是PAGE2的祖先。
Read More »
IsDescendant
报告PAGE1是否是PAGE2的子孙页面。
Read More »
IsHome
判断给定页面是否为主页。
Read More »
IsMenuCurrent
判断给定的页面对象是否与给定菜单中的菜单条目所关联的页面对象匹配。
Read More »
IsNode
判断给定页面是否为节点。
Read More »
IsPage
报告给定页面是否为普通页面。
Read More »
IsSection
判断给定页面是否为章节页面。
Read More »
IsTranslated
判断给定页面是否有一个或多个翻译版本。
Read More »
Kind
返回给定页面的类型。
Read More »
Lastmod
返回给定页面的最后修改日期。
Read More »
Next
返回给定页面在全局页面集合中的下一页。
Read More »
NextInSection
返回给定页面相对于所在部分的下一个页面。
Read More »
OutputFormats
返回一个表示给定页面启用的输出格式之一的OutputFormat对象组成的切片。
Read More »
Paginator
对接收到的常规页面集合进行分页处理。
Read More »
Param
返回具有给定键的页面参数,如果有,则回退到站点参数。
Read More »
Params
返回给定页面前置元数据中定义的自定义参数映射。
Read More »
Plain
返回给定页面的渲染内容,移除所有HTML标签。
Read More »
PlainWords
调用 Plain 方法,将结果拆分为单词切片,并返回该切片。
Read More »
Prev
返回给定页面在全局页面集合中的上一页。
Read More »
PrevInSection
返回给定页面相对于所在部分的前一页。
Read More »
PublishDate
返回给定页面的发布日期。
Read More »
RawContent
返回给定页面的原始内容。
Read More »
Ref
返回给定页面的绝对 URL,包括给定路径、语言和输出格式。
Read More »
RegularPages
返回当前部分中的常规页面集合。
Read More »
RegularPagesRecursive
返回当前部分内的常规页面集合,以及所有后代部分内的常规页面。
Read More »
RelPermalink
返回给定页面的相对永久链接。
Read More »
RelRef
返回给定页面的相对URL,带有给定的路径、语言和输出格式。
Read More »
RenderShortcodes
渲染给定页面内容中的所有短代码,保留周围的标记。
Read More »
RenderString
将标记渲染为HTML。
Read More »
Scratch
在给定页面上创建一个“scratch pad”,用于存储和操作数据。
Read More »
Section
返回给定页面所属的顶级部分的名称。
Read More »
Slug(网页链接)
返回在开头信息中设定的给定页面的URL网址链接。
Read More »
TranslationKey
返回给定页面的翻译键。
Read More »
WordCount
返回给定页面内容中的单词数量。
Read More »
标题
返回给定页面的标题。
Read More »
别名
返回在正文元数据中定义的URL别名。
Read More »
布局
返回在前置元数据中定义的给定页面的布局。
Read More »
草稿
判断给定页面是否为草稿,根据前置元数据进行定义。
Read More »
存储
在给定页面上创建一个可持久化的“草稿本”,用于存储和操作数据。
Read More »
第一节
返回给定页面所属顶级节的Page对象。
Read More »
翻译
返回给定页面的所有翻译,不包括当前语言。
Read More »
分页
对页面集合进行分页处理。
Read More »
父级
返回给定页面的父级部分的页面对象。
Read More »
关键词
返回在前置元数据中定义的关键词切片。
Read More »
截断
汇报内容长度是否超过摘要长度。
Read More »
类型
返回给定页面的内容类型。
Read More »
链接标题
返回给定页面的链接标题。
Read More »
描述
根据前置数据中定义的描述,返回给定页面的描述。
Read More »
目录
返回给定页面的目录。
Read More »
内容
返回给定页面的渲染内容。
Read More »
片段
返回给定页面中的片段的数据结构。
Read More »
日期
返回给定页面的日期。
Read More »
数据
返回每种页面类型的唯一数据对象。
Read More »
网站
返回网站对象。
Read More »
网站地图
返回给定页面中在前置元数据中定义的网站地图设置,如果没有定义则返回网站配置定义的网站地图设置。
Read More »
文件
对于由文件支持的页面,返回给定页面的文件信息。
Read More »
渲染
使用给定页面作为上下文来渲染给定的模板。
Read More »
页面
返回给定页面的Page对象。
Read More »
页面
返回当前部分内的常规页面集合,以及子代部分的部分页面。
Read More »
永久链接
返回给定页面的永久链接。
Read More »
语言
返回给定页面的语言对象。
Read More »
阅读时间
返回给定页面的估计阅读时间(以分钟为单位)。
Read More »
摘要
返回给定页面的内容摘要。
Read More »
站点
返回所有站点对象的集合,每个语言一个对象,并按语言权重排序。
Read More »
章节
返回一个页面集合,其中包含给定页面的每个直接子级章节的页面。
Read More »
重量
返回前置元数据中定义的给定页面的权重。
Read More »
资源
返回一个页面资源集合。
Read More »
祖先
返回给定页面的每个祖先部分的Page对象集合。
Read More »