ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

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

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

GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server.

ここには以下の内容があります:

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

必要な環境

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

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

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

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

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

  1. ターミナルターミナルGit Bashを開いてください。
  2. サイトの公開ソースにアクセスしてください。 公開元に関する詳しい情報については、「GitHub Pages について」を参照してください。
  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.
  4. サイトをプレビューするには、ウェブブラウザで 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 を実行します。

参考リンク

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.