aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/functions/urls/RelURL.md
blob: 18ac24d109f54f303e904d5ccdffcae9086d8494 (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
---
title: urls.RelURL
description: Returns a relative URL.
categories: []
keywords: []
action:
  aliases: [relURL]
  related:
    - functions/urls/AbsLangURL
    - functions/urls/AbsURL 
    - functions/urls/RelLangURL
  returnType: string
  signatures: [urls.RelURL INPUT]
aliases: [/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 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/`

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

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

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

[`urls.RelLangURL`]: /functions/urls/rellangurl/