【Hugo】.TableOfContents が使えないけど目次を追加したいときの対処法

 
Hugo 本ブログで使用している静的サイトジェネレータ
公式サイト
には、記事内の h タグから自動で目次を出力してくれる機能があり、

通常は.TableOfContentsで呼び出すことができます。

しかし、テーマによっては何らかの事情で.TableOfContentsが使えない可能性があるので、

今回は Hugo のテンプレート文だけでがんばって実装してみたいと思います。


.TableOfContentsの構造

HTML を見てみると、.TableOfContentsが呼び出された部分は次のようになっています。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<nav id="TableOfContents">
    <ul>
        <li>
            <a href="#見出し1">見出し1</a>
            <ul>
                <li>
                    <a href="#見出し2">見出し2</a>
                </li>
                <li>
                    <a href="#見出し3">見出し3</a>
                </li>
            </ul>
        </li>
        <li>
            <a href="#見出し4">見出し4</a>
        </li>
    </ul>
</nav>

この場合、記事のマークダウンファイルは、

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## 見出し1
 
...
 
### 見出し2
 
...
 
### 見出し3
 
...
 
## 見出し4
 
...

となり、

HTML では

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
<h2 id="#見出し1">見出し1</h2>
<p>...</p>
...
<h3 id="#見出し2">見出し2</h3>
<p>...</p>
...
<h3 id="#見出し3">見出し3</h3>
<p>...</p>
...
<h2 id="#見出し4">見出し4</h2>
<p>...</p>
...

となります。

ところで、記事の HTML は.Contentで参照できるので、

記事の中から h タグを探して、それらをもとに目次を作ることができます。

関連記事

【Hugo】ブログの記事ページのサイドバーに固定目次を追加

【Hugo】ブログの記事ページのサイドバーに固定目次を追加


テンプレートのコーディング

目次を作成するテンプレートファイルを作りましょう。

目次の項目は h2 から始まることにします。

h タグを検索する

記事内容は.Contentで参照できますが、テーマ独自で何か改変が加えられていることもあります。

最終的な出力内容は、例えばlayouts/partials/post.htmlなどを確認してください。

$Contentのようになっていれば、直前に{{ $Content := .Scratch.Get "Content" }}などと書かれていると思います。

.Scratchって?

Hugo では変数は{{ $var := value }}のように定義できますが、$がつく形の変数はローカルにしか参照できません。

別のファイルに持ち込んだり、rangewithなどの関数の外部から参照することができないので、

このような場合には.Scratchを使います。

{{ .Scratch.Set "name" $inner_var }}とすると、外部からも{{ $outer_var := .Scratch.Get "name" }}とすることで同じ値を呼び出すことができるようになります。

関連記事

【Hugo】.Scratch とは?

【Hugo】.Scratch とは?


ここでは、ある程度の処理が加えられた後の.Contentのデータが.Scratch.Get "Content"で呼び出すことができ、それが最終的に出力されているものとして進めていきます。

layouts/partials/custom/toc.html
1
2
{{- /* Content を呼び出す */ -}}
{{- $Content := .Scratch.Get "Content" -}}

次にfindREを使って h タグを探します。

toc.html
1
2
3
4
5
6
{{- /* Content を呼び出す */ -}}
{{- $Content := .Scratch.Get "Content" -}}
{{- /* 検索に使用する正規表現パターン */ -}}
{{- $pattern := `<h[2-9] id="(.+?)".*?>((?:.|\n)*?)</h[2-9]>` -}}
{{- /* 正規表現により h タグを検索 */ -}}
{{- $headers := findRE $pattern $Content -}}

正規表現の部分について簡単に説明しておくと、

[2-9]は「2-9のうちのどれか一文字」を表し、*?は「前の文字の任意の0回以上の繰り返しで最短のもの」を表しています。

.は「改行以外の任意の一文字」、\nは「改行」を表します。

つまりここでは、id 属性以外の 属性 要素に設定を付加するもの
class="classname"など
の有無を問わずレベル2から9の h タグがマッチします。

()で囲った部分はグループ化され、後から$1$2、…という形で参照することができますが、

(?:)で囲った部分は無視されます。

h タグの要素を取り出す

