Skip to main content

使用 Jekyll 创建 GitHub Pages 站点

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

Who can use this feature

People with admin permissions for a repository can create a GitHub Pages site with Jekyll.

GitHub Pages 适用于具有 GitHub AE 的内部和私有仓库。 GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。

先决条件

必须安装 Jekyll 和 Git 后才可使用 Jekyll 创建 GitHub Pages 站点。 有关详细信息,请参阅 Jekyll 文档中的安装和“设置 Git”。

建议使用 Bundler 安装和运行 Jekyll。 Bundler 可管理 Ruby gem 依赖项,减少 Jekyll 构建错误和阻止环境相关的漏洞。 要安装 Bundler:

  1. 安装 Ruby。 有关详细信息,请参阅 Ruby 文档中的“安装 Ruby”。
  2. 安装 Bundler。 有关详细信息,请参阅“Bundler”。

提示: 如果你在尝试使用 Bundler 安装 Jekyll 时看到 Ruby 错误,则可能需要使用包管理器(例如 RVMHomebrew)来管理你的 Ruby 安装。 有关详细信息,请参阅 Jekyll 文档中的“故障排除”。

为站点创建仓库

可以为站点创建存储库或选择现有存储库。

如果存储库中并非所有文件都与站点相关,且要为存储库创建 GitHub Pages 站点,则能够为站点配置发布源。 例如,可以使用专用分支和文件夹保存站点源文件。

如果要在现有存储库中创建站点,请跳至“创建站点”一节。

  1. 在任何页面的右上角,使用 下拉菜单选择“新建存储库”。 包含创建新存储库选项的下拉菜单 1. 使用“所有者”下拉菜单选择你想要拥有存储库的帐户。 “所有者”下拉菜单 1. 输入仓库的名称和说明(可选)。 如果要创建用户或组织站点,则存储库必须命名为 <user>.github.io<organization>.github.io。 如果您的用户或组织名称包含大写字母,您必须小写字母。 有关详细信息,请参阅“关于 GitHub Pages”。 创建存储库字段 1. 选择仓库可见性。 有关详细信息,请参阅“关于存储库”。 用于选择存储库可见性的单选按钮

创建站点

必须先在 GitHub AE 上有站点的仓库,然后才可创建站点。 如果未在现有存储库中创建站点,请参阅“为站点创建存储库”。

警告:GitHub Pages 站点对所有企业成员可见,即使该站点的存储库是私有的也是如此。 如果站点的存储库中有敏感数据,你可能想要在发布前删除数据。 有关详细信息,请参阅关于存储库

  1. 打开终端终端Git Bash

  2. 如果还没有本地版存储,请导航到想要存储站点源文件的位置,将 PARENT-FOLDER 替换为要包含存储库文件夹的文件夹。

    $ cd PARENT-FOLDER
  3. 如果尚未初始化本地 Git 存储库,请将 REPOSITORY-NAME 替换为存储库名称。

    $ git init REPOSITORY-NAME
    > Initialized empty Git repository in /Users/octocat/my-site/.git/
    # Creates a new folder on your computer, initialized as a Git repository
  4. 将目录更改为仓库。

    $ cd REPOSITORY-NAME
    # Changes the working directory
  5. 确定要使用的发布源。 有关详细信息,请参阅“为 GitHub Pages 站点配置发布源”。 1. 导航到站点的发布来源。 有关详细信息,请参阅“为 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
  6. 若要创建新 Jekyll 站点,请使用 jekyll new 命令:

    $ jekyll new --skip-bundle .
    # Creates a Jekyll site in the current directory
  7. 打开 Jekyll 创建的 Gemfile 文件。

  8. 将“#”添加到以 gem "jekyll" 开头的行首,以注释禁止此行。

  9. 编辑以 # 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 的依赖项。

  10. 保存并关闭 Gemfile。

  11. 从命令行中,运行 bundle install

  12. (可选)对 _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
    
  13. (可选)在本地测试您的站点。 有关详细信息,请参阅“使用 Jekyll 在本地测试 GitHub Pages 站点”。

  14. 添加并提交您的工作。

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  15. 将 GitHub AE 上的存储库添加为远程存储库,将 HOSTNAME 替换为企业的主机名, 将 USER 替换为拥有该存储库的帐户,并将 REPOSITORY 替换为存储库名称 。

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    
  16. 将存储库推送到 GitHub AE,将 BRANCH 替换为所操作的分支的名称。

    $ git push -u origin BRANCH
  17. 配置发布源。 有关详细信息,请参阅“为 GitHub Pages 站点配置发布源”。 1. 在 GitHub AE 上,导航到站点的仓库。 1. 在存储库名称下,单击 “设置”。 “存储库设置”按钮

  18. In the left sidebar, click Pages. Page tab in the left-hand sidebar

  19. 要查看您已发布的站点,请在“GitHub Pages”下点击您的站点 URL。 已发布站点的 URL

    注意: 对站点的更改在推送到 GitHub AE 后,最长可能需要 10 分钟才会发布。 如果一小时后仍然在浏览器中看不到 GitHub Pages 站点更改,请参阅“关于 GitHub Pages 站点的 Jekyll 生成错误”。

注意:If站点尚未自动发布,请确保具有管理员权限和经验证的电子邮件地址的人员已将站点推送到发布源。

后续步骤

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

您可以将 Jekyll 主题添加到 GitHub Pages 站点,以自定义站点的外观。 有关详细信息,请参阅“使用 Jekyll 将主题添加到 GitHub Pages 站点”。