使用 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。

5. 要在 Web 浏览器中预览网站，请导航到 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。

进一步阅读

• GitHub Pages 在 Jekyll 文档中