Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-01-18. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせく� さい

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

GitHub Pages サイトをローカルでビルドすると、サイトに対する変更のプレビューとテストを行うことができます。

GitHub Pagesは、GitHub Free及びOrganizationのGitHub Freeのパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverのパブリック及びプライベートリポジトリで利用できます。

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

前提条件

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

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

  1. Ruby をインストールします。 詳細については、Ruby ドキュメントの「Installing Ruby」 (Ruby のインストール) を参照してく� さい。
  2. Bundlerをインストールしてく� さい。 詳細については、「Bundler」を参照してく� さい。

ヒント: Bundler を使用して Jekyll をインストールしようとしたときに Ruby エラーが表示された� �合は、RVMHomebrew などのパッケージ マネージャーを使用して Ruby のインストールを管理することが必要になる� �合があります。 詳細については、Jekyll ドキュメントのトラブルシューティングを参照してく� さい。

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

  1. [ターミナル][ターミナル][Git Bash] を開きます。 1. サイトの公開ソースにアクセスしてく� さい。 詳細については、「ご利用の GitHub Pages サイトに合わせた公開元の構成」を参照してく� さい。

  2. bundle install を実行します。

  3. ローカルで 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 をもう一度実行します。

  4. サイトをプレビューするには、Web ブラウザーで http://localhost:4000 に移動します。

GitHub Pages gem の更新

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

  1. [ターミナル][ターミナル][Git Bash] を開きます。
  2. github-pages gem を更新します。
    • Bundler をインストールしている� �合、bundle update github-pages を実行します。
    • Bundler をインストールしていない� �合、gem update github-pages を実行します。

参考資料