跳至主要内容

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

您可以向 GitHub Pages 上的 Jekyll 网站添加新页面或帖子。

谁可以使用此功能?

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

从 2024 年 6 月 30 日起,所有 GitHub Pages 构建都将使用 GitHub Actions。无需进行其他更改,但必须在您的仓库中启用 GitHub Actions 才能继续构建。有关启用 GitHub Actions 的更多信息,请参阅“管理仓库的 GitHub Actions 设置”。

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

关于 Jekyll 网站中的内容

在您可以在 GitHub Pages 上的 Jekyll 网站中添加内容之前,您必须创建一个 Jekyll 网站。有关更多信息,请参阅“使用 Jekyll 创建 GitHub Pages 网站”。

Jekyll 网站的主要内容类型是页面和帖子。页面用于独立内容,与特定日期无关,例如“关于”页面。默认的 Jekyll 网站包含一个名为about.md的文件,该文件在您的网站上的YOUR-SITE-URL/about处呈现为页面。您可以编辑该文件的内容以个性化您的“关于”页面,并且可以使用“关于”页面作为模板来创建新页面。有关更多信息,请参阅 Jekyll 文档中的“页面”。

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

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

要为网站上的页面或文章设置变量和元数据(例如标题和布局),您可以在任何 Markdown 或 HTML 文件的顶部添加 YAML 前置内容。有关更多信息,请参阅 Jekyll 文档中的“前置内容”。

如果您从分支发布,则当更改合并到您网站的发布源时,您网站的更改会自动发布。如果您从自定义 GitHub Actions 工作流程发布,则更改会在您的工作流程触发时发布(通常由对默认分支的推送触发)。如果您想先预览您的更改,您可以在本地进行更改,而不是在 GitHub 上进行更改。然后,在本地测试您的网站。有关更多信息,请参阅“在本地使用 Jekyll 测试您的 GitHub Pages 网站”。

向您的网站添加新页面

  1. 在 GitHub 上,导航到您网站的存储库。

  2. 导航到您网站的发布源。有关更多信息,请参阅“配置 GitHub Pages 网站的发布源”。

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

  4. 将以下 YAML 前置内容添加到文件的顶部,将 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. 在前面内容之后,添加页面内容。

  6. 点击 **提交更改...**

  7. 在“提交信息”字段中,输入简短、有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将提交归因于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。

  8. 如果您在 GitHub.com 上的帐户中关联了多个电子邮件地址,请点击电子邮件地址下拉菜单并选择用作 Git 作者电子邮件地址的电子邮件地址。此下拉菜单中仅显示已验证的电子邮件地址。如果您启用了电子邮件地址隐私,则“无回复”将是默认的提交作者电子邮件地址。有关“无回复”电子邮件地址可能采取的确切形式的更多信息,请参阅“设置您的提交电子邮件地址”。

    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. 在“拉取请求”列表中,点击您要合并的拉取请求。

  13. 点击 **合并拉取请求**。有关更多信息,请参阅“合并拉取请求”。

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

  15. 点击 **确认合并**。

  16. 可选地,删除分支。有关更多信息,请参阅“在您的仓库中创建和删除分支”。

向您的网站添加新帖子

  1. 在 GitHub 上,导航到您网站的存储库。

  2. 导航到您网站的发布源。有关更多信息,请参阅“配置 GitHub Pages 网站的发布源”。

  3. 导航到 _posts 目录。

  4. 创建一个名为 YYYY-MM-DD-NAME-OF-POST.md 的新文件,将 YYYY-MM-DD 替换为您的帖子日期,将 NAME-OF-POST 替换为您的帖子名称。

  5. 将以下 YAML 前置内容添加到文件的顶部,包括帖子标题(用引号括起来)、帖子的日期和时间(采用 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. 在前面内容之后,添加帖子内容。

  7. 点击 **提交更改...**

  8. 在“提交信息”字段中,输入简短、有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将提交归因于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。

  9. 如果您在 GitHub.com 上的帐户中关联了多个电子邮件地址,请点击电子邮件地址下拉菜单并选择用作 Git 作者电子邮件地址的电子邮件地址。此下拉菜单中仅显示已验证的电子邮件地址。如果您启用了电子邮件地址隐私,则“无回复”将是默认的提交作者电子邮件地址。有关“无回复”电子邮件地址可能采取的确切形式的更多信息,请参阅“设置您的提交电子邮件地址”。

    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. 在“拉取请求”列表中,点击您要合并的拉取请求。

  14. 点击 **合并拉取请求**。有关更多信息,请参阅“合并拉取请求”。

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

  16. 点击 **确认合并**。

  17. 可选地,删除分支。有关更多信息,请参阅“在您的仓库中创建和删除分支”。

您的帖子现在应该已发布到您的网站上!如果您的网站基本 URL 为 https://octocat.github.io,则您的新帖子将位于 https://octocat.github.io/YYYY/MM/DD/TITLE.html

下一步

您可以将 Jekyll 主题添加到您的 GitHub Pages 网站,以自定义网站的外观和感觉。有关更多信息,请参阅 "使用 Jekyll 将主题添加到您的 GitHub Pages 网站。"。