デフォルトのGitHub Pagesではアンダースコアから始まるファイルは閲覧できない

しばらく、GitHub Pagesを触っていなかったので取り残されていたのですが、ProjectリポジトリでのGitHub Pages利用がより柔軟に利用できるようになっていました。

上記以前は、Projectリポジトリではgh-pagesブランチを用意する必要があった為一手間かかりましたが、
masterブランチも設定可能になったのでより使いやすくなりました。

いざ、運用を始めてハマったことがあったので備忘録。
GitHub PagesはJekyllで運用されている為、Jekyllの命名規則が適応されます。
Jekyllでは_(アンダースコア、アンダーバー)でから始まるディレクトリは特別な扱いをうけるようで、
ファイルが存在しても参照することができません。

公式ドキュメントに回避策の記載があります。

  • root パスに .nojekyll ファイルを含めて Jekyll をオフにする
  • _config.yml で インクルードディレクティブを使用して、無視すべきではないファイルを指定する
  • アンダースコア (_)、ピリオド (.)、またはハッシュ記号 (#) で始まる、またはティルダ (~) で終わる名前のファイルやディレクトリを使用しない
GitHub PagesとJekyllについて - GitHub ヘルプ]

Web制作者のためのGitHubの教科書 チームの効率を最大化する共同開発ツール Web制作者のための教科書シリーズ

Web制作者のためのGitHubの教科書 チームの効率を最大化する共同開発ツール Web制作者のための教科書シリーズ