目次
クリーンアップ、Hugoによる生成、Pagefindによるインデックス作成を1つのjust genレシピにまとめ、常に順番どおり実行されるようにします。元のファイルはpublic/の外に置いてください。このワークフローはビルドのたびにこのディレクトリを削除するため、誤って保存したファイルも消えます。
要点#
just genの1コマンドで、クリーンアップ、Hugo、Pagefindをこの順に実行します。justfileは、site/やnotes/と並ぶリポジトリのルートに置きます。- レシピの各行は別々のシェルで実行されるため、単独の
cdは次の行に影響しません。 public/は削除してよい出力先として扱ってください。そこから削除された未追跡ファイルはGitでは復元できません。
ビルドの順序を決める#
ビルドは、前回の出力を削除し、HugoでHTMLを生成し、PagefindでそのHTMLのインデックスを作成する、という3段階です。Pagefindは生成されたファイルを読み込むため、Hugoの後に実行する必要があります。
最初に出力を削除すれば、再ビルド後に古いページが残るのを防げます。削除しないと、ソースから取り除いた記事がpublic/に残り、検索結果に表示され続けることがあります。
この構成では、Hugo、Pagefind、Node.jsがインストール済みであることを前提としています。提供された環境はUbuntu Server 26.04 LTSで、just 1.57.0、Hugo v0.165.0+extended、Pagefind 1.5.2、Node.js v22.22.1を使用していました。これらは記録されたバージョンであり、最新版であることを示すものではありません。
justfileを追加する#
Ubuntuでjustがまだ使えない場合は、sudo apt install justでインストールします。just --versionでインストールされたバージョンを確認してください。ディストリビューションのパッケージは、上記のバージョンと異なる場合があります。
リポジトリのルートにjustfileという名前のファイルを作成します。この構成では、site/にHugoの設定とテンプレートを、notes/に記事のソースを置き、生成されたサイトをpublic/に出力します。
# 引数なしで実行したときに利用可能なレシピを表示する。
default:
@just --list
# サイトと検索インデックスを再構築する。
gen:
rm -rf public
hugo --source site --contentDir ../notes --destination ../public --minify
npx -y pagefind --site publicビルドを実行して確認する#
justで利用可能なレシピを一覧表示し、just genでサイトをビルドします。レシピ名の直前にあるコメントは、一覧に説明として表示されます。接頭辞の@はコマンド自体を出力に表示しないようにするもので、コマンドの実行結果は表示されます。
Hugoのパス指定は重要です。ソースディレクトリをsite/にすると、../notesは同階層のコンテンツディレクトリを、../publicはリポジトリのルートにある出力ディレクトリを指定します。任意の--minifyフラグは、生成されるHTMLの空白を削減します。
コマンドが完了したら、public/index.htmlが存在することを確認します。生成されたサイトをHTTPで配信し、ページ表示と検索クエリの両方をテストしてください。HTMLファイルがあるだけでは、検索インデックスが機能するとは確認できません。notes/内からjust genを実行することもできます。justは親ディレクトリをたどってjustfileを探し、デフォルトではそのファイルがあるディレクトリでレシピを実行します。
シェルの境界に注意する#
通常のレシピでは、各行が別々のシェルで実行されます。ある行にcd sub、次の行にpwdと書いても、2行目が表示するのはレシピの作業ディレクトリです。ディレクトリの変更は、最初のシェルの終了とともに失われます。
2つのコマンドで同じシェルの状態を共有する必要がある場合は、cd sub && pwdのように1行にまとめます。上記のビルドレシピでは、各コマンドにパスを明示して、この依存関係を避けています。
また、npx -y pagefindはPagefindのバージョンを固定しません。再現可能なビルドにするには、特定のバージョンをプロジェクトの依存関係としてインストールし、パッケージマニフェストとロックファイルをコミットしてください。
元のファイルをpublicに置かない#
提供された事例では、記事のソースが誤ってpublic/内に保存されていました。just genが元のファイルを削除する前に別の場所へコピーしていたため、内容は失われませんでした。そのコピーがなければ、復元には別のバックアップが必要でした。
public/はGitの無視対象だったため、ファイルを削除してもgit statusには手がかりとなる変更が表示されませんでした。無視対象の未追跡ファイルには、復元に使えるコミット履歴がありません。
実践上のルールは単純です。記事はnotes/に書き、public/内のものはすべて再生成できるものとして扱います。ビルドに失敗しても、ソースが無事ならやり直せます。ソースファイルの唯一のコピーを削除してしまうのは、別の問題です。
次のステップ#
just genを実行する前に、public/内に元のファイルがないか調べ、見つかったものをnotes/へ移動してください。
出典: https://zenn.dev/fumika_676/articles/20220236284e11
目次
