方法
Duration
使用这些方法处理 time.Duration 值。
- Abs
- 返回给定 time.Duration 值的绝对值。
- Round
- 返回将 DURATION1 四舍五入到 DURATION2 的最近倍数的结果。
- 分钟
- 将 time.Duration 值作为浮点数分钟数返回。
- 小时数
- 将 time.Duration 值作为浮点数的小时数返回。
- 微秒
- 将 time.Duration 值作为整数微秒计数返回。
- 截断
- 返回将 DURATION1 向零舍入到 DURATION2 倍数的结果。
- 毫秒数
- 将 time.Duration 值作为整数毫秒计数返回。
- 秒数
- 将 time.Duration 值作为浮点数秒数返回。
- 纳秒
- 将 time.Duration 值作为整数纳秒计数返回。
Menu
使用这些方法遍历菜单项。
- ByWeight
- 返回给定的菜单，其条目按权重排序，然后按名称排序，最后按标识符排序。
- 反转
- 返回给定的菜单，并反转其条目的排序顺序。
- 按名称排序
- 返回按名称排序条目的给定菜单。
- 限制
- 返回给定的菜单，限制为前 N 个条目。
Page
使用这些方法与页面对象。
- Bundle类型
- 返回给定页面的包类型，如果页面不是页面包，则返回空字符串。
- CodeOwners
- 返回给定页面的代码所有者切片，该切片源自项目目录根目录下的 CODEOWNERS 文件。
- ContentWithoutSummary
- 返回给定页面的渲染内容，不包括内容摘要。
- ExpiryDate
- 返回给定页面的过期日期。
- GetPage
- 从给定路径返回一个 Page 对象。
- GetTerms
- 返回给定分类中，在给定页面上定义的术语页面的集合，其顺序与他们在前置内容中出现的顺序一致。
- Git信息
- 返回与给定页面的最后一次提交相关的 Git 信息。
- HasMenuCurrent
- 报告给定菜单条目下给定菜单中的子菜单条目之一是否与关联的 Page 对象匹配。
- HasShortcode函数
- 报告给定页面是否调用了给定的简码。
- InSection
- 报告给定页面是否在给定部分中。
- IsAncestor
- 报告 PAGE1 是否是 PAGE2 的祖先。
- IsDescendant
- 报告PAGE1是否为PAGE2的子级。
- IsHome
- 报告给定页面是否为主页。
- IsMenuCurrent
- 报告给定页面对象是否与给定菜单中给定菜单项关联的页面对象匹配。
- IsNode
- 报告给定页面是否为节点。
- IsPage
- 报告给定页面是否为常规页面。
- IsSection
- 报告给定页面是否为章节页面。
- IsTranslated
- 报告给定页面是否具有一个或多个翻译。
- Lastmod
- 返回给定页面的上次修改日期。
- Len
- 返回给定页面渲染内容的字节长度。
- LinkTitle
- 返回给定页面的链接标题。
- NextInSection
- 返回指定页面所在章节中的下一个常规页面。
- PAGE.Store
- 返回给定页面上的持久性“备忘录”以存储和操作数据。
- Plain 方法
- 返回给定页面的渲染内容，移除所有 HTML 标签。
- PlainWords
- 调用 Plain 方法，将结果拆分为单词切片，并返回该切片。
- PrevInSection
- 返回某个章节中相对于给定页面的上一页常规页面。
- PublishDate
- 返回给定页面的发布日期。
- RegularPages
- 返回当前章节内常规页面的集合。
- RegularPagesRecursive
- 返回当前区块内以及所有子区块内的常规页面集合。
- RelPermalink
- 返回给定页面的相对永久链接。
- RelRef
- 返回具有给定路径、语言和输出格式的页面的相对 URL。
- Render
- 使用给定的页面作为上下文渲染给定的模板。
- RenderShortcodes
- 渲染给定页面内容中的所有短代码，同时保留周围的标记。
- RenderString
- 将标记渲染为HTML。
- Slug
- 返回页面在 front matter 中定义的 URL slug。
- Truncated
- 报告内容长度是否超过摘要长度。
- 上一页
- 返回站点常规页面集合中相对于当前页面的上一页。
- 下一个
- 返回站点常规页面集合中相对于当前页面的下一页。
- 临时存储区
- 返回给定页面上的“临时存储区”以存储和操作数据。
- 关键词
- 返回在 front matter 中定义的关键词切片。
- 内容
- 返回给定页面的渲染内容。
- 分页
- 对页面集合进行分页。
- 分页器
- 对在上下文中接收到的常规页面集合进行分页。
- 别名
- 返回在 front matter 中定义的 URL 别名。
- 原始内容
- 返回给定页面的原始内容。
- 参数
- 返回具有给定键的页面参数，如果存在则回退到站点参数。
- 参数
- 返回给定页面前置内容中定义的自定义参数映射。
- 备选输出格式
- 返回一个
OutputFormat对象的切片，不包括当前输出格式，每个对象都代表为给定页面启用的输出格式之一。 - 多语言翻译
- 返回给定页面的所有翻译，不包括当前语言。
- 字数统计
- 返回给定页面内容中的字数。
- 布局
- 返回在 front matter 中定义的给定页面的布局。
- 引用
- 返回具有给定路径、语言和输出格式的页面的绝对 URL。
- 当前章节
- 返回给定页面所在的章节的页面对象。
- 所有翻译
- 返回给定页面的所有翻译，包括当前语言。
- 摘要
- 返回给定页面的摘要。
- 数据
- 为每种页面类型返回唯一的数据对象。
- 文件
- 对于由文件支持的页面，返回给定页面的文件信息。
- 日期
- 返回给定页面的日期。
- 权重
- 返回页面在 front matter 中定义的权重。
- 标题
- 返回给定页面的标题。
- 标题过滤
- 返回与给定页面相关的每个页面的标题切片。
- 模糊字数统计
- 返回给定页面内容中的字数，四舍五入到最接近的 100 的倍数。
- 永久链接
- 返回给定页面的永久链接。
- 父级
- 返回给定页面的父级部分的 Page 对象。
- 片段
- 返回给定页面中片段的数据结构。
- 目录
- 返回给定页面的目录。
- 相等性判断
- 报告两个页面对象是否相等。
- 祖先页面
- 返回一个页面对象集合，每个对象代表给定页面的一个祖先章节。
- 种类
- 返回给定页面的种类。
- 站点
- 返回站点对象。
- 站点
- 返回所有站点对象的集合，每个语言一个，按语言权重排序。
- 站点地图
- 返回给定页面在 front matter 中定义的站点地图设置，如果未定义则回退到站点配置中定义的站点地图设置。
- 第一节
- 返回给定页面所属顶级部分的 Page 对象。
- 类型
- 返回给定页面的内容类型。
- 翻译密钥
- 返回给定页面的翻译密钥。
- 节区
- 返回一个节区页面集合，每个页面对应给定页面的每个直接子节区。
- 草稿
- 报告给定页面是否为前置内容中定义的草稿。
- 语言
- 返回给定页面的语言对象。
- 资源
- 返回页面资源的集合。
- 路径
- 返回给定页面的逻辑路径。
- 输出格式
- 返回一个 OutputFormat 对象的切片，每个对象代表为给定页面启用的输出格式之一。
- 部分
- 返回给定页面所在的顶级部分的名称。
- 阅读时间
- 返回给定页面的预计阅读时间（以分钟为单位）。
- 页面
- 返回给定页面的 Page 对象。
- 页面
- 返回当前章节内常规页面的集合，以及直接子章节的章节页面。
- 页面描述
- 返回页面在 front matter 中定义的描述。
Pager
在为 分页 列表页面构建导航时，请将这些方法与 Pager 对象一起使用。
- First
- 返回翻页器集合中的第一个翻页器。
- HasNext
- 报告当前分页器之后是否存在分页器。
- HasPrev
- 报告当前分页器之前是否存在分页器。
- Last
- 返回分页器集合中的最后一个分页器。
- Next
- 返回分页器集合中的下一个分页器。
- NumberOfElements
- 返回当前分页器中的页面数量。
- PageGroups
- 返回当前分页器中的页面组。
- PageNumber
- 返回分页器集合中当前分页器的编号。
- PagerSize
- 返回每页显示的页面数量。
- PageSize
- 返回每页分页器的页面数量。
- Prev
- 返回翻页器集合中的上一页翻页器。
- TotalNumberOfElements
- 返回分页器集合中的页面数量。
- TotalPages
- 返回分页器集合中的分页器数量。
- URL
- 返回当前分页器相对于站点根目录的 URL。
- 分页器
- 返回分页器集合。
- 页面
- 返回当前分页器中的页面。
Resource
使用这些方法处理全局、页面和远程资源对象。
- EXIF
- 适用于 JPEG、PNG、TIFF 和 WebP 图片，返回包含图像元数据的 EXIF 对象。
- RelPermalink
- 发布给定资源并返回其相对永久链接。
- 内容
- 返回给定资源的内容。
- 参数
- 返回在 front matter 中定义的资源参数映射。
- 发布
- 发布给定的资源。
- 名称
- 返回给定资源的名称，该名称可在前置内容中可选定义，否则回退到其文件路径。
- 填充
- 适用于图像，返回一个裁剪并调整大小到给定尺寸的图像资源。
- 处理
- 应用于图像，返回使用给定规范处理的图像资源。
- 媒体类型
- 返回给定资源的媒体类型对象。
- 宽度
- 适用于图像，返回给定资源的宽度。
- 数据
- 适用于 resources.GetRemote 函数返回的资源，返回 HTTP 响应中的信息。
- 标题
- 返回给定资源的标题，该标题可在前置内容中选择性地定义，根据资源类型回退到相对路径或哈希文件名。
- 永久链接
- 发布给定资源并返回其永久链接。
- 裁剪
- 适用于图像，返回一个裁剪到给定尺寸的图像资源，无需调整大小。
- 调整大小
- 适用于图像，返回调整为给定宽度和/或高度的图像资源。
- 资源类型
- 返回给定资源媒体类型的主类型。
- 过滤器
- 应用于图像，将一个或多个图像过滤器应用于给定的图像资源。
- 适应
- 适用于图像，返回一个缩小以适应给定尺寸的图像资源，同时保持纵横比。
- 错误处理
- 应用于 resources.GetRemote 函数返回的资源，如果 HTTP 请求失败则返回错误消息，否则返回 nil。
- 颜色
- 适用于图像，使用简单的直方图方法返回最主要颜色的切片。
- 高度
- 适用于图像，返回给定资源的高度。
Shortcode
在你的短代码模板中使用这些方法。
- InnerDeindent
- 返回起始和结束短代码标记之间的内容，并删除缩进，适用于短代码调用包含结束标记的情况。
- IsNamedParams
- 报告短代码调用是否使用命名参数。
- RelRef
- 返回具有给定路径、语言和输出格式的页面的相对 URL。
- 位置
- 返回调用短代码的文件名和位置。
- 内部内容
- 返回起始和结束短代码标签之间的内容，当短代码调用包含结束标签时适用。
- 参数
- 返回短代码参数的集合。
- 名称
- 返回短代码文件名，不包括文件扩展名。
- 存储
- 返回一个作用域限定于短代码的“临时存储区”以存储和处理数据。
- 序数
- 返回短代码相对于其父级的基于零的序数。
- 引用
- 返回具有给定路径、语言和输出格式的页面的绝对 URL。
- 暂存区
- 返回一个作用域限定于短代码的“暂存区”以存储和操作数据。
- 父级
- 在嵌套的短代码中返回父级短代码上下文。
- 站点
- 返回站点对象。
- 获取
- 返回给定参数的值。
- 页面
- 返回调用短代码的 Page 对象。
Site
使用这些方法处理站点对象。一个多语言项目将拥有两个或多个站点，每个语言一个。
- AllPages
- 返回所有语言中所有页面的集合。
- BuildDrafts
- 报告当前构建是否包含草稿页面。
- GetPage
- 从给定路径返回一个 Page 对象。
- IsMultiLingual
- 报告是否配置了两种或多种语言。
- LanguagePrefix
- 返回给定站点的 URL 语言前缀（如果有）。
- LastChange
- 返回站点内容的最后修改日期。
- Lastmod
- 返回站点内容的最后修改日期。
- site.Store
- 返回给定站点上的持久性“备忘录”以存储和操作数据。
- 主区段
- 返回站点配置中定义的主区段名称切片，如果未定义则回退到页面最多的顶级区段。
- 分类法
- 返回一个数据结构，其中包含站点的 Taxonomy 对象、每个 Taxonomy 对象中的术语以及分配了这些术语的页面。
- 参数
- 返回具有给定键的站点参数。
- 参数
- 返回站点配置中定义的自定义参数映射。
- 基URL
- 返回站点配置中定义的基URL。
- 常规页面
- 返回所有常规页面的集合。
- 数据
- 返回由数据目录中的文件组成的 数据结构。
- 标题
- 返回站点配置中定义的标题。
- 版权声明
- 返回站点配置中定义的版权声明。
- 站点
- 返回所有站点对象的集合，每个语言一个，按默认内容语言然后按语言权重排序。
- 节区
- 返回一级节区页面的集合。
- 菜单
- 返回给定站点的菜单对象集合。
- 语言
- 返回给定站点的语言对象。
- 语言
- 返回所有站点的语言对象集合，按语言权重排序。
- 配置
- 返回站点配置的子集。
- 页面
- 返回所有页面的集合。
- 首页
- 返回给定站点的首页对象。
Taxonomy
使用这些方法处理分类对象。
- ByCount
- 返回一个有序分类，按每个术语关联的页面数量排序。
- 按字母顺序排列
- 返回一个按术语字母顺序排序的有序分类。
- 获取
- 返回一个切片，其中包含已分配给给定术语的加权页面。
- 计数
- 返回已分配给给定术语的加权页面的数量。
- 页面
- 如果分类术语没有任何术语，则返回分类术语页面或 nil。
Time
使用这些方法处理 time.Time 值。
- Add (加法)
- 返回给定时间加上给定持续时间后的结果。
- AddDate函数
- 返回对应于将给定年份、月份和天数添加到给定 time.Time 值的时间。
- After
- 报告 TIME1 是否晚于 TIME2。
- IsZero
- 报告给定的 time.Time 值是否代表零时间点，即公元1年1月1日00:00:00 UTC。
- Round
- 返回自公元 0001 年 1 月 1 日 00:00:00 UTC 以来将 TIME 四舍五入到 DURATION 的最近倍数的结果。
- Unix 时间戳
- 返回给定 time.Time 值，表示自 1970 年 1 月 1 日协调世界时 (UTC) 以来的秒数。
- UnixMicro
- 返回给定 time.Time 值，表示自 1970 年 1 月 1 日 UTC 以来经过的微秒数。
- UnixNano
- 返回给定 time.Time 值，表示自 1970 年 1 月 1 日协调世界时 (UTC) 以来经过的纳秒数。
- Unix毫秒
- 返回给定 time.Time 值，表示自 1970 年 1 月 1 日 UTC 以来经过的毫秒数。
- UTC
- 返回具有设置为 UTC 位置的给定 time.Time 值。
- 之前
- 报告 TIME1 是否在 TIME2 之前。
- 减法
- 返回从 TIME1 减去 TIME2 计算出的持续时间。
- 分钟
- 返回给定 time.Time 值的小时内分钟偏移量，范围在 [0, 59] 之间。
- 天
- 返回给定 time.Time 值的月份中的天数。
- 小时
- 返回给定 time.Time 值在一天中的小时数，范围为 [0, 23]。
- 年中日
- 返回给定 time.Time 值的年中日，非闰年范围为 [1, 365]，闰年范围为 [1, 366]。
- 年份
- 返回给定 time.Time 值的年份。
- 截断
- 返回自公元 0001 年 1 月 1 日 00:00:00 UTC 起将 TIME 向下舍入到 DURATION 倍数的结果。
- 星期几
- 返回给定 time.Time 值的星期几。
- 是否为夏令时
- 报告给定的 time.Time 值是否处于夏令时。
- 月份
- 返回给定 time.Time 值的月份。
- 本地时间
- 返回给定的 time.Time 值，其位置设置为本地时间。
- 格式化
- 返回根据布局字符串格式化的 time.Time 值的文本表示形式。
- 秒
- 返回给定 time.Time 值的分钟内的第二个偏移量，范围为 [0, 59]。
- 等于
- 报告 TIME1 是否等于 TIME2。
- 纳秒
- 返回给定 time.Time 值在秒内以纳秒为单位的偏移量，范围为 [0, 999999999]。
菜单项
在您的菜单模板中使用这些方法。
- HasChildren
- 报告给定的菜单项是否包含子菜单项。
- KeyName
- 返回给定菜单条目的
identifier属性，如果不存在则回退到其name属性。 - pageRef
- 返回给定菜单项的
pageRef属性。 - URL
- 返回与给定菜单项关联的页面的相对永久链接，否则返回其
url属性。 - 参数
- 返回给定菜单条目的
params属性。 - 名称
- 返回给定菜单项的
name属性。 - 子菜单
- 返回给定菜单项下所有子菜单项的集合（如果有）。
- 文章
- 返回给定菜单项的
post属性。 - 权重
- 返回给定菜单条目的
weight属性。 - 标识符
- 返回给定菜单项的
identifier属性。 - 标题
- 返回给定菜单项的
title属性。 - 父级
- 返回给定菜单条目的
parent属性。 - 菜单
- 返回包含给定菜单条目的菜单的标识符。
- 页面
- 返回与给定菜单项关联的页面对象。
- 预渲染
- 返回给定菜单项的
pre属性。
页面
使用这些方法处理页面对象集合。
- ByDate
- 返回按日期升序排序的给定页面集合。
- ByExpiryDate
- 返回按过期日期升序排序的给定页面集合。
- ByLanguage
- 返回按语言升序排序的给定页面集合。
- ByLastmod
- 返回按上次修改日期（升序）排序的给定页面集合。
- ByLength
- 返回按内容长度升序排序的给定页面集合。
- ByLinkTitle
- 返回按链接标题升序排序的给定页面集合，如果未定义链接标题，则回退到标题。
- ByParam
- 返回按给定参数升序排序的页面集合。
- ByPublishDate
- 返回按发布日期升序排序的给定页面集合。
- ByTitle
- 按标题升序返回给定的页面集合。
- ByWeight
- 按权重升序返回给定的页面集合。
- GroupBy
- 返回按指定字段（升序）分组的页面集合。
- GroupByDate
- 按降序返回按日期分组的给定页面集合。
- GroupByExpiryDate
- 返回按失效日期降序分组的给定页面集合。
- GroupByLastmod
- 返回按最后修改日期降序排列的给定页面集合分组结果。
- GroupByParam
- 按升序返回按给定参数分组的页面集合。
- GroupByParamDate
- 返回按给定日期参数（降序）分组的页面集合。
- GroupByPublishDate
- 按发布日期降序返回给定的页面集合分组结果。
- Len
- 返回给定页面集合中的页面数量。
- Limit
- 返回给定页面集合中的前 N 个页面。
- 上一页
- 返回页面集合中相对于给定页面的上一页。
- 下一个
- 返回页面集合中相对于给定页面的下一页。
- 反转
- 以相反的顺序返回给定的页面集合。
- 相关页面
- 返回与给定页面相关的页面集合。