summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/urls/AbsURL.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/urls/AbsURL.md')
-rw-r--r--docs/content/en/functions/urls/AbsURL.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/content/en/functions/urls/AbsURL.md b/docs/content/en/functions/urls/AbsURL.md
index 1120eac42..72613cd0b 100644
--- a/docs/content/en/functions/urls/AbsURL.md
+++ b/docs/content/en/functions/urls/AbsURL.md
@@ -3,23 +3,20 @@ title: urls.AbsURL
description: Returns an absolute URL.
categories: []
keywords: []
-action:
- aliases: [absURL]
- related:
- - functions/urls/AbsLangURL
- - functions/urls/RelLangURL
- - functions/urls/RelURL
- returnType: string
- signatures: [urls.AbsURL INPUT]
+params:
+ functions_and_methods:
+ aliases: [absURL]
+ returnType: string
+ signatures: [urls.AbsURL INPUT]
aliases: [/functions/absurl]
---
With multilingual configurations, use the [`urls.AbsLangURL`] function instead. The URL returned by this function depends on:
-- Whether the input begins with a slash
-- The `baseURL` in site configuration
+- Whether the input begins with a slash (`/`)
+- The `baseURL` in your site configuration
-### Input does not begin with a slash
+## Input does not begin with a slash
If the input does not begin with a slash, the path in the resulting URL will be relative to the `baseURL` in your site configuration.
@@ -39,7 +36,7 @@ With `baseURL = https://example.org/docs/`
{{ absURL "style.css" }} → https://example.org/docs/style.css
```
-#### Input begins with a slash
+## Input begins with a slash
If the input begins with a slash, the path in the resulting URL will be relative to the protocol+host of the `baseURL` in your site configuration.
@@ -59,4 +56,7 @@ With `baseURL = https://example.org/docs/`
{{ absURL "/style.css" }} → https://example.org/style.css
```
+> [!note]
+> 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.
+
[`urls.AbsLangURL`]: /functions/urls/abslangurl/