やりたいこと
当サイトは
Hugo
を使用して作成している。
各記事はMarkdownで記述するのだが、その中でたとえば次のようにHugoのコードを書いたとしても当然それが実行されることはない。
<!-- 以下はMarkdownで書いてもただの文字列として表示される -->
<!-- 変数をセットして -->
{{ $key := "value" }}
<!-- 取得したい -->
{{ $key }}
(実際にやってみたところ)
{{ $key := “value” }}
{{ $key }}
しかし、たとえば この記事 のように「更新のたびに記事内のすべての最新バージョン文字列を書き換えなければならない」といった需要があるときに、変数使えれば楽なのになぁといった気持ちになる。
そこで、ページ内でだけ利用できる変数を扱うショートコードを用意した。
Shortcodes
layouts/shortcodes/set.html
<!-- set key value で変数をセット -->
{{- .Page.Scratch.Set (index .Params 0) (index .Params 1) -}}
layouts/shortcodes/get.html
<!-- get key で変数を文字列として取得 -->
{{- .Page.Scratch.Get (index .Params 0) -}}
それぞれのコードを{{ ~~~ }}ではなく{{- ~~~ -}}で囲っているのは、hugoの実行パラメータに--minifyが指定されていない場合に置き換えた文字列前後に余分な空白ができるためである。パラメータが指定されている場合は別にどちらでもとくに問題ないはず。
(執筆中のリアルタイム確認ではminifyしていないので少し気になっただけ)
以上ふたつのファイルを配置することで、各記事Markdown内で次のように変数が利用できるようになる。
<!-- 変数をセットする -->
{{<set key value>}}
<!-- 変数を取得(文字列として表示)する -->
変数keyは「{{<get key>}}」です。
(実際にやってみたところ)
変数keyは「value」です。
やったぜ。
既にテンプレートなどでページ内のScratchを使用していて名前衝突が心配になる場合は、上記ショートコードのキー指定部分にユニークなprefixなりsuffixなりを付け加えるようにすれば良いのだと思う。
余談
ショートコードを実行しないで記事中に文字列として表示したい場合は、次のように書くらしい。今この記事を書いていて知った。
{{</*hoge*/>}}
参考
How is the Hugo Doc site showing shortcodes in code blocks? - HUGO