hugo/docs/content/en/functions/urls/Ref.md

title	description	categories	keywords	params	aliases
urls.Ref	Returns the absolute URL of the page with the given path, language, and output format.			functions_and_methods aliases returnType signatures ref string urls.Ref PAGE PATH urls.Ref PAGE OPTIONS	/functions/ref

Usage

The ref function takes two arguments:

1. The context for resolving relative paths (typically the current page).
2. Either the target page's path or an options map (see below).

Options

{{% include "_common/ref-and-relref-options.md" %}}

Examples

The following examples show the rendered output for a page on the English version of the site:

{{ ref . "/books/book-1" }} → https://example.org/en/books/book-1/

{{ $opts := dict "path" "/books/book-1" }}
{{ ref . $opts }} → https://example.org/en/books/book-1/

{{ $opts := dict "path" "/books/book-1" "lang" "de" }}
{{ ref . $opts }} → https://example.org/de/books/book-1/

{{ $opts := dict "path" "/books/book-1" "lang" "de" "outputFormat" "json" }}
{{ ref . $opts }} → https://example.org/de/books/book-1/index.json

Error handling

{{% include "_common/ref-and-relref-error-handling.md" %}}