$headersにはパターンにマッチした要素がリストとして渡されています。

それぞれの要素を取り出していきますが、ここでrangeを使います。

toc.html
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{{- /* Content を呼び出す */ -}}
{{- $Content := .Scratch.Get "Content" -}}
{{- /* 検索に使用する正規表現パターン */ -}}
{{- $pattern := `<h[2-9] id="(.+?)".*?>((?:.|\n)*?)</h[2-9]>` -}}
{{- /* 正規表現により h タグを検索 */ -}}
{{- $headers := findRE $pattern $Content -}}
{{- range $headers -}}
    {{- /* ヘッダーへのリンクアドレス */ -}}
    {{- $id := . | replaceRE $pattern `$1` -}}
    {{- /* ヘッダー名 */ -}}
    {{- $header := . | replaceRE $pattern `$2` | safeHTML -}}
{{- end -}}

9行目の.というのは$headersの要素のうちのひとつを表しています(ここでは扱いませんがwith関数でも同じような省略が起こります)。

9行目は、「$headers内の各要素について、$patternにマッチする部分をパターンの第一グループに置き換える」という意味になります。

第一グループというのは$patternで id 属性の後に書いた(.+?)のことです。

つまり、この一連の処理によって、例えば

<h2 id="ミダシ">見出し</h2>$id:ミダシ, $header:見出し

となって、$id$headerに格納されるわけですね。

safeHTMLというのは HTML 文がエスケープされないようにするということです。

ところで、このままでは h2 タグと h3 タグは区別できていないので、

階層構造のある目次にはなりません。

階層を区別する

h タグの数字の部分を取り出しましょう。

正規表現の部分に修正を加えます。

そして新たに$depthに階層の深さの情報を入れます。

toc.html
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{{- /* Content を呼び出す */ -}}
{{- $Content := .Scratch.Get "Content" -}}
{{- /* 検索に使用する正規表現パターン */ -}}
{{- $pattern := `<h([2-9]) id="(.+?)".*?>((?:.|\n)*?)</h[2-9]>` -}}
{{- /* 正規表現により h タグを検索 */ -}}
{{- $headers := findRE $pattern $Content -}}
{{- range $headers -}}
    {{- /* ヘッダーの深さ */ -}}
    {{- $depth := . | replaceRE $pattern `$1` -}}
    {{- /* ヘッダーへのリンクアドレス */ -}}
    {{- $id := . | replaceRE $pattern `$2` -}}
    {{- /* ヘッダー名 */ -}}
    {{- $header := . | replaceRE $pattern `$3` | safeHTML -}}
{{- end -}}

かっこを後ろにつけて...</h([2-9])>としても大丈夫です。

さて、これで.TableOfContentsをつくる準備は整いました。

あとはこれをもとに HTML を組んでいけばOKです。

関連記事

【Hugo】findRE・replaceRE の使い方

【Hugo】findRE・replaceRE の使い方


HTML のコーディング

さきほど示した.TableOfContentsの構造をまねて、 HTML を書いていきます。

ここはもうパズルです笑

toc.html
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
...
{{- /* ループで直前に調べたものの階層の深さ */ -}}
{{- $scratch := newScratch -}}
{{- $scratch.Set "prev_depth" 0 -}}
<nav id="TableOfContents">
    <ul>
        {{- range $headers -}}
            ...
            {{- $prev_depth := $scratch.Get "prev_depth" -}}
            {{- /* h2 のとき */ -}}
            {{- if eq $depth `2` -}}
                {{- /* 直前の h タグが h2 のとき */ -}}
                {{- if eq $prev_depth `2` -}}
                    </li>
                {{- /* 直前の h タグが h3 のとき */ -}}
                {{- else if eq $prev_depth `3` -}}
                    </ul></li>
                {{- end -}}
                <li><a href="#{{ $id }}">{{ $header }}</a>
            {{- /* h3 のとき */ -}}
            {{- else if eq $depth `3` -}}
                {{- /* 直前の h タグが h2 のとき */ -}}
                {{- if eq $prev_depth `2` -}}
                    <ul>
                {{- end -}}
                <li><a href="#{{ $id }}">{{ $header }}</a></li>
            {{- end -}}
            {{- $scratch.Set "prev_depth" $depth -}}
        {{- end -}}
        {{- $prev_depth := $scratch.Get "prev_depth" -}}
        {{- /* 直前の h タグが h2 のとき */ -}}
        {{- if eq $prev_depth `2` -}}
            </li>
        {{- /* 直前の h タグが h3 のとき */ -}}
        {{- else if eq $prev_depth `3` -}}
            </ul></li>
        {{- end -}}
    </ul>
