hugo/docs/content/functions/ref.md

955 B

title linktitle description godocref date publishdate lastmod categories menu signature workson hugoversion relatedfuncs deprecated aliases
ref ref Looks up a content page by logical name. 2017-02-01 2017-02-01 2017-02-01
functions
docs
parent
functions
ref PAGE CONTENT
relref
false

ref and relRef look up a content page by relative path (relref) or logical name (ref) to return the permalink. Both functions require a Page object (usually satisfied with a "."):

{{ relref . "about.md" }}

These functions are used in two of Hugo's built-in shortcodes. You can see basic usage examples of both ref and relref in the shortcode documentation.

For an extensive explanation of how to leverage ref and relref for content management, see Cross References.