方法
Hugo 方法的快速参考指南，按对象分组。
Duration
将这些方法与 time.Duration 值一起使用。
- Abs
- 返回给定 time.Duration 值的绝对值。
- Hours
- 将 time.Duration 值作为浮点数小时数返回。
- Microseconds
- 将 time.Duration 值作为整数微秒数返回。
- Milliseconds
- 将 time.Duration 值作为整数毫秒数返回。
- Minutes
- 将 time.Duration 值作为浮点数分钟数返回。
- Nanoseconds
- 将 time.Duration 值作为整数纳秒数返回。
- Round
- 返回将 DURATION1 舍入到最接近的 DURATION2 倍数的结果。
- Seconds
- 将 time.Duration 值作为浮点数秒数返回。
- Truncate
- 返回将 DURATION1 向零舍入到 DURATION2 倍数的结果。
Menu
在遍历菜单项时使用这些方法。
- ByName
- 返回给定菜单，其条目按名称排序。
- ByWeight
- 返回给定菜单，其条目按权重、然后按名称、然后按标识符排序。
- Limit
- 返回给定菜单，限制为前 N 个条目。
- Reverse
- 返回给定菜单，反转其条目的排序顺序。
Menu entry
在菜单模板中使用这些方法。
- Children
- 返回给定菜单项下的子菜单项集合（如果有）。
- HasChildren
- 报告给定菜单项是否有子菜单项。
- Identifier
- 返回给定菜单项的
identifier属性。 - KeyName
- 返回给定菜单项的
identifier属性，回退到其name属性。 - 返回包含给定菜单项的菜单的标识符。
- Name
- 返回给定菜单项的
name属性。 - Page
- 返回与给定菜单项关联的页面对象。
- PageRef
- 返回给定菜单项的
pageRef属性。 - Params
- 返回给定菜单项的
params属性。 - Parent
- 返回给定菜单项的
parent属性。 - Post
- 返回给定菜单项的
post属性。 - Pre
- 返回给定菜单项的
pre属性。 - Title
- 返回给定菜单项的
title属性。 - URL
- 返回与给定菜单项关联的页面的相对永久链接，否则返回其
url属性。 - Weight
- 返回给定菜单项的
weight属性。
Output format
在 OutputFormat 对象上使用这些方法。
- MediaType
- 返回给定输出格式的媒体类型。
- Name
- 返回给定输出格式的标识符。
- Permalink
- 返回当前输出格式生成的页面的永久链接。
- Rel
- 返回给定输出格式的 rel 值，要么是默认值，要么是在站点配置中定义的。
- RelPermalink
- 返回当前输出格式生成的页面的相对永久链接。
Page
在 Page 对象上使用这些方法。
- Aliases
- 返回 front matter 中定义的别名作为服务器相对 URL，根据当前内容维度解析。
- AllTranslations
- 返回给定页面的所有翻译，包括当前语言，按语言权重排序。
- AlternativeOutputFormats
- 返回 OutputFormat 对象的切片，不包括当前输出格式，每个代表为给定页面启用的一个输出格式。
- Ancestors
- 返回 Page 对象的集合，每个代表给定页面的一个祖先栏目。
- BundleType
- 返回给定页面的捆绑包类型，如果页面不是页面捆绑包则返回空字符串。
- CodeOwners
- 返回给定页面的代码所有者切片，从项目目录根目录中的 CODEOWNERS 文件派生。
- Content
- 返回给定页面的渲染内容。
- ContentWithoutSummary
- 返回给定页面的渲染内容，不包括内容摘要。
- CurrentSection
- 返回给定页面所在栏目的 Page 对象。
- Data
- 为每种页面类型返回唯一的数据对象。
- Date
- 返回给定页面的日期。
- Description
- 返回 front matter 中定义的给定页面的描述。
- Draft
- 报告给定页面是否为 front matter 中定义的草稿。
- Eq
- 报告两个 Page 对象是否相等。
- ExpiryDate
- 返回给定页面的过期日期。
- File
- 对于有文件支持的页面，返回给定页面的文件信息。
- FirstSection
- 返回给定页面为其后代的顶层栏目的 Page 对象。
- Fragments
- 返回给定页面中片段的数据结构。
- FuzzyWordCount
- Returns the number of words in the content of the given page, rounded up to the nearest multiple of 100.
- GetPage
- Returns a Page object from the given path.
- GetTerms
- Returns a collection of term pages for terms defined on the given page in the given taxonomy, ordered according to the sequence in which they appear in front matter.
- GitInfo
- 返回与给定页面最后一次提交相关的 Git 信息。
- 报告给定 Page 对象是否与给定菜单中给定菜单条目下的子菜单条目关联的 Page 对象匹配。
- HasShortcode
- Reports whether the given shortcode is called by the given page.
- HeadingsFiltered
- Returns a slice of headings for each page related to the given page.
- InSection
- Reports whether the given page is in the given section.
- IsAncestor
- 报告 PAGE1 是否是 PAGE2 的祖先。
- IsDescendant
- 报告 PAGE1 是否是 PAGE2 的后代。
- IsHome
- 报告给定页面是否是主页。
- 报告给定 Page 对象是否与给定菜单中给定菜单条目关联的 Page 对象匹配。
- IsNode
- 报告给定页面是否是节点页面。
- IsPage
- 报告给定页面是否是常规页面。
- IsSection
- 报告给定页面是否是栏目页面。
- IsTranslated
- Reports whether the given page has one or more translations.
- Keywords
- 返回 front matter 中定义的关键词切片。
- Kind
- Returns the kind of the given page.
- Language
- Returns the language object for the given page.
- Lastmod
- 返回给定页面的最后修改日期。
- Layout
- 返回 front matter 中定义的给定页面的布局。
- Len
- 返回给定页面的渲染内容的长度（以字节为单位）。
- LinkTitle
- 返回给定页面的链接标题。
- Next
- 返回站点常规页面集合中相对于当前页面的下一个页面。
- NextInSection
- 返回当前栏目中相对于给定页面的下一个常规页面。
- OutputFormats
- 返回 OutputFormat 对象的切片，每个代表为给定页面启用的输出格式之一。
- Page
- 返回给定页面的 Page 对象。
- Pages
- 返回当前栏目内的常规页面集合，以及直接后代栏目的栏目页面。
- Paginate
- 分页页面集合。
- Paginator
- 分页上下文中接收的常规页面集合。
- Param
- 返回具有给定键的页面参数，如果存在则回退到站点参数。
- Params
- 返回给定页面 front matter 中定义的自定义参数映射。
- Parent
- 返回给定页面的父栏目的 Page 对象。
- Path
- 返回给定页面的逻辑路径。
- Permalink
- 返回给定页面的永久链接。
- Plain
- 返回给定页面的渲染内容，移除所有 HTML 标签。
- PlainWords
- 调用 Plain 方法，将结果分割成单词切片，并返回该切片。
- Prev
- 返回站点常规页面集合中相对于当前页面的上一个页面。
- PrevInSection
- 返回当前栏目中相对于给定页面的上一个常规页面。
- PublishDate
- 返回给定页面的发布日期。
- RawContent
- 返回给定页面的原始内容。
- ReadingTime
- 返回给定页面的估计阅读时间（以分钟为单位）。
- Ref
- 返回具有给定路径、语言和输出格式的页面的绝对 URL。
- RegularPages
- 返回当前栏目内的常规页面集合。
- RegularPagesRecursive
- Returns a collection of regular pages within the current section, and regular pages within all descendant sections.
- RelPermalink
- 返回给定页面的相对永久链接。
- RelRef
- 返回具有给定路径、语言和输出格式的页面的相对 URL。
- Render
- Renders the given template with the given page as context.
- RenderShortcodes
- 渲染给定页面内容中的所有短代码，保留周围的标记。
- RenderString
- Renders markup to HTML.
- Resources
- 返回页面资源的集合。
- Rotate
- Returns a collection of all pages sharing the same identity across the specified dimension, including the current page, sorted by the dimension's weight.
- Scratch
- Returns a "scratch pad" to store and manipulate data, scoped to the current page.
- Section
- 返回给定页面所在的顶级栏目的名称。
- Sections
- Returns a collection of section pages, one for each immediate descendant section of the given page.
- Site
- 返回 Site 对象。
- Sitemap
- Returns the sitemap settings for the given page as defined in front matter, falling back to the sitemap settings as defined in the site configuration.
- Sites
- Returns a collection of all Site objects, one for each language, ordered by language weight.
- Slug
- 返回给定页面在 front matter 中定义的 URL slug。
- Store
- Returns a "scratch pad" to store and manipulate data, scoped to the current page.
- Summary
- 返回给定页面的摘要。
- TableOfContents
- 返回给定页面的目录。
- Title
- 返回给定页面的标题。
- TranslationKey
- 返回给定页面的翻译键。
- Translations
- Returns all translations of the given page, excluding the current language, sorted by language weight.
- Truncated
- 报告内容长度是否超过摘要长度。
- Type
- 返回给定页面的内容类型。
- Weight
- 返回给定页面在 front matter 中定义的权重。
- WordCount
- Returns the number of words in the content of the given page.
Pager
在构建分页列表页面的导航时，在 Pager 对象上使用这些方法。
- First
- 返回分页器集合中的第一个分页器。
- HasNext
- 报告当前分页器之后是否有分页器。
- Last
- 返回分页器集合中的最后一个分页器。
- Next
- 返回分页器集合中的下一个分页器。
- NumberOfElements
- 返回当前分页器中的页面数量。
- PageGroups
- 返回当前分页器中的页面分组。
- PageNumber
- 返回当前分页器在分页器集合中的编号。
- Pagers
- 返回分页器集合中的所有分页器。
- PagerSize
- 返回每个分页器中的页面数量。
- Pages
- 返回当前分页器中的页面。
- PageSize
- 返回每个分页器的页面数量。
- Prev
- 返回分页器集合中的上一个分页器。
- TotalNumberOfElements
- 返回分页器集合中的页面数量。
- TotalPages
- 返回分页器集合中的分页器数量。
- URL
- 返回当前分页器相对于站点根目录的 URL。
Pages
将这些方法与 Page 对象集合一起使用。
- ByDate
- 返回给定页面集合按日期升序排序。
- ByExpiryDate
- 返回给定页面集合按过期日期升序排序。
- ByLanguage
- 返回给定页面集合按语言升序排序。
- ByLastmod
- 返回给定页面集合按最后修改日期升序排序。
- ByLength
- 返回给定页面集合按内容长度升序排序。
- ByLinkTitle
- 返回给定页面集合按链接标题升序排序，如果未定义链接标题则回退到标题。
- ByParam
- 返回给定页面集合按给定参数升序排序。
- ByPublishDate
- 返回给定页面集合按发布日期升序排序。
- ByTitle
- 返回给定页面集合按标题升序排序。
- ByWeight
- 返回给定页面集合按权重升序排序。
- GroupBy
- 返回给定页面集合按给定字段升序分组。
- GroupByDate
- 返回给定页面集合按日期降序分组。
- GroupByExpiryDate
- 返回给定页面集合按过期日期降序分组。
- GroupByLastmod
- 返回给定页面集合按最后修改日期降序分组。
- GroupByParam
- 返回给定页面集合按给定参数升序分组。
- GroupByParamDate
- 返回给定页面集合按给定日期参数降序分组。
- GroupByPublishDate
- 返回给定页面集合按发布日期降序分组。
- Len
- 返回给定页面集合中的页面数量。
- Limit
- 返回给定页面集合中的前 N 个页面。
- Next
- 返回页面集合中给定页面的下一个页面。
- Prev
- 返回页面集合中给定页面的上一个页面。
- 返回与给定页面相关的页面集合。
- Reverse
- 返回给定页面集合的逆序。
Resource
将这些方法与全局、页面和远程 Resource 对象一起使用。
- Colors
- 适用于图像，返回使用简单直方图方法的最主导颜色切片。
- Content
- 返回给定资源的内容。
- Crop
- 适用于图像，返回根据给定处理规格裁剪的新图像资源。
- Data
- 适用于 resources.GetRemote 函数返回的资源，返回来自 HTTP 响应的信息。
- Err
- 适用于 resources.GetRemote 函数返回的资源，如果 HTTP 请求失败则返回错误消息，否则返回 nil。
- Exif
- 适用于 JPEG、PNG、TIFF 和 WebP 图像，返回包含 Exif 元数据的对象。
- Fill
- 适用于图像，返回根据给定处理规格裁剪和调整大小的新图像资源。
- Filter
- 适用于图像，将一个或多个图像滤镜应用于给定图像资源。
- Fit
- 适用于图像，返回根据给定处理规格缩小以适应的新图像资源。
- Height
- 适用于图像，返回给定资源的高度。
- MediaType
- 返回给定资源的媒体类型对象。
- Meta
- 适用于 JPEG、PNG、TIFF 和 WebP 图像，返回包含 Exif、IPTC 和 XMP 元数据的对象。
- Name
- 返回给定资源的名称，如 front matter 中所定义，或回退到其文件路径。
- Params
- 返回 front matter 中定义的资源参数映射。
- Permalink
- 发布给定资源并返回其永久链接。
- Process
- 适用于图像，返回根据给定处理规格处理的新图像资源。
- Publish
- 发布给定的资源。
- RelPermalink
- 发布给定的资源并返回其相对永久链接。
- Resize
- 适用于图像，返回根据给定处理规格调整大小的新图像资源。
- ResourceType
- 返回给定资源的媒体类型的主类型。
- Title
- 返回给定资源的标题（如在 front matter 中所定义），或回退到相对路径或哈希文件名，具体取决于资源类型。
- Width
- 适用于图像，返回给定资源的宽度。
Shortcode
在您的 shortcode 模板中使用这些方法。
- Get
- 返回给定参数的值。
- Inner
- 返回 shortcode 开始和结束标签之间的内容，适用于 shortcode 调用包含结束标签的情况。
- InnerDeindent
- 返回 shortcode 开始和结束标签之间的内容，并移除缩进，适用于 shortcode 调用包含结束标签的情况。
- IsNamedParams
- 报告 shortcode 调用是否使用命名参数。
- Name
- 返回 shortcode 文件名，不包括文件扩展名。
- Ordinal
- 返回 shortcode 相对于其父级的从零开始的序号。
- Page
- 返回调用 shortcode 的页面对象。
- Params
- 返回 shortcode 参数的集合。
- Parent
- 在嵌套 shortcode 中返回父 shortcode 上下文。
- Position
- 返回调用 shortcode 的文件名和位置。
- Ref
- 返回具有给定路径、语言和输出格式的页面的绝对 URL。
- RelRef
- 返回具有给定路径、语言和输出格式的页面的相对 URL。
- Scratch
- 返回一个"暂存板"来存储和操作数据，作用域为当前 shortcode。
- Site
- 返回站点对象。
- Store
- 返回一个"暂存板"来存储和操作数据，作用域为当前 shortcode。
Time
将这些方法与 time.Time 值一起使用。
- Add
- 返回给定时间加上给定持续时间的结果。
- AddDate
- 返回将给定数量的年、月和日添加到给定 time.Time 值后对应的时间。
- After
- 报告 TIME1 是否在 TIME2 之后。
- Before
- 报告 TIME1 是否在 TIME2 之前。
- Day
- 返回给定 time.Time 值的月份中的日期。
- Equal
- 报告 TIME1 是否等于 TIME2。
- Format
- 返回根据布局字符串格式化的 time.Time 值的文本表示。
- Hour
- 返回给定 time.Time 值在一天中的小时，范围为 [0, 23]。
- IsDST
- 报告给定 time.Time 值是否处于夏令时。
- IsZero
- 报告给定 time.Time 值是否表示零时间瞬间，即公元 1 年 1 月 1 日 00:00:00 UTC。
- Local
- 返回将位置设置为本地时间的给定 time.Time 值。
- Minute
- 返回给定 time.Time 值在小时内的分钟偏移，范围为 [0, 59]。
- Month
- 返回给定 time.Time 值的年份中的月份。
- Nanosecond
- 返回给定 time.Time 值在秒内的纳秒偏移，范围为 [0, 999999999]。
- Round
- 返回将 TIME 四舍五入到自公元 1 年 1 月 1 日 00:00:00 UTC 以来的 DURATION 的最近倍数的结果。
- Second
- 返回给定 time.Time 值在分钟内的秒偏移，范围为 [0, 59]。
- Sub
- 返回通过从 TIME1 减去 TIME2 计算得出的持续时间。
- Truncate
- 返回将 TIME 向下舍入到自公元 1 年 1 月 1 日 00:00:00 UTC 以来的 DURATION 的倍数的结果。
- Unix
- 返回给定 time.Time 值表示为自 1970 年 1 月 1 日 UTC 以来的秒数。
- UnixMicro
- 返回给定 time.Time 值表示为自 1970 年 1 月 1 日 UTC 以来的微秒数。
- UnixMilli
- 返回给定 time.Time 值表示为自 1970 年 1 月 1 日 UTC 以来的毫秒数。
- UnixNano
- 返回给定 time.Time 值表示为自 1970 年 1 月 1 日 UTC 以来的纳秒数。
- UTC
- 返回将位置设置为 UTC 的给定 time.Time 值。
- Weekday
- 返回给定 time.Time 值的星期几。
- Year
- 返回给定 time.Time 值的年份。
- YearDay
- 返回给定 time.Time 值在一年中的第几天，非闰年范围为 [1, 365]，闰年范围为 [1, 366]。
分类法
将这些方法与分类法对象一起使用。
- Alphabetical
- 返回按术语字母顺序排序的有序分类法。
- ByCount
- 返回按与每个术语关联的页面数量排序的有序分类法。
- Count
- 返回给定术语被分配到的加权页面数量。
- Get
- 返回给定术语被分配到的加权页面切片。
- Page
- 返回分类法页面，如果分类法没有术语则返回 nil。
站点
将这些方法与站点对象一起使用。
- AllPages
- 返回所有语言中所有页面的集合。
- BaseURL
- 返回站点配置中定义的基础 URL。
- BuildDrafts
- 报告当前构建是否包含草稿页面。
- Config
- 返回站点配置的一个子集。
- Copyright
- 返回站点配置中定义的版权声明。
- Data
- 返回由 data 目录中的文件组成的数据结构。
- Dimension
- 返回给定站点的给定维度的维度对象。
- GetPage
- 返回给定路径的页面对象。
- Home
- 返回给定站点的主页页面对象。
- Language
- 返回给定站点的语言对象。
- LanguagePrefix
- 返回给定站点的 URL 语言前缀（如果有）。
- Languages
- 返回所有站点的语言对象集合，按语言权重排序。
- Lastmod
- 返回站点内容的最后修改日期。
- MainSections
- 返回站点配置中定义的主节名称切片，回退到具有最多页面的顶级节。
- 返回给定站点的菜单对象集合。
- Pages
- 返回所有页面的集合。
- Param
- 返回给定键的站点参数。
- Params
- 返回站点配置中定义的自定义参数映射。
- RegularPages
- 返回所有常规页面的集合。
- Role
- 返回给定站点的角色对象。
- Sections
- 返回顶级节页面的集合。
- Sites
- 返回所有站点对象的集合，每个语言一个，按默认内容语言和语言权重排序。
- Store
- 返回一个"暂存板"来存储和操作数据，作用域为当前站点。
- Taxonomies
- 返回一个数据结构，包含站点的分类法对象、每个分类法对象中的术语以及分配给这些术语的页面。
- Title
- 返回站点配置中定义的标题。
- Version
- 返回给定站点的版本对象。