aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/functions/urls/RelLangURL.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/urls/RelLangURL.md')
-rw-r--r--docs/content/en/functions/urls/RelLangURL.md67
1 files changed, 0 insertions, 67 deletions
diff --git a/docs/content/en/functions/urls/RelLangURL.md b/docs/content/en/functions/urls/RelLangURL.md
deleted file mode 100644
index 2c1037038..000000000
--- a/docs/content/en/functions/urls/RelLangURL.md
+++ /dev/null
@@ -1,67 +0,0 @@
----
-title: urls.RelLangURL
-description: Returns a relative URL with a language prefix, if any.
-categories: []
-keywords: []
-action:
- aliases: [relLangURL]
- related:
- - functions/urls/AbsLangURL
- - functions/urls/AbsURL
- - functions/urls/RelURL
- returnType: string
- signatures: [urls.RelLangURL INPUT]
-aliases: [/functions/rellangurl]
----
-
-Use this function with both monolingual and multilingual configurations. The URL returned by this function depends on:
-
-- Whether the input begins with a slash
-- The `baseURL` in site configuration
-- The language prefix, if any
-
-In examples that follow, the project is multilingual with content in both Español (`es`) and English (`en`). The default language is Español. The returned values are from the English site.
-
-### 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
-{{ relLangURL "" }} → /en/
-{{ relLangURL "articles" }} → /en/articles
-{{ relLangURL "style.css" }} → /en/style.css
-```
-
-With `baseURL = https://example.org/docs/`
-
-```go-html-template
-{{ relLangURL "" }} → /docs/en/
-{{ relLangURL "articles" }} → /docs/en/articles
-{{ relLangURL "style.css" }} → /docs/en/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
-{{ relLangURL "/" }} → /en/
-{{ relLangURL "/articles" }} → /en/articles
-{{ relLangURL "/style.css" }} → /en/style.css
-```
-
-With `baseURL = https://example.org/docs/`
-
-```go-html-template
-{{ relLangURL "/" }} → /en/
-{{ relLangURL "/articles" }} → /en/articles
-{{ relLangURL "/style.css" }} → /en/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 %}}