mirror
/
hugo
mirror of https://github.com/gohugoio/hugo
1
0
Fork 0
Code Issues
hugo/docs/content/en/functions/urls/RelRef.md

1.2 KiB
Raw Permalink Blame History

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

Usage

The relref 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:

{{ relref . "/books/book-1" }} → /en/books/book-1/

{{ $opts := dict "path" "/books/book-1" }}
{{ relref . $opts }} → /en/books/book-1/

{{ $opts := dict "path" "/books/book-1" "lang" "de" }}
{{ relref . $opts }} → /de/books/book-1/

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

Error handling

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