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