diff options
Diffstat (limited to 'docs/content/en/functions/ref.md')
| -rw-r--r-- | docs/content/en/functions/ref.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/content/en/functions/ref.md b/docs/content/en/functions/ref.md new file mode 100644 index 000000000..feac06c97 --- /dev/null +++ b/docs/content/en/functions/ref.md @@ -0,0 +1,40 @@ +--- +title: ref +linktitle: ref +description: Looks up a content page by logical name. +godocref: +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2019-12-28 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [cross references, anchors] +signature: ["ref . CONTENT"] +workson: [] +hugoversion: +relatedfuncs: [relref] +deprecated: false +aliases: [] +--- + +`ref` and `relref` look up a content page by logical name (`ref`) or relative path (`relref`) to return the permalink: + +``` +{{ ref . "about.md" }} +``` + +{{% note "Usage Note" %}} +`ref` looks up Hugo "Regular Pages" only. It can't be used for the homepage, section pages, etc. +{{% /note %}} + +It is also possible to pass additional arguments to link to another language or an alternative output format. Therefore, pass a map of arguments instead of just the path. + +``` +{{ ref . (dict "path" "about.md" "lang" "ja" "outputFormat" "rss") }} +``` + +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](/content-management/shortcodes/#ref-and-relref). + +For an extensive explanation of how to leverage `ref` and `relref` for content management, see [Cross References](/content-management/cross-references/). |