hugo/docs/content/en/functions/urls/RelURL.md
2024-06-21 09:41:24 +02:00

1.8 KiB

title description categories keywords action aliases
urls.RelURL Returns a relative URL.
aliases related returnType signatures
relURL
functions/urls/AbsLangURL
functions/urls/AbsURL
functions/urls/RelLangURL
string
urls.RelURL INPUT
/functions/relurl

With multilingual configurations, use the urls.RelLangURL function instead. The URL returned by this function depends on:

  • Whether the input begins with a slash
  • The baseURL in your site configuration

Input does not begin with a slash

If the input does not begin with a slash, the resulting URL will be relative to the baseURL in your site configuration.

With baseURL = https://example.org/

{{ relURL "" }}                        → /
{{ relURL "articles" }}                → /articles
{{ relURL "style.css" }}               → /style.css
{{ relURL "https://example.org/foo" }} → /foo

With baseURL = https://example.org/docs/

{{ relURL "" }}                             → /docs/
{{ relURL "articles" }}                     → /docs/articles
{{ relURL "style.css" }}                    → /docs/style.css
{{ relURL "https://example.org/docs/foo" }} → /docs/foo

Input begins with a slash

If the input begins with a slash, the resulting URL will be relative to the protocol+host of the baseURL in your site configuration.

With baseURL = https://example.org/

{{ relURL "/" }}          → /
{{ relURL "/articles" }}  → /articles
{{ relURL "/style.css" }} → /style.css

With baseURL = https://example.org/docs/

{{ relURL "/" }}          → /
{{ relURL "/articles" }}  → /articles
{{ relURL "/style.css" }} → /style.css