Hugo テンプレート内で変数を定義するときは、変数名のプレフィックスとして $ を付けます。

変数定義の基本

Hugo テンプレート内で変数を定義するには、下記のような構文を使用します。 = ではなくて、:= を使用することに注意してください。

{{ $変数名 := 初期値 }}

上記の構文から分かるように、独自の変数を定義する場合は、変数名のプレフィックスとして $ を付けます。

次の例では、数値変数 $x と、文字列変数 $y を定義し、それらの値を出力しています。 変数定義のアクションを実行しただけでは、その変数の値は出力されないので、変数出力のためのアクションを続けて記述しています（下の例では {{ $x }} や {{ $y }} という部分）。

{{ $x := 100 }}
<p>{{ $x }}</p>

{{ $y := "Hello" }}
<p>{{ $y }}</p>

<p>100</p>
<p>Hello</p>

処理結果を変数に格納する

ある値をパイプで関数に渡して、処理を行った結果を変数に格納する、といったこともできます。 次の例では、文字列 maku を printf 関数に渡し、その結果をさらに printf 関数に渡しています。 変数 $x には、その最終的な結果が格納されます。

{{ $x := "maku" | printf "Hello %s." | printf "%s What's up?" }}
<p>{{ $x }}</p>

<p>Hello maku. What's up?</p>

上記では、文字列 maku をパイプで printf 関数に渡していますが、次のように printf 関数のパラメータとして指定することもできます。

{{ $x := printf "%s What's up?" (printf "Hello %s." "maku") }}
<p>{{ $x }}</p>

どちらの方法でも結果は同じですが、上記のように 1 つの値を連続して変換していくようなケースでは、パイプを使って記述したほうが読みやすいように感じます。

range アクションでの変数の使用

range アクションによって配列をループ処理する場合は、各要素の値を変数に取り出しながら処理することができます。

<h3>ページ一覧</h3>
<ul>
  {{ range $page := .Site.AllPages }}
    <li><a href="{{ $page.RelPermalink }}">{{ $page.Title }}</a>
  {{ end }}
</ul>

ただし、上記のように要素の値のみを取り出す場合は、デフォルトのドット (.) のコンテキストを置き換えて下記のようにループ処理する方が簡潔に記述できます。

<h3>ページ一覧</h3>
<ul>
  {{ range .Site.AllPages }}
    <li><a href="{{ .RelPermalink }}">{{ .Title }}</a>
  {{ end }}
</ul>

次のように、2 つの変数を用意することで、インデックス（0 始まり）を取得しながらループ処理することもできます。

<h3>ページ一覧</h3>
<ul>
  {{ range $index, $page := .Site.AllPages }}
  <li><a href="{{ $page.RelPermalink }}">{{ printf "%d: %s" (add $index 1) $page.Title }}</a>
  {{ end }}
</ul>

<ul> じゃなくて <ol> で表示すればいいじゃん、というツッコミはなしで（＾＾；

with アクションでの変数の使用

with アクションで変数スコープを制限する場合にも、変数を使用することができます。

{{ with $x := "maku" }}
  Hello {{ $x }}
{{ end }}

上記のようにすると、with ～ end のブロックの外からは、変数 $x は参照できなくなります。