mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
35 lines
1 KiB
Markdown
35 lines
1 KiB
Markdown
|
---
|
||
|
|
title: relref
|
||
|
|
# linktitle: relref
|
||
|
|
description: Looks up a content page by relative path.
|
||
|
|
godocref:
|
||
|
|
date: 2017-02-01
|
||
|
|
publishdate: 2017-02-01
|
||
|
|
lastmod: 2017-02-01
|
||
|
|
categories: [functions]
|
||
|
|
menu:
|
||
|
|
docs:
|
||
|
|
parent: "functions"
|
||
|
|
keywords: [cross references, anchors]
|
||
|
|
signature: ["relref . CONTENT"]
|
||
|
|
workson: []
|
||
|
|
hugoversion:
|
||
|
|
relatedfuncs: [ref]
|
||
|
|
deprecated: false
|
||
|
|
aliases: []
|
||
|
|
---
|
||
|
|
|
||
|
|
`ref` and `relref` look up a content page by logical name (`ref`) or relative path (`relref`) to return the permalink:
|
||
|
|
|
||
|
|
```
|
||
|
|
{{ relref . "about.md" }}
|
||
|
|
```
|
||
|
|
|
||
|
|
{{% note "Usage Note" %}}
|
||
|
|
`relref` looks up Hugo "Regular Pages" only. It can't be used for the homepage, section pages, etc.
|
||
|
|
{{% /note %}}
|
||
|
|
|
||
|
|
These functions are used in two of Hugo's built-in shortcodes. You can see basic usage examples of both `ref` and `relref` in the [shortcode documentation](/content-management/shortcodes/#ref-and-relref).
|
||
|
|
|
||
|
|
For an extensive explanation of how to leverage `ref` and `relref` for content management, see [Cross References](/content-management/cross-references/).
|