方法
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
- 返回給定站點的版本對象。