mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-21 21:35:28 +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:
63
docs/content/en/functions/urls/Ref.md
Normal file
63
docs/content/en/functions/urls/Ref.md
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
title: urls.Ref
|
||||
description: Returns the absolute permalink to a page at the given path.
|
||||
categories: []
|
||||
keywords: []
|
||||
action:
|
||||
aliases: [ref]
|
||||
related:
|
||||
- functions/urls/RelRef
|
||||
- methods/page/Ref
|
||||
- methods/page/RelRef
|
||||
returnType: string
|
||||
signatures:
|
||||
- urls.Ref PAGE PATH
|
||||
- urls.Ref PAGE OPTIONS
|
||||
aliases: [/functions/ref]
|
||||
---
|
||||
|
||||
The first argument is the context of the page from which to resolve relative paths, typically the current page.
|
||||
|
||||
The second argument is a path to a page, with or without a file extension, with or without an anchor. A path without a leading `/` is first resolved relative to the given context, then to the remainder of the site. Alternatively, provide an [options map](#options) instead of a path.
|
||||
|
||||
```go-html-template
|
||||
{{ ref . "about" }}
|
||||
{{ ref . "about#anchor" }}
|
||||
{{ ref . "about.md" }}
|
||||
{{ ref . "about.md#anchor" }}
|
||||
{{ ref . "#anchor" }}
|
||||
{{ ref . "/blog/my-post" }}
|
||||
{{ ref . "/blog/my-post.md" }}
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
Instead of specifying a path, you can also provide an options map:
|
||||
|
||||
path
|
||||
: (`string`) The path to the page, relative to the content directory. Required.
|
||||
|
||||
lang
|
||||
: (`string`) The language (site) to search for the page. Default is the current language. Optional.
|
||||
|
||||
outputFormat
|
||||
: (`string`) The output format to search for the page. Default is the current output format. Optional.
|
||||
|
||||
To return the absolute permalink to another language version of a page:
|
||||
|
||||
```go-html-template
|
||||
{{ ref . (dict "path" "about.md" "lang" "fr") }}
|
||||
```
|
||||
|
||||
To return the absolute permalink to another Output Format of a page:
|
||||
|
||||
```go-html-template
|
||||
{{ ref . (dict "path" "about.md" "outputFormat" "rss") }}
|
||||
```
|
||||
|
||||
By default, Hugo will throw an error and fail the build if it cannot resolve the path. You can change this to a warning in your site configuration, and specify a URL to return when the path cannot be resolved.
|
||||
|
||||
{{< code-toggle file=hugo >}}
|
||||
refLinksErrorLevel = 'warning'
|
||||
refLinksNotFoundURL = '/some/other/url'
|
||||
{{< /code-toggle >}}
|
Reference in New Issue
Block a user