JavaScript on Unigiri

Hugo + Lunrによる日本語全文検索

Sun, 04 Nov 2018 23:54:29 +0900

Hugoとは

Hugoとは静的ページを生成するGo製のフレームワークである。

Lunrとは

LunrとはJavaScript製のテキスト検索エンジンである。日本語検索に対応している。¹

検索機能設置方法

以降の内容は https://gist.github.com/sebz/efddfc8fdcb6b480f567 及び https://gist.github.com/eddiewebb/735feb48f50f0ddd65ae5606a1cb41ae を参考にしている。

ファイル構成

導入後のファイル構成は以下の通り。検索機能に関わる部分のみ記載している。

BLOG_DIR
├── layouts
│   ├── _default
│   │   └── index.json
│   └── index.html
└── static
    └── js
        ├── lunr.jp.js
        ├── lunr.js
        ├── lunr.multi.js
        ├── lunr.stemmer.support.js
        ├── search.js
        └── tinyseg.js

1. 検索用データ設置

Lunrが検索対象として読み込むデータを設置する。ここでは全記事のタイトル, タグ, カテゴリ, 本文, hrefをJSON形式で書き出す。

layouts/_default/index.json

{{- $.Scratch.Add "index" slice -}}
{{- range .Site.RegularPages -}}
    {{- $.Scratch.Add "index" (dict "title" (or .Title (.Date.Format "2006/01/02")) "tags" .Params.tags "categories" .Params.categories "contents" .Plain "href" .URL ) -}}
{{- end -}}
{{- $.Scratch.Get "index" | jsonify -}}

3行目の"title" (or .Title (.Date.Format "2006/01/02"))は弊サイト独自の仕様であり、通常は"title" .Titleでよい。