使用 Jekyll 创建 GitHub Pages 站点

您可以使用 Jekyll 在新的或现有的仓库中创建 GitHub Pages 站点。

谁可以使用此功能？

拥有仓库管理员权限的人员可以使用 Jekyll 创建 GitHub Pages 站点。

GitHub Pages 可用于具有 GitHub Free 和 GitHub Free for organizations 的公共仓库，以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。有关更多信息，请参阅“GitHub 的套餐”。

GitHub Pages 现在使用 GitHub Actions 来执行 Jekyll 构建。当使用分支作为构建源时，如果您想使用内置的 Jekyll 工作流程，则必须在您的仓库中启用 GitHub Actions。或者，如果 GitHub Actions 不可用或已禁用，则将.nojekyll文件添加到源分支的根目录将绕过 Jekyll 构建过程并直接部署内容。有关启用 GitHub Actions 的更多信息，请参阅“管理仓库的 GitHub Actions 设置”。

平台导航

本文内容

注意

组织所有者可以限制从组织拥有的仓库发布 GitHub Pages 站点。有关更多信息，请参阅“管理组织的 GitHub Pages 站点发布”。

先决条件

在您可以使用 Jekyll 创建 GitHub Pages 站点之前，您必须安装 Jekyll 和 Git。有关更多信息，请参阅 Jekyll 文档中的安装和“设置 Git”。

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

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

提示

如果您尝试使用 Bundler 安装 Jekyll 时看到 Ruby 错误，您可能需要使用包管理器（例如RVM或Homebrew）来管理您的 Ruby 安装。有关更多信息，请参阅 Jekyll 文档中的“故障排除”。

为您的站点创建仓库

您可以创建一个仓库或为您的站点选择一个现有仓库。

如果您想为一个仓库创建 GitHub Pages 站点，而该仓库中并非所有文件都与站点相关，则您可以为您的站点配置发布源。例如，您可以拥有一个专门用于存放站点源文件的分支和文件夹，或者您可以使用自定义 GitHub Actions 工作流程来构建和部署您的站点源文件。

如果拥有仓库的帐户使用 GitHub Free 或 GitHub Free for organizations，则仓库必须是公开的。

如果您想在现有仓库中创建站点，请跳至“创建您的站点”部分。

在任何页面的右上角，选择，然后单击**新建仓库**。
使用**所有者**下拉菜单选择您希望拥有该仓库的帐户。
输入仓库的名称和可选说明。如果您正在创建用户或组织站点，则您的仓库必须命名为<user>.github.io或<organization>.github.io。如果您的用户名或组织名称包含大写字母，则必须将字母小写。有关更多信息，请参阅“关于 GitHub Pages”。
选择仓库可见性。有关更多信息，请参阅“关于仓库”。

创建您的站点

在您可以创建站点之前，您必须在 GitHub 上拥有站点的仓库。如果您不是在现有仓库中创建站点，请参阅“为您的站点创建仓库”。

警告

GitHub Pages 站点可公开访问互联网，即使站点的仓库是私有的（如果您的计划或组织允许）。如果您的站点仓库中包含敏感数据，您可能需要在发布前删除这些数据。有关更多信息，请参阅“关于仓库”。

打开终端终端Git Bash。
如果您还没有本地仓库副本，请导航到您希望存储站点源文件的目录，将 PARENT-FOLDER 替换为您希望包含仓库文件夹的文件夹。
```
cd PARENT-FOLDER
```

如果您还没有，请初始化一个本地 Git 仓库，将 REPOSITORY-NAME 替换为您的仓库名称。

$ git init REPOSITORY-NAME
> Initialized empty Git repository in /REPOSITORY-NAME/.git/
# Creates a new folder on your computer, initialized as a Git repository

将目录更改为仓库。

$ cd REPOSITORY-NAME
# Changes the working directory

