Testing your GitHub Pages site locally with Jekyll

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

• 必要な環境
• サイトをローカルでビルドする
• Updating the GitHub Pages gem
• 参考リンク

Anyone with read permissions for a repository can test a GitHub Pages site locally.

必要な環境

Before you can use Jekyll to test a site, you must:

• Install Jekyll.
• Create a Jekyll site. 詳しい情報については、「Jekyll を使用して GitHub Pages サイトを作成する」を参照してください。

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

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

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

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. To preview your site, in your web browser, navigate to http://localhost:4000.

Updating the GitHub Pages gem

Jekyll is an active open source project that is updated frequently. If the github-pages gem on your computer is out of date with the github-pages gem on the GitHub Pages server, your site may look different when built locally than when published on GitHub Enterprise. To avoid this, regularly update the github-pages gem on your computer.

1. ターミナルターミナルGit Bashを開いてください。

2. Update the github-pages gem.

   • If you installed Bundler, run bundle update github-pages.
   • If you don't have Bundler installed, run gem update github-pages.

参考リンク

• GitHub Pages in the Jekyll documentation