github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-18 15:16:45 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/methods/shortcode/RelRef.md
Bjørn Erik Pedersen 5fd1e74903
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs' 
```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes #11925
2024-01-27 10:48:57 +01:00

1.4 KiB
Raw Blame History

title description categories keywords action
RelRef Returns the relative URL of the page with the given path, language, and output format.
related returnType signatures
methods/shortcode/Ref
functions/urls/Ref
functions/urls/RelRef
string
SHORTCODE.RelRef OPTIONS

The map of option contains:

path
(string) The path to the page, relative to the content directory. Required.
lang
(string) The language (site) to search for the page. Default is the current language. Optional.
outputFormat
(string) The output format to search for the page. Default is the current output format. Optional.

The examples below show the rendered output when visiting a page on the English language version of the site:

{{ $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

By default, Hugo will throw an error and fail the build if it cannot resolve the path. You can change this to a warning in your site configuration, and specify a URL to return when the path cannot be resolved.

{{< code-toggle file=hugo >}} refLinksErrorLevel = 'warning' refLinksNotFoundURL = '/some/other/url' {{< /code-toggle >}}