SHORTCODE.Get ARG ⟼ any

Returns the value of the given argument. Read More »

SHORTCODE.Inner ⟼ template.HTML

Returns the content between opening and closing shortcode tags, applicable when the shortcode call includes a closing tag. Read More »

SHORTCODE.InnerDeindent ⟼ template.HTML

Returns the content between opening and closing shortcode tags, with indentation removed, applicable when the shortcode call includes a closing tag. Read More »

SHORTCODE.IsNamedParams ⟼ bool

Reports whether the shortcode call uses named arguments. Read More »

SHORTCODE.Name ⟼ string

Returns the shortcode file name, excluding the file extension. Read More »

SHORTCODE.Ordinal ⟼ int

Returns the zero-based ordinal of the shortcode in relation to its parent. Read More »

SHORTCODE.Page ⟼ hugolib.pageForShortcode

Returns the Page object from which the shortcode was called. Read More »

SHORTCODE.Params ⟼ any

Returns a collection of the shortcode arguments. Read More »

SHORTCODE.Parent ⟼ hugolib.ShortcodeWithPage

Returns the parent shortcode context in nested shortcodes. Read More »

SHORTCODE.Position ⟼ text.Position

Returns the filename and position from which the shortcode was called. Read More »

SHORTCODE.Ref OPTIONS ⟼ string

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

SHORTCODE.RelRef OPTIONS ⟼ string

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

SHORTCODE.Scratch ⟼ maps.Scratch

Returns a “scratch pad” scoped to the shortcode to store and manipulate data. Read More »

SHORTCODE.Site ⟼ page.siteWrapper

Returns the Site object. Read More »

SHORTCODE.Store ⟼ maps.Store

Returns a “Store pad” scoped to the shortcode to store and manipulate data. Read More »