使用 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. 要预览您的网站，请在您的网络浏览器中导航到 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 文档中