使用 Jekyll 在本地测试您的 GitHub Pages 站点

任何具有存储库读取权限的用户都可以本地测试 GitHub Pages 站点。

先决条件

在您可以使用 Jekyll 测试站点之前，您必须

• 安装 Jekyll。
• 创建一个 Jekyll 站点。有关更多信息，请参阅“使用 Jekyll 创建 GitHub Pages 站点”。

我们建议使用 Bundler 来安装和运行 Jekyll。Bundler 管理 Ruby gem 依赖项，减少 Jekyll 构建错误，并防止环境相关的错误。要安装 Bundler：

1. 安装 Ruby。有关更多信息，请参阅 Ruby 文档中的“安装 Ruby”。
2. 安装 Bundler。有关更多信息，请参阅“Bundler”。

在本地构建您的站点

1. 打开 终端终端Git Bash。

2. 导航到站点的发布源。有关更多信息，请参阅“配置 GitHub Pages 站点的发布源”。

3. 运行 bundle install。

4. 在本地运行您的 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=""
     

5. 要在浏览器中预览您的站点，请导航到 https://127.0.0.1:4000。

更新 GitHub Pages gem

Jekyll 是一个活跃的开源项目，经常更新。如果计算机上的github-pages gem 与 GitHub Pages 服务器上的github-pages gem 不一致，则本地构建的站点在发布到 GitHub 时可能看起来有所不同。为避免这种情况，请定期更新计算机上的github-pages gem。

1. 打开 终端终端Git Bash。
2. 更新github-pages gem。
   • 如果您安装了 Bundler，请运行 bundle update github-pages。
   • 如果您没有安装 Bundler，请运行 gem update github-pages。

进一步阅读

• Jekyll 文档中的 GitHub Pages