1. Tutorials
  2. Hugo

Hugo Custom Page And Site Variable

September 9, 2017

Page Variable

You create create custom variable for page as per the following configration for the page markdown file.

---
title: "Post"
date: 2017-09-09T22:14:20+08:00
test: "OK"
testAgain: "This will work"
nested:
  test: "OK"
  testAgain: "This will not work"
---

You can access the custom variable using .Params from your template files.

<pre>
[page]
test={{ .Params.test }}
testAgain={{ .Params.testAgain }}
nested.test={{ .Params.nested.test }}
</pre>

Note: For Hugo v0.25.1, accessing custom nested page variable with camel case doesn’t work, such as the case for .Params.nested.testAgain, but it will work for non-nested variable.

Query pages using custom page variable

You can use custom page variable when querying for .Site.Pages.

{{ $pages := (where .Site.Pages "Params.test" "OK") }}
{{ range $pages }}
  {{ .Title }} - {{ .Permalink }}
{{ end }}

Site Variable

Edit config.toml.

[params]
  test = "OK"

  [params.nested]
    test = "OK"

You can access the custom variable using .Site.Params from your template files.

<pre>
[site]
test={{ .Site.Params.test }}
nested.test={{ .Site.Params.nested.test }}
</pre>
❤️ Is this article helpful?
Buy me a coffee☕ or support my work to keep this space 🖖 and ad-free.
If you can't, do send some 💖 to @d_luaz or help to share this article.
👶 Apps I built
Pixtory App (Alpha) - easily organize photos on your phone into a blog.
COVID-19 - data, chart, information & news.
暖心芽 (WIP) 🌞❤️🌱 - reminder of hope, warmth, thoughts and feelings.
Travelopy - travel discovery and journal
LuaPass - offline password manager
WhatIDoNow - a public log of things I am working on now
By Desmond Lua
A dream boy who enjoys making apps, travelling and gardening. Follow me on @d_luaz.
This work is licensed under a
Creative Commons Attribution-NonCommercial 4.0 International License.