PAGE.Aliases ⟼ []string

Returns the URL aliases as defined in front matter. Read More »

PAGE.AllTranslations ⟼ page.Pages

Returns all translations of the given page, including the current language. Read More »

PAGE.AlternativeOutputFormats ⟼ page.OutputFormats

Returns a slice of OutputFormat objects, excluding the current output format, each representing one of the output formats enabled for the given page. Read More »

PAGE.Ancestors ⟼ page.Pages

Returns a collection of Page objects, one for each ancestor section of the given page. Read More »

PAGE.BundleType ⟼ string

Returns the bundle type of the given page, or an empty string if the page is not a page bundle. Read More »

PAGE.CodeOwners ⟼ []string

Returns of slice of code owners for the given page, derived from the CODEOWNERS file in the root of the project directory. Read More »

PAGE.Content ⟼ template.HTML

Returns the rendered content of the given page. Read More »

PAGE.ContentWithoutSummary ⟼ template.HTML

Returns the rendered content of the given page, excluding the content summary. Read More »

PAGE.CurrentSection ⟼ page.Page

Returns the Page object of the section in which the given page resides. Read More »

PAGE.Data ⟼ page.Data

Returns a unique data object for each page kind. Read More »

PAGE.Date ⟼ time.Time

Returns the date of the given page. Read More »

PAGE.Description ⟼ string

Returns the description of the given page as defined in front matter. Read More »

PAGE.Draft ⟼ bool

Reports whether the given page is a draft as defined in front matter. Read More »

PAGE1.Eq PAGE2 ⟼ bool

Reports whether two Page objects are equal. Read More »

PAGE.ExpiryDate ⟼ time.Time

Returns the expiry date of the given page. Read More »

PAGE.File ⟼ hugolib.fileInfo

For pages backed by a file, returns file information for the given page. Read More »

PAGE.FirstSection ⟼ page.Page

Returns the Page object of the top level section of which the given page is a descendant. Read More »

PAGE.Fragments ⟼ tableofcontents.Fragments

Returns a data structure of the fragments in the given page. Read More »

PAGE.FuzzyWordCount ⟼ int

Returns the number of words in the content of the given page, rounded up to the nearest multiple of 100. Read More »

PAGE.GetPage PATH ⟼ page.Page

Returns a Page object from the given path. Read More »

PAGE.GetTerms TAXONOMY ⟼ page.Pages

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. Read More »

PAGE.GitInfo ⟼ source.GitInfo

Returns Git information related to the last commit of the given page. Read More »

PAGE.HasMenuCurrent MENU MENUENTRY ⟼ bool

Reports whether the given Page object matches the Page object associated with one of the child menu entries under the given menu entry in the given menu. Read More »

PAGE.HasShortcode NAME ⟼ bool

Reports whether the given shortcode is called by the given page. Read More »

PAGE.HeadingsFiltered ⟼ tableofcontents.Headings

Returns a slice of headings for each page related to the given page. Read More »

PAGE.InSection SECTION ⟼ bool

Reports whether the given page is in the given section. Read More »

PAGE1.IsAncestor PAGE2 ⟼ bool

Reports whether PAGE1 is an ancestor of PAGE2. Read More »

PAGE1.IsDescendant PAGE2 ⟼ bool

Reports whether PAGE1 is a descendant of PAGE2. Read More »

PAGE.IsHome ⟼ bool

Reports whether the given page is the home page. Read More »

PAGE.IsMenuCurrent MENU MENUENTRY ⟼ bool

Reports whether the given Page object matches the Page object associated with the given menu entry in the given menu. Read More »

PAGE.IsNode ⟼ bool

Reports whether the given page is a node. Read More »

PAGE.IsPage ⟼ bool

Reports whether the given page is a regular page. Read More »

PAGE.IsSection ⟼ bool

Reports whether the given page is a section page. Read More »

PAGE.IsTranslated ⟼ bool

Reports whether the given page has one or more translations. Read More »

PAGE.Keywords ⟼ []string

Returns a slice of keywords as defined in front matter. Read More »

PAGE.Kind ⟼ string

Returns the kind of the given page. Read More »

PAGE.Language ⟼ langs.Language

Returns the language object for the given page. Read More »

PAGE.Lastmod ⟼ time.Time

Returns the last modification date of the given page. Read More »

PAGE.Layout ⟼ string

Returns the layout for the given page as defined in front matter. Read More »

PAGE.Len ⟼ int

Returns the length, in bytes, of the rendered content of the given page. Read More »

PAGE.LinkTitle ⟼ string

Returns the link title of the given page. Read More »

PAGE.Next ⟼ page.Page

Returns the next page in a site’s collection of regular pages, relative to the current page. Read More »

