hugo-wasm/docs/content/en/shortcodes/relref.md
2025-01-23 09:47:46 +01:00

1.4 KiB
Executable file

title description categories keywords menu weight
Relref Insert a relative permalink to the given page reference using the relref shortcode.
shortcodes
docs
parent weight
shortcodes

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

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

{{% 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.

{{% /note %}}

The relref shortcode returns the relative permalink of the given page reference.

Example usage:

[Post 1]({{%/* relref "/posts/post-1" */%}})
[Post 1]({{%/* relref "/posts/post-1.md" */%}})
[Post 1]({{%/* relref "/posts/post-1#foo" */%}})
[Post 1]({{%/* relref "/posts/post-1.md#foo" */%}})

Rendered:

<a href="/posts/post-1/">Post 1</a>
<a href="/posts/post-1/">Post 1</a>
<a href="/posts/post-1/#foo">Post 1</a>
<a href="/posts/post-1/#foo">Post 1</a>

{{% note %}} Always use the {{%/* */%}} notation when calling this shortcode. {{% /note %}}