hugo/docs/content/en/shortcodes/relref.md

title	linkTitle	description	categories	keywords
Relref shortcode	Relref	Insert a relative permalink to the given page reference using the relref shortcode.

[!note] To override Hugo's embedded relref shortcode, copy the [source code] to a file with the same name in the layouts/shortcodes directory.

[!note] When working with the Markdown content format, this shortcode has become largely redundant. Its functionality is now primarily handled by link render hooks, specifically the embedded one provided by Hugo. This hook effectively addresses all the use cases previously covered by this shortcode.

Usage

The relref shortcode accepts either a single positional argument (the path) or one or more named arguments, as listed below.

Arguments

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

Examples

The relref shortcode typically provides the destination for a Markdown link.

[!note] Always use Markdown notation notation when calling this shortcode.

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

[Link A]({{%/* ref "/books/book-1" */%}})

[Link B]({{%/* ref path="/books/book-1" */%}})

[Link C]({{%/* ref path="/books/book-1" lang="de" */%}})

[Link D]({{%/* ref path="/books/book-1" lang="de" outputFormat="json" */%}})

Rendered:

<a href="/en/books/book-1/">Link A</a>

<a href="/en/books/book-1/">Link B</a>

<a href="/de/books/book-1/">Link C</a>

<a href="/de/books/book-1/index.json">Link D</a>

Error handling

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

[source code]: {{% eturl relref %}}