确定要使用哪个发布源。有关更多信息，请参阅“为您的 GitHub Pages 站点配置发布源”。
导航到站点的发布源。有关更多信息，请参阅“为您的 GitHub Pages 站点配置发布源”。例如，如果您选择从默认分支的docs文件夹发布您的站点，请创建并更改到docs文件夹。
```
$ mkdir docs
# Creates a new folder called docs
$ cd docs
```
如果您选择从gh-pages分支发布您的站点，请创建并检出gh-pages分支。
```
$ git checkout --orphan gh-pages
# Creates a new branch, with no history or contents, called gh-pages, and switches to the gh-pages branch
$ git rm -rf .
# Removes the contents from your default branch from the working directory
```
要创建一个新的 Jekyll 站点，请在您的仓库的根目录中使用jekyll new命令
```
$ jekyll new --skip-bundle .
# Creates a Jekyll site in the current directory
```
打开 Jekyll 创建的 Gemfile。
在以gem "jekyll"开头的行首添加“#”以注释掉此行。
通过编辑以# gem "github-pages"开头的行来添加github-pages gem。将此行更改为
```
gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins
```
将 GITHUB-PAGES-VERSION 替换为github-pages gem 的最新支持版本。您可以在此处找到此版本：“依赖项版本”。

正确的 Jekyll 版本将作为github-pages gem 的依赖项安装。
保存并关闭 Gemfile。
从命令行运行bundle install。
打开 Jekyll 创建的.gitignore文件，并通过添加以下行来忽略 gems 锁定文件
```
Gemfile.lock
```

可选：对_config.yml文件进行任何必要的编辑。当仓库托管在子目录中时，这对于相对路径是必需的。有关更多信息，请参阅“将子文件夹拆分为新仓库”。

domain: my-site.github.io       # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com
url: https://my-site.github.io  # the base hostname and protocol for your site, e.g. http://example.com
baseurl: /REPOSITORY-NAME/      # place folder name if the site is served in a subfolder

可选地，您可以在本地测试您的站点。更多信息，请参阅“使用 Jekyll 在本地测试您的 GitHub Pages 站点”。

添加并提交您的工作。

git add .
git commit -m 'Initial GitHub pages site with Jekyll'

将您的 GitHub.com 仓库添加为远程仓库，将 USER 替换为拥有该仓库的帐户，将 REPOSITORY 替换为仓库的名称。
```
$ git remote add origin https://github.com/USER/REPOSITORY.git
```
将仓库推送到 GitHub，将 BRANCH 替换为您正在使用的分支的名称。
```
git push -u origin BRANCH
```
配置您的发布源。更多信息，请参阅“配置 GitHub Pages 站点的发布源”。
在 GitHub 上，导航到您的站点的仓库。
在您的仓库名称下，单击设置。如果您看不到“设置”选项卡，请选择下拉菜单，然后单击设置。
在侧边栏的“代码和自动化”部分，单击 Pages。
要查看已发布的站点，在“GitHub Pages”下，单击访问站点。

注意：将更改推送到 GitHub 后，您的站点发布可能需要长达 10 分钟的时间。如果您在一小时后仍然没有在浏览器中看到 GitHub Pages 站点更改，请参阅“关于 GitHub Pages 站点的 Jekyll 构建错误”。
您的 GitHub Pages 站点使用 GitHub Actions 工作流进行构建和部署。更多信息，请参阅“查看工作流运行历史记录”。

注意

对于公共仓库，GitHub Actions 是免费的。对于超出每月免费分钟数配额的私有和内部仓库，将收取使用费。更多信息，请参阅“使用限制、计费和管理”。

注意

如果您是从分支发布，并且您的站点尚未自动发布，请确保拥有管理员权限并已验证电子邮件地址的用户已将更改推送到发布源。
使用GITHUB_TOKEN的 GitHub Actions 工作流推送的提交不会触发 GitHub Pages 构建。

后续步骤

要向您的站点添加新页面或帖子，请参阅“使用 Jekyll 向您的 GitHub Pages 站点添加内容”。

您可以向您的 GitHub Pages 站点添加 Jekyll 主题以自定义站点的外观和风格。更多信息，请参阅“使用 Jekyll 向您的 GitHub Pages 站点添加主题”。