PAGE.NextInSection ⟼ page.Page

Returns the next regular page in a section, relative to the given page. Read More »

PAGE.OutputFormats ⟼ []OutputFormat

Returns a slice of OutputFormat objects, each representing one of the output formats enabled for the given page. Read More »

PAGE.Page ⟼ page.Page

Returns the Page object of the given page. Read More »

PAGE.Store ⟼ maps.Scratch

Returns a persistent “scratch pad” on the given page to store and manipulate data. Read More »

PAGE.Pages ⟼ page.Pages

Returns a collection of regular pages within the current section, and section pages of immediate descendant sections. Read More »

PAGE.Paginate COLLECTION [N] ⟼ page.Pager

Paginates a collection of pages. Read More »

PAGE.Paginator ⟼ page.Pager

Paginates the collection of regular pages received in context. Read More »

PAGE.Param KEY ⟼ any

Returns a page parameter with the given key, falling back to a site parameter if present. Read More »

PAGE.Params ⟼ maps.Params

Returns a map of custom parameters as defined in the front matter of the given page. Read More »

PAGE.Parent ⟼ page.Page

Returns the Page object of the parent section of the given page. Read More »

PAGE.Path ⟼ string

Returns the logical path of the given page. Read More »

PAGE.Permalink ⟼ string

Returns the permalink of the given page. Read More »

PAGE.Plain ⟼ string

Returns the rendered content of the given page, removing all HTML tags. Read More »

PAGE.PlainWords ⟼ []string

Calls the Plain method, splits the result into a slice of words, and returns the slice. Read More »

PAGE.Prev ⟼ page.Page

Returns the previous page in a site’s collection of regular pages, relative to the current page. Read More »

PAGE.PrevInSection ⟼ page.Page

Returns the previous regular page in a section, relative to the given page. Read More »

PAGE.PublishDate ⟼ time.Time

Returns the publish date of the given page. Read More »

PAGE.RawContent ⟼ string

Returns the raw content of the given page. Read More »

PAGE.ReadingTime ⟼ int

Returns the estimated reading time, in minutes, for the given page. Read More »

PAGE.Ref OPTIONS ⟼ string

Returns the absolute URL of the page with the given path, language, and output format. Read More »

PAGE.RegularPages ⟼ page.Pages

Returns a collection of regular pages within the current section. Read More »

PAGE.RegularPagesRecursive ⟼ page.Pages

Returns a collection of regular pages within the current section, and regular pages within all descendant sections. Read More »

PAGE.RelPermalink ⟼ string

Returns the relative permalink of the given page. Read More »

PAGE.RelRef OPTIONS ⟼ string

Returns the relative URL of the page with the given path, language, and output format. Read More »

PAGE.Render NAME ⟼ template.HTML

Renders the given template with the given page as context. Read More »

PAGE.RenderShortcodes ⟼ template.HTML

Renders all shortcodes in the content of the given page, preserving the surrounding markup. Read More »

PAGE.RenderString [OPTIONS] MARKUP ⟼ template.HTML

Renders markup to HTML. Read More »

PAGE.Resources ⟼ resource.Resources

Returns a collection of page resources. Read More »

PAGE.Scratch ⟼ maps.Scratch

Returns a “scratch pad” on the given page to store and manipulate data. Read More »

PAGE.Section ⟼ string

Returns the name of the top level section in which the given page resides. Read More »

PAGE.Sections ⟼ page.Pages

Returns a collection of section pages, one for each immediate descendant section of the given page. Read More »

PAGE.Site ⟼ page.siteWrapper

Returns the Site object. Read More »

PAGE.Sitemap ⟼ config.SitemapConfig

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. Read More »

PAGE.Sites ⟼ page.Sites

Returns a collection of all Site objects, one for each language, ordered by language weight. Read More »

PAGE.Slug ⟼ string

Returns the URL slug of the given page as defined in front matter. Read More »

PAGE.Summary ⟼ template.HTML

Returns the summary of the given page. Read More »

PAGE.TableOfContents ⟼ template.HTML

Returns a table of contents for the given page. Read More »

PAGE.Title ⟼ string

Returns the title of the given page. Read More »

PAGE.TranslationKey ⟼ string

Returns the translation key of the given page. Read More »

PAGE.Translations ⟼ page.Pages

Returns all translations of the given page, excluding the current language. Read More »

PAGE.Truncated ⟼ bool

Reports whether the content length exceeds the summary length. Read More »

PAGE.Type ⟼ string

Returns the content type of the given page. Read More »

PAGE.Weight ⟼ int

Returns the weight of the given page as defined in front matter. Read More »

PAGE.WordCount ⟼ int

Returns the number of words in the content of the given page. Read More »