Testing your GitHub Pages site locally with Jekyll

You can build your GitHub 页面 site locally to preview and test changes to your site.

GitHub 页面可用于具有 GitHub Free 的公共仓库，以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。

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

基本要求

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

Install Jekyll.
Create a Jekyll site. For more information, see "Creating a GitHub 页面 site with Jekyll."

We recommend using Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler:

Install Ruby. For more information, see "Installing Ruby" in the Ruby documentation.
Install Bundler. For more information, see "Bundler."

Tip: If you see a Ruby error when you try to install Jekyll using Bundler, you may need to use a package manager, such as RVM or Homebrew, to manage your Ruby installation. For more information, see "Troubleshooting" in the Jekyll documentation.

Building your site locally

Open TerminalTerminalGit Bashthe terminal.
Navigate to the publishing source for your site. For more information about publishing sources, see "About GitHub 页面."

Run your Jekyll site locally.

$ 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.

To preview your site, in your web browser, navigate to http://localhost:4000.

Updating the GitHub 页面 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 页面 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.

Open TerminalTerminalGit Bashthe terminal.
Update the github-pages gem.
- If you installed Bundler, run bundle update github-pages.
- 如果未安装 Bundler，则运行 gem update github-pages.

延伸阅读

GitHub 页面 in the Jekyll documentation