文档章节

Page 方法

在 Page 对象上使用这些方法。

本章内容

  • Aliases 返回前置元数据中定义的别名,形式为服务器相对 URL,并按当前内容维度解析。 (今天)
  • AllTranslations 返回给定页面的全部翻译版本(含当前语言),先按语言权重、再按语言名称排序。 (今天)
  • AlternativeOutputFormats 返回 OutputFormat 对象切片,其中不含当前输出格式,每项代表该页面启用的一个输出格式。 (今天)
  • Ancestors 返回 Page 对象集合,给定页面的每一级祖先 section 各对应一个对象。 (今天)
  • BundleType 返回给定页面的页面包类型;若该页面不是页面包,则返回空字符串。 (今天)
  • CodeOwners 返回给定页面的代码所有者切片,数据来自项目目录根部的 CODEOWNERS 文件。 (今天)
  • Content 返回给定页面渲染后的内容。 (今天)
  • ContentWithoutSummary 返回给定页面渲染后的内容,但不含内容摘要。 (今天)
  • CurrentSection 返回给定页面所在 section 的 Page 对象。 (今天)
  • Data 为每种页面种类返回各自特有的数据对象。 (今天)
  • Date 返回给定页面的日期。 (今天)
  • Description 返回前置元数据中定义的页面描述。 (今天)
  • Draft 报告给定页面在前置元数据中是否被标记为草稿。 (今天)
  • Eq 报告两个 Page 对象是否相等。 (今天)
  • ExpiryDate 返回给定页面的过期日期。 (今天)
  • File 返回给定页面的文件信息;若该页面没有对应文件,则返回 nil。 (今天)
  • FirstSection 返回给定页面所属顶层 section 的 Page 对象。 (今天)
  • Fragments 返回给定页面中片段的数据结构。 (今天)
  • FuzzyWordCount 返回给定页面内容的单词数,向上取整到最接近的 100 的倍数。 (今天)
  • GetPage 根据给定路径返回 Page 对象。 (今天)
  • GetTerms 返回给定页面在指定分类法中定义的术语所对应的术语页集合,顺序与它们在前置元数据中出现的先后一致。 (今天)
  • GitInfo 返回给定页面的提交元数据。 (今天)
  • HasMenuCurrent 报告给定 Page 对象是否匹配某个菜单项下的子菜单项所关联的 Page 对象。 (今天)
  • HasShortcode 报告给定页面是否调用了指定的短代码。 (今天)
  • HeadingsFiltered 返回与给定页面相关的每个页面的标题切片。 (今天)
  • InSection 报告给定页面是否位于给定 section 中。 (今天)
  • IsAncestor 报告 PAGE1 是否为 PAGE2 的祖先。 (今天)
  • IsBranch 报告给定页面是否为一个分支包。 (今天)
  • IsDescendant 报告 PAGE1 是否为 PAGE2 的后代。 (今天)
  • IsHome 报告给定页面是否为首页。 (今天)
  • IsMenuCurrent 报告给定 Page 对象是否匹配指定菜单中某个菜单项所关联的 Page 对象。 (今天)
  • IsNode 报告给定页面是否为一个分支包。 (今天)
  • IsPage 报告给定页面是否为常规页面。 (今天)
  • IsSection 报告给定页面是否为 section 页面。 (今天)
  • IsTranslated 报告给定页面是否有一个或多个翻译版本。 (今天)
  • Keywords 返回前置元数据中定义的关键词切片。 (今天)
  • Kind 返回给定页面的种类。 (今天)
  • Language 返回给定页面的 Language 对象。 (今天)
  • Lastmod 返回给定页面的最后修改日期。 (今天)
  • Layout 返回前置元数据中定义的页面布局。 (今天)
  • Len 返回给定页面渲染后内容的长度(字节数)。 (今天)
  • LinkTitle 返回给定页面的链接标题。 (今天)
  • Next 返回站点常规页面集合中相对于当前页面的下一个页面。 (今天)
  • NextInSection 返回某个 section 中相对于给定页面的下一个常规页面。 (今天)
  • OutputFormats 返回一组 OutputFormat 对象,每个对象对应该页面已启用的一种输出格式。 (今天)
  • Page 返回给定页面的 Page 对象。 (今天)
  • Pages 返回当前 section 内的常规页面集合,以及直属子 section 的 section 页面。 (今天)
  • Paginate 返回对给定页面集合分页后得到的分页器。 (今天)
  • Paginator 返回对上下文中收到的常规页面集合分页后得到的分页器。 (今天)
  • Param 返回具有给定 key 的页面参数;若页面中没有,则回退到站点参数。 (今天)
  • Params 返回给定页面前置元数据中定义的自定义参数映射。 (今天)
  • Parent 返回给定页面所属父 section 的 Page 对象。 (今天)
  • Path 返回给定页面的逻辑路径。 (今天)
  • Permalink 返回给定页面的永久链接。 (今天)
  • Plain 返回给定页面渲染后的内容,并移除所有 HTML 标签。 (今天)
  • PlainWords 返回一个单词切片,由调用 Plain 方法并拆分其结果得到。 (今天)
  • Prev 返回站点常规页面集合中相对于当前页面的上一个页面。 (今天)
  • PrevInSection 返回某个 section 中相对于给定页面的上一个常规页面。 (今天)
  • PublishDate 返回给定页面的发布日期。 (今天)
  • RawContent 返回给定页面的原始内容。 (今天)
  • ReadingTime 返回给定页面的预估阅读时间(以分钟计)。 (今天)
  • Ref 返回具有给定路径、语言和输出格式的页面的绝对 URL。 (今天)
  • RegularPages 返回当前 section 内的常规页面集合。 (今天)
  • RegularPagesRecursive 返回当前 section 内的常规页面集合,以及所有后代 section 内的常规页面。 (今天)
  • RelPermalink 返回给定页面的相对永久链接。 (今天)
  • RelRef 返回具有给定路径、语言和输出格式的页面的相对 URL。 (今天)
  • Render 以给定页面为上下文、或使用可选的上下文参数渲染视图模板,并返回结果。 (今天)
  • RenderShortcodes 返回给定页面的内容,其中所有短代码都已渲染,同时保留其周围的标记。 (今天)
  • RenderString 把给定的标记语言渲染为 HTML 并返回。 (今天)
  • Resources 返回页面资源集合。 (今天)
  • Rotate 返回沿指定维度变化、而在其他维度上与当前页面取值相同的一组页面(含当前页面),并按该维度的默认排序顺序排列。 (今天)
  • Scratch 返回一个持久化的数据结构,用于存储和操作带 key 的值,作用域为当前页面。 (今天)
  • Section 返回给定页面所属顶层 section 的名称。 (今天)
  • Sections 返回 section 页面集合,给定页面的每一个直属子 section 对应一个页面。 (今天)
  • Site 返回 Site 对象。 (今天)
  • Sitemap 返回给定页面的 sitemap 设置:取自前置元数据,若没有则回退到项目配置中定义的 sitemap 设置。 (今天)
  • Sites 返回所有维度的所有站点组成的集合。 (今天)
  • Slug 返回给定页面前置元数据中定义的 URL slug。 (今天)
  • Store 返回一个持久化的数据结构,用于存储和操作带 key 的值,作用域为当前页面。 (今天)
  • Summary 返回给定页面的摘要。 (今天)
  • TableOfContents 返回给定页面的目录。 (今天)
  • Title 返回给定页面的标题。 (今天)
  • TranslationKey 返回给定页面的翻译 key。 (今天)
  • Translations 返回给定页面的所有译文(不含当前语言),按语言权重再按语言名称排序。 (今天)
  • Truncated 报告内容长度是否超过摘要长度。 (今天)
  • Type 返回给定页面的内容类型。 (今天)
  • Weight 返回给定页面前置元数据中定义的权重。 (今天)
  • WordCount 返回给定页面内容中的单词数。 (今天)