git-subtree-dir: docs git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2.3 KiB
title | description | categories | keywords | action | aliases | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
urls.AbsLangURL | Returns an absolute URL with a language prefix, if any. |
|
|
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/
{{ 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/
{{ 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/
{{ 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/
{{ 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 %}}