SiteParam

The siteparam shortcode prints values of site-wide params contained in your hugo.toml.

Usage

To print params from a page’s front matter and falling back to the site options, use Hugo’s built-in param shortcode.

{{% siteparam name="editURL" %}}

{{% siteparam "editURL" %}}

{{ partial "shortcodes/siteparam.html" (dict
  "page" .
  "name" "editURL"
)}}

Parameter

Name	Position	Default	Notes
name	1	<empty>	The name of the site param to be displayed.

Examples

`editURL`

`editURL` value: {{% siteparam name="editURL" %}}

editURL value: https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/${FilePath}

Nested Parameter with Markdown and HTML Formatting

To use formatted parameter, add this in your hugo.toml:

hugo.

[markup]
  [markup.goldmark]
    [markup.goldmark.renderer]
      unsafe = true

markup:
  goldmark:
    renderer:
      unsafe: true

{
   "markup": {
      "goldmark": {
         "renderer": {
            "unsafe": true
         }
      }
   }
}

Now values containing Markdown will be formatted correctly.

hugo.

[params]

[siteparam]
  [siteparam.test]
    text = 'A **nested** parameter <b>with</b> formatting'

params: {}
siteparam:
  test:
    text: A **nested** parameter <b>with</b> formatting

{
   "params": {},
   "siteparam": {
      "test": {
         "text": "A **nested** parameter \u003cb\u003ewith\u003c/b\u003e formatting"
      }
   }
}

Formatted parameter: {{% siteparam name="siteparam.test.text" %}}

Formatted parameter: A nested option <b>with</b> formatting