【Hugo】ショートコードで複雑な HTML を簡潔に

 

Hugo 本ブログで使用している静的サイトジェネレータ
公式サイト
ではショートコードという機能があり、

これを使うことで複雑な HTML 構造も簡潔な形でマークダウン(.md)ファイルの中に記述することができるようになります。

今回は、ショートコードの使い方について書いていきます。


ショートコードを設定する

layouts/shortcodesフォルダを作り(フォルダ名は任意ではない)、その中に HTML ファイルを作成します。

この HTML ファイル名が、ショートコードの名前になります。

HTML ファイル内には、ショートコードを使用したマークダウンファイル内で展開したい HTML を書きます。

ここでは例として、次のようなファイルを作成します。

/layouts/shortcodes/greet.html
1
2
<p>おはようございます。</p>
<p>今日の天気は晴れです。</p>

マークダウンファイルでショートコードを呼び出す

マークダウンファイルの中で、ショートコードの名前を使用して、次のように書くと、HTML が展開されます。

{{< greet >}}

-> <p>おはようございます。</p> <p>今日の天気は晴れです。</p>

ショートコードのファイルのほうにマークダウンの記法(**など)を使いたい場合は、< >% %とします。


引数を使用する

ショートコードに引数を追加して、HTML の中で使うこともできます。

HTML ファイルの中では、引数は{{ .Get 0 }}のように、引数の位置を指定することで取得できます。

/layouts/shortcodes/greet.html
1
2
3
4
{{- $name := .Get 0 -}}
{{- $weather := .Get 1 -}}
<p>おはようございます、{{ $name }}さん。</p>
<p>今日の天気は{{ $weather }}です。</p>
{{< greet "サトウ" "雨" >}}

-> <p>おはようございます、サトウさん。</p> <p>今日の天気は雨です。</p>

位置変数の他に、キーワード変数を指定することもできます。

ただし、位置変数とキーワード変数を同時に指定することはできません。

/layouts/shortcodes/greet.html
1
2
3
4
{{- $name := .Get "name" -}}
{{- $weather := .Get "weather" -}}
<p>おはようございます、{{ $name }}さん。</p>
<p>今日の天気は{{ $weather }}です。</p>
{{< greet name="サイトウ" weather="曇り" >}}

-> <p>おはようございます、サイトウさん。</p> <p>今日の天気は曇りです。</p>

default関数を使って、引数のデフォルト値を指定することもできます。

/layouts/shortcodes/greet.html
1
2
3
4
{{- $name := .Get "name" | default "タロウ" -}}
{{- $weather := .Get "weather" | default "晴れ" -}}
<p>おはようございます、{{ $name }}さん。</p>
<p>今日の天気は{{ $weather }}です。</p>
{{< greet >}}

-> <p>おはようございます、タロウさん。</p> <p>今日の天気は晴れです。</p>

関連記事

【Hugo】.Scratch とは?

【Hugo】.Scratch とは?


タグで囲まれた範囲をショートコードとする

ショートコードの開始タグと終了タグで囲まれた範囲を取得することもできます。

内容は{{ .Inner }}で呼び出します。

/layouts/shortcodes/greet.html
1
2
3
<p>おはようございます。</p>
{{ .Inner }}
<p>調子はどうですか。</p>
{{% greet %}}
本日はお日柄もよく、
**たいへん気持ちのいい朝**ですね。
{{% /greet %}}
-> <p>おはようございます。</p> <p>本日はお日柄もよく、 <strong>たいへん気持ちのいい朝</strong>ですね。</p> <p>調子はどうですか。</p>

こちらでも引数を指定することができます。


ショートコードをネストする

開始タグと終了タグを指定するブロック型のショートコードの中に、

別のブロック型ショートコードやインライン型ショートコードを入れることもできます。

/layouts/shortcodes/greet.html
1
2
3
おはようございます、
{{ .Inner }}
調子はどうですか。
/layouts/shortcodes/name-weather.html
1
2
{{ .Get "name" }}さん。
今日の天気は{{ .Get "weather" }}です。
{{% greet %}}
{{% name-weather name="ジロウ" weather="快晴" %}}
{{% /greet %}}
-> <p>おはようございます、</p> <p>ジロウさん。 今日の天気は快晴です。</p> <p>調子はどうですか。</p>

{{ .Parent }}を使えば、親のショートコードから情報を取得することもできます。

/layouts/shortcodes/name-weather.html
1
2
3
{{ .Get "name" }}さん。
{{ .Parent.Get 0 }}
今日の天気は{{ .Get "weather" }}です。
{{% greet "今日は暑いですね。" %}}
{{% name-weather name="ジロウ" weather="快晴" %}}
{{% /greet %}}
-> <p>おはようございます、</p> <p>ジロウさん。 今日は暑いですね。今日の天気は快晴です。</p> <p>調子はどうですか。</p>

関連記事

【Hugo】print・printf の使い方

【Hugo】print・printf の使い方


この記事がお役に立てれば幸いです。

それでは👋