Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688'

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

@@ -0,0 +1,71 @@
+---
+title: urls.RelURL
+linkTitle: relURL
+description: Returns a relative URL.
+categories: [functions]
+keywords: []
+menu:
+  docs:
+    parent: functions
+function:
+  aliases: [relURL]
+  returnType: template.HTML
+  signatures: [urls.RelURL INPUT]
+relatedFunctions:
+  - urls.AbsLangURL
+  - urls.AbsURL 
+  - urls.RelLangURL
+  - urls.RelURL
+aliases: [/functions/relurl]
+---
+
+With multilingual configurations, use the [`relLangURL`] function instead. The URL returned by this function depends on:
+
+- Whether the input begins with a slash
+- The `baseURL` in site configuration
+
+### Input does not begin with a slash
+
+If the input does not begin with a slash, the resulting URL will be correct regardless of the `baseURL`.
+
+With `baseURL = https://example.org/`
+
+```go-html-template
+{{ relURL "" }}           →   /
+{{ relURL "articles" }}   →   /articles
+{{ relURL "style.css" }}  →   /style.css
+```
+
+With `baseURL = https://example.org/docs/`
+
+```go-html-template
+{{ relURL "" }}           →   /docs/
+{{ relURL "articles" }}   →   /docs/articles
+{{ relURL "style.css" }}  →   /docs/style.css
+```
+
+#### Input begins with a slash
+
+If the input begins with a slash, the resulting URL will be incorrect when the `baseURL` includes a subdirectory. With a leading slash, the function returns a URL relative to the protocol+host section of the `baseURL`.
+
+With `baseURL = https://example.org/`
+
+```go-html-template
+{{ relURL "/" }}          →   /
+{{ relURL "/articles" }}  →   /articles
+{{ relURL "style.css" }}  →   /style.css
+```
+
+With `baseURL = https://example.org/docs/`
+
+```go-html-template
+{{ relURL "/" }}          →   /
+{{ relURL "/articles" }}  →   /articles
+{{ relURL "/style.css" }} →   /style.css
+```
+
+{{% note %}}
+The last three examples are not desirable in most situations. As a best practice, never include a leading slash when using this function.
+{{% /note %}}
+
+[`relLangURL`]: /functions/urls/rellangurl/