</nav>

3行目のnewScratchというのはローカルなスクラッチだそうです。

.Scratchを使うと範囲が広すぎて他のものと名前衝突を起こし上書きされてしまう危険性があるので、転ばぬ先の杖です。

eqは等号で、eq a ba == bの意味です。

注意しなくてはならないのは、取得した数字は文字列なので、文字列として扱わなければifにひっかからないということです。

このコードはループで直前に調べたものの階層の深さとループ中のものの階層の深さを利用して、

どこで何のタグをどれくらい開いたり閉じたりするかを指定しています。

h2 と h3 しか使わないよという人なら、これで十分です(といっても全部あわせると五十文あります…)。

もっといえば、さきほどの正規表現の[2-9][23]に書き換えてしまってOKです。

目次なら二階層もあれば大丈夫だと思うんですが、もし h4 も使いたいなら、脳内シミュレーションしつつ同じようにコーディングしていけばいいと思います。

コード全文(h2 h3 しか使わない場合)
toc.html
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{{- /* Content を呼び出す */ -}}
{{- $Content := .Scratch.Get "Content" -}}
{{- /* 検索に使用する正規表現パターン */ -}}
{{- $pattern := `<h([23]) id="(.+?)".*?>((?:.|\n)*?)</h[23]>` -}}
{{- /* 正規表現により h タグを検索 */ -}}
{{- $headers := findRE $pattern $Content -}}
{{- /* ループで直前に調べたものの階層の深さ */ -}}
{{- $scratch := newScratch -}}
{{- $scratch.Set "prev_depth" 0 -}}
<nav id="TableOfContents">
    <ul>
        {{- range $headers -}}
            {{- /* ヘッダーの深さ */ -}}
            {{- $depth := . | replaceRE $pattern `$1` -}}
            {{- /* ヘッダーへのリンクアドレス */ -}}
            {{- $id := . | replaceRE $pattern `$2` -}}
            {{- /* ヘッダー名 */ -}}
            {{- $header := . | replaceRE $pattern `$3` | safeHTML -}}
            {{- $prev_depth := $scratch.Get "prev_depth" -}}
            {{- /* h2 のとき */ -}}
            {{- if eq $depth `2` -}}
                {{- /* 直前の h タグが h2 のとき */ -}}
                {{- if eq $prev_depth `2` -}}
                    </li>
                {{- /* 直前の h タグが h3 のとき */ -}}
                {{- else if eq $prev_depth `3` -}}
                    </ul></li>
                {{- end -}}
                <li><a href="#{{ $id }}">{{ $header }}</a>
            {{- /* h3 のとき */ -}}
            {{- else if eq $depth `3` -}}
                {{- /* 直前の h タグが h2 のとき */ -}}
                {{- if eq $prev_depth `2` -}}
                    <ul>
                {{- end -}}
                <li><a href="#{{ $id }}">{{ $header }}</a></li>
            {{- end -}}
            {{- $scratch.Set "prev_depth" $depth -}}
        {{- end -}}
        {{- $prev_depth := $scratch.Get "prev_depth" -}}
        {{- /* 直前の h タグが h2 のとき */ -}}
        {{- if eq $prev_depth `2` -}}
            </li>
        {{- /* 直前の h タグが h3 のとき */ -}}
        {{- else if eq $prev_depth `3` -}}
            </ul></li>
        {{- end -}}
    </ul>
</nav>

関連記事

【Hugo】ブログにマウスオーバーでふわっと表示する吹き出しを追加

【Hugo】ブログにマウスオーバーでふわっと表示する吹き出しを追加


これだけ(これ以上)のことをたった一行.TableOfContentsでやってくれるのはありがたいですね笑

読んでくださりありがとうございました!

それでは~👋