aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/functions/urls/RelLangURL.md
blob: 883e7dda2e8df86dd3cf109366b4ed03d7915bfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
---
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 your site configuration
- The language prefix, if any

In examples that follow, the project is multilingual with content in both English (`en`) and Spanish (`es`). 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 relative to the `baseURL` in your site configuration.

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

```go-html-template
{{ relLangURL "" }}                        → /en/
{{ relLangURL "articles" }}                → /en/articles
{{ relLangURL "style.css" }}               → /en/style.css
{{ relLangURL "https://example.org/foo" }} → /en/foo
```

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

```go-html-template
{{ relLangURL "" }}                             → /docs/en/
{{ relLangURL "articles" }}                     → /docs/en/articles
{{ relLangURL "style.css" }}                    → /docs/en/style.css
{{ relLangURL "https://example.org/docs/foo" }} → /docs/en/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/`

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