hugo/docs/content/en/functions/urls/RelURL.md

title, description, categories, keywords, params, aliases

title	description	categories	keywords	params	aliases
urls.RelURL	Returns a relative URL.			functions_and_methods aliases returnType signatures relURL 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 project 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 project configuration.

With baseURL = https://example.org/

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

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

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

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 project 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

Note

As illustrated by the previous example, using a leading slash is rarely desirable and can lead to unexpected outcomes. In nearly all cases, omit the leading slash.