HUGO
News Docs Themes Community GitHub

Param

Returns the site parameter with the given key.

Syntax

SITE.Param KEY

Returns

any

The Param method on a Site object is a convenience method to return the value of a user-defined parameter in the site configuration.

params:
  display_toc: true
[params]
  display_toc = true
{
   "params": {
      "display_toc": true
   }
}
{{ .Site.Param "display_toc" }} → true

The above is equivalent to either of these:

{{ .Site.Params.display_toc }}
{{ index .Site.Params "display_toc" }}