urls.RelURL
Returns a relative URL.
Syntax
urls.RelURL INPUT
Returns
string
Alias
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" }} → 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 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
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.
Last updated:
March 8, 2025
:
content: Replace note shortcode calls with blockquote alerts (c540e6d29)
Improve this page