TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-15 12:54:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix ref and relref function pages.

Browse Source
This commit is contained in:
Ricardo N Feliciano 2017-12-13 17:10:19 -05:00 committed by Bjørn Erik Pedersen
parent b36632b312
commit a4ea3402d1
2 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/functions/ref.md
View File

@ -11,7 +11,7 @@ menu:
docs:
parent: "functions"
keywords: [cross references, anchors]
signature: ["ref CONTENT"]
signature: ["ref . CONTENT"]
workson: []
hugoversion:
relatedfuncs: [relref]
@ -19,12 +19,16 @@ deprecated: false
aliases: []
---
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink:
`ref` and `relref` look up a content page by logical name (`ref`) or relative path (`relref`) to return the permalink:
```
{{ ref "about.md" }}
{{ ref . "about.md" }}
```
{{% note "Usage Note" %}}
`ref` 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/).

12
content/functions/relref.md
View File

@ -11,20 +11,24 @@ menu:
docs:
parent: "functions"
keywords: [cross references, anchors]
signature: ["relref CONTENT"]
signature: ["relref . CONTENT"]
workson: []
hugoversion:
relatedfuncs: [relref]
relatedfuncs: [ref]
deprecated: false
aliases: []
---
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink:
`ref` and `relref` look up a content page by logical name (`ref`) or relative path (`relref`) to return the permalink:
```
{{ relref "about.md" }}
{{ 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/).