跳至主要内容

使用 Jekyll 向您的 GitHub Pages 站点添加内容

您可以向 GitHub Pages 上的 Jekyll 站点添加新页面或文章。

谁可以使用此功能?

GitHub Pages 在公共仓库中可使用 GitHub Free 和组织的 GitHub Free;在公共和私有仓库中可使用 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server。欲了解更多信息,请参阅 GitHub 的套餐

注意

虽然 github-pages gem 在某些工作流中仍受支持,但现在推荐使用 GitHub Actions 来部署和自动化 GitHub Pages 站点。

拥有仓库写权限的人员可以使用 Jekyll 向 GitHub Pages 站点添加内容。

Jekyll 站点中的内容概述

在您能够向 GitHub Pages 上的 Jekyll 站点添加内容之前,必须先创建一个 Jekyll 站点。更多信息请参阅 使用 Jekyll 创建 GitHub Pages 站点

Jekyll 站点的主要内容类型是页面(pages)和文章(posts)。页面用于不关联特定日期的独立内容,例如“关于”页面。默认的 Jekyll 站点包含一个名为 about.md 的文件,该文件会在您站点的 YOUR-SITE-URL/about 处渲染为页面。您可以编辑该文件的内容以个性化您的“关于”页面,并且可以将该“关于”页面作为模板来创建新页面。更多信息请参阅 Jekyll 文档中的 Pages

文章是博客文章。默认的 Jekyll 站点包含一个名为 _posts 的目录,其中有一个默认的文章文件。您可以编辑该文章的内容,并且可以将默认文章作为模板来创建新文章。更多信息请参阅 Jekyll 文档中的 Posts

您的主题包含默认的布局和样式表,这些会自动应用到站点上的新页面和文章,但您可以覆盖这些默认设置。更多信息请参阅 关于 GitHub Pages 和 Jekyll

要为站点上的页面或文章设置变量和元数据(例如标题和布局),您可以在任意 Markdown 或 HTML 文件的顶部添加 YAML Front Matter。更多信息请参阅 Jekyll 文档中的 Front Matter

如果您从分支发布,当更改合并到站点的发布源时,站点的更改会自动发布。若您使用自定义 GitHub Actions 工作流发布,只要工作流被触发(通常是对默认分支的推送),更改就会发布。若您想先预览更改,可以在本地而非 GitHub 上进行更改,然后在本地测试站点。欲了解更多信息,请参阅 在本地使用 Jekyll 测试您的 GitHub Pages 站点

向站点添加新页面

  1. 在 GitHub 上,前往您站点的仓库。

  2. 为您的站点导航到发布源。欲了解更多信息,请参阅 配置 GitHub Pages 站点的发布源

  3. 在发布源的根目录中,为您的页面创建一个新文件,命名为 PAGE-NAME.md,将 PAGE-NAME 替换为有意义的页面文件名。

  4. 在文件顶部添加以下 YAML Front Matter,将 PAGE-TITLE 替换为页面标题,将 URL-PATH 替换为您希望的页面 URL 路径。例如,如果您站点的基础 URL 为 https://octocat.github.io,且您的 URL-PATH 为 /about/contact/,则您的页面将位于 https://octocat.github.io/about/contact

    layout: page
    title: "PAGE-TITLE"
    permalink: /URL-PATH
    
  5. 在 Front Matter 下面,添加页面内容。

  6. 点击 提交更改...

  7. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  8. 如果您的 GitHub 账户关联了多个电子邮件地址,请点击电子邮件地址下拉菜单并选择要用作 Git 作者电子邮件地址的邮箱。仅已验证的电子邮件地址会出现在此下拉菜单中。如果您启用了电子邮件地址隐私,则默认的提交作者电子邮件地址将是 “no‑reply”。有关 no‑reply 邮箱的具体形式,请参阅 设置提交电子邮件地址

    Screenshot of a GitHub pull request showing a dropdown menu with options to choose the commit author email address. octocat@github.com is selected.

  9. 在提交信息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,建议为提交创建一个新分支,然后发起拉取请求。欲了解更多信息,请参阅 创建拉取请求

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  10. 点击 提交更改提议更改

  11. 为您提议的更改创建拉取请求。

  12. 在“Pull Requests”列表中,单击您想要合并的拉取请求。

  13. 单击 Merge pull request。更多信息请参阅 合并拉取请求

  14. 如果出现提示,请输入提交信息,或接受默认信息。

  15. 单击 Confirm merge

  16. (可选)删除该分支。更多信息请参阅 在仓库中创建和删除分支

向站点添加新文章

  1. 在 GitHub 上,前往您站点的仓库。

  2. 为您的站点导航到发布源。欲了解更多信息,请参阅 配置 GitHub Pages 站点的发布源

  3. 进入 _posts 目录。

  4. 创建一个新文件,命名为 YYYY-MM-DD-NAME-OF-POST.md,将 YYYY-MM-DD 替换为文章日期,将 NAME-OF-POST 替换为文章标题。

  5. 在文件顶部添加以下 YAML Front Matter,其中包括用引号括起的文章标题、以 YYYY-MM-DD hh:mm:ss -0000 格式表示的发布日期和时间,以及您想为文章设置的任意数量的分类。

    layout: post
    title: "POST-TITLE"
    date: YYYY-MM-DD hh:mm:ss -0000
    categories: CATEGORY-1 CATEGORY-2
    
  6. 在 Front Matter 下面,添加文章内容。

  7. 点击 提交更改...

  8. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  9. 如果您的 GitHub 账户关联了多个电子邮件地址,请点击电子邮件地址下拉菜单并选择要用作 Git 作者电子邮件地址的邮箱。仅已验证的电子邮件地址会出现在此下拉菜单中。如果您启用了电子邮件地址隐私,则默认的提交作者电子邮件地址将是 “no‑reply”。有关 no‑reply 邮箱的具体形式,请参阅 设置提交电子邮件地址

    Screenshot of a GitHub pull request showing a dropdown menu with options to choose the commit author email address. octocat@github.com is selected.

  10. 在提交信息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,建议为提交创建一个新分支,然后发起拉取请求。欲了解更多信息,请参阅 创建拉取请求

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  11. 点击 提交更改提议更改

  12. 为您提议的更改创建拉取请求。

  13. 在“Pull Requests”列表中,单击您想要合并的拉取请求。

  14. 单击 Merge pull request。更多信息请参阅 合并拉取请求

  15. 如果出现提示,请输入提交信息,或接受默认信息。

  16. 单击 Confirm merge

  17. (可选)删除该分支。更多信息请参阅 在仓库中创建和删除分支

您的文章现在应该已经发布到站点上!如果您站点的基础 URL 为 https://octocat.github.io,则新文章的地址为 https://octocat.github.io/YYYY/MM/DD/TITLE.html

后续步骤

您可以为 GitHub Pages 站点添加 Jekyll 主题,以自定义站点的外观和感觉。更多信息,请参阅 使用 Jekyll 为 GitHub Pages 站点添加主题

© . This site is unofficial and not affiliated with GitHub, Inc.