mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-23 21:53:09 +02:00
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
This commit is contained in:
67
docs/content/en/functions/urls/AbsLangURL.md
Normal file
67
docs/content/en/functions/urls/AbsLangURL.md
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: urls.AbsLangURL
|
||||
description: Returns an absolute URL with a language prefix, if any.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
aliases: [absLangURL]
|
||||
related:
|
||||
- functions/urls/AbsURL
|
||||
- functions/urls/RelLangURL
|
||||
- functions/urls/RelURL
|
||||
returnType: string
|
||||
signatures: [urls.AbsLangURL INPUT]
|
||||
aliases: [/functions/abslangurl]
|
||||
---
|
||||
|
||||
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
|
||||
{{ absLangURL "" }} → https://example.org/en/
|
||||
{{ absLangURL "articles" }} → https://example.org/en/articles
|
||||
{{ absLangURL "style.css" }} → https://example.org/en/style.css
|
||||
```
|
||||
|
||||
With `baseURL = https://example.org/docs/`
|
||||
|
||||
```go-html-template
|
||||
{{ absLangURL "" }} → https://example.org/docs/en/
|
||||
{{ absLangURL "articles" }} → https://example.org/docs/en/articles
|
||||
{{ absLangURL "style.css" }} → https://example.org/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
|
||||
{{ absLangURL "/" }} → https://example.org/en/
|
||||
{{ absLangURL "/articles" }} → https://example.org/en/articles
|
||||
{{ absLangURL "/style.css" }} → https://example.org/en/style.css
|
||||
```
|
||||
|
||||
With `baseURL = https://example.org/docs/`
|
||||
|
||||
```go-html-template
|
||||
{{ absLangURL "/" }} → https://example.org/en/
|
||||
{{ absLangURL "/articles" }} → https://example.org/en/articles
|
||||
{{ absLangURL "/style.css" }} → https://example.org/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 %}}
|
Reference in New Issue
Block a user