github.com/rabbouni145/gg@v0.47.1/docs/content/en/functions/relref.md (about)

     1  ---
     2  title: relref
     3  # linktitle: relref
     4  description: Looks up a content page by relative path.
     5  godocref:
     6  date: 2017-02-01
     7  publishdate: 2017-02-01
     8  lastmod: 2017-02-01
     9  categories: [functions]
    10  menu:
    11    docs:
    12      parent: "functions"
    13  keywords: [cross references, anchors]
    14  signature: ["relref . CONTENT"]
    15  workson: []
    16  hugoversion:
    17  relatedfuncs: [ref]
    18  deprecated: false
    19  aliases: []
    20  ---
    21  
    22  `ref` and `relref` look up a content page by logical name (`ref`) or relative path (`relref`) to return the permalink:
    23  
    24  ```
    25  {{ relref . "about.md" }}
    26  ```
    27  
    28  {{% note "Usage Note" %}}
    29  `relref` looks up Hugo "Regular Pages" only. It can't be used for the homepage, section pages, etc.
    30  {{% /note %}}
    31  
    32  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).
    33  
    34  For an extensive explanation of how to leverage `ref` and `relref` for content management, see [Cross References](/content-management/cross-references/).