リポジトリへの書き込み権限があるユーザは、GitHub Pages サイトをローカルでテストできます。
前提条件
Jekyll を使用してサイトをテストする前に、以下の操作が必要です。 * Jekyll をインストールする。
- Jekyll サイトを作成する。 詳しくは、「Jekyll を使用して GitHub Pages サイトを作成する」をご覧ください。
データ 再利用可能ページ.推奨バンドラー %}
ヒント
Bundler を使って Jekyll をインストールしようとすると Ruby エラーが発生する場合は、RVM や Homebrew などのパッケージ マネージャーを使って Ruby のインストールを管理することが必要な場合があります。 詳しくは、Jekyll のドキュメントでトラブルシューティングに関する説明を参照してください。
サイトをローカルでビルドする
-
[ターミナル][ターミナル][Git Bash] を開きます。1. サイトの公開ソースにアクセスしてください。 詳しくは、「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.メモ
-
Ruby 3.0 以降をインストールした場合 (Homebrew を使用して既定のバージョンをインストールした場合に発生することがあります)、この手順でエラーが発生するおそれがあります。 これは、これらのバージョンの Ruby には、
webrickがインストールされなくなったためです。エラーを修正するには、
bundle add webrickを実行してからbundle exec jekyll serveをもう一度実行します。
`_config.yml` ファイルの `baseurl` フィールドにGitHub リポジトリのリンクが含まれている場合は、ローカルでビルドするときに次のコマンドを使用して、その値を無視し、`localhost:4000/` でサイトを提供できます。bundle exec jekyll serve --baseurl="" -
-
サイトをプレビューするには、Web ブラウザーで
http://localhost:4000に移動します。
GitHub Pages gem の更新
メモ
github-pages gem は一部のワークフローで引き続きサポートされますが、GitHub Pages サイトのデプロイと自動化のための推奨される方法は GitHub Actions になりました。
Jekyll は、頻繁に更新されるアクティブなopen source プロジェクトです。 お使いのコンピューター上の github-pages gem が GitHub Pages サーバー上の github-pages gem と比較して古くなっている場合は、ローカルでビルドしたときと GitHub に公開したときで、サイトの見え方が異なることがあります。 これを回避するには、お使いのコンピューターで github-pages gem を定期的に更新します。
- [ターミナル][ターミナル][Git Bash] を開きます。
-
`github-pages` gem を更新します。- Bundler をインストールしている場合、
bundle update github-pagesを実行します。 - Bundler をインストールしていない場合、
gem update github-pagesを実行します。
- Bundler をインストールしている場合、
参考資料
-
Jekyll ドキュメントの [GitHub Pages](https://jekyllrb.com/docs/github-pages/)