Jekyll を使用して GitHub Pages サイトをローカルでテストする

リポジトリへの書き込み権限があるユーザは、GitHub Pages サイトをローカルでテストできます。

必要な環境

Jekyll を使用してサイトをテストする前に、以下の操作が必要です。

Jekyll をインストールする。
Jekyll サイトを作成する。詳しい情� �については、「Jekyll を使用して GitHub Pages サイトを作成する」を参照してく� さい。

Jekyll をインストールし動作させるのには Bundler を使うようおすすめします。 Bundler は、Ruby gem の依存関係を管理し、Jekyll ビルドのエラーを減少させ、環境に関係するバグを防止します。以下はBundlerのインストール手� �です。

Rubyをインストールしてく� さい。詳しい情� �については、Rubyのドキュメンテーションの「Rubyのインストール」を参照してく� さい。
Bundlerをインストールしてく� さい。詳しい情� �については「Bundler」を参照してく� さい。

参考: Bundler を使って Jekyll をインストールしようとしている時に Ruby のエラーがある� �合、Ruby のインストールをマネージするために、RVM または Homebrew などのパッケージマネージャーが必要になる可能性があります。詳しい情� �については、Jekyllのドキュメンテーションの「トラブルシューティング」を参照してく� さい。

サイトをローカルでビルドする

ターミナルターミナルGit Bashを開いてく� さい。
サイトの公開ソースにアクセスしてく� さい。公開元に関する詳しい情� �については、「GitHub Pages について」を参照してく� さい。
bundle install を実行します。

ローカルで Jekyll サイトを実行します.

$ bundle exec jekyll serve
> Configuration file: /Users/octocat/my-site/_config.yml
>            Source: /Users/octocat/my-site
>       Destination: /Users/octocat/my-site/_site
> Incremental build: disabled. Enable with --incremental
>      Generating...
>                    done in 0.309 seconds.
> Auto-regeneration: enabled for '/Users/octocat/my-site'
> Configuration file: /Users/octocat/my-site/_config.yml
>    Server address: http://127.0.0.1:4000/
>  Server running... press ctrl-c to stop.

サイトをプレビューするには、ウェブブラウザで http://localhost:4000 を開きます。

ノート: Ruby 3.0及びJekyll 4.2.xあるいはそれより古いものを使っているなら、bundle installを実行する前にプロジェクトのGemfileにwebrick gemを追� する必要があります。

GitHub Pages gem の更新

Jekyll は、� �繁に更新されているアクティブなオープンソースプロジェクトです。お使いのコンピュータ上の github-pages gem が GitHub Pages サーバー上の github-pages gem と比較して古くなっている� �合は、ローカルでビルドしたときと GitHub Enterprise Server に公開したときで、サイトの見え方が異なることがあります。こうならないように、お使いのコンピュータ上の github-pages gem は常にアップデートしておきましょう。

ターミナルターミナルGit Bashを開いてく� さい。
github-pages gem をアップデートします。
- Bundler をインストールしている� �合は、bundle update github-pages を実行します。
- Bundler をインストールしていない� �合は、gem update github-pages を実行します。

参考リンク

Jekyll ドキュメンテーションの GitHub Pages