跳至主要内容

使用 Jekyll 为您的 GitHub Pages 站点设置 Markdown 处理器

您可以选择一个 Markdown 处理器来确定如何在您的 GitHub Pages 站点上呈现 Markdown。

谁可以使用此功能?

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 站点设置 Markdown 处理器。

GitHub Pages 支持两种 Markdown 处理器:kramdown 和 GitHub 自身的 Markdown 处理器,后者用于在整个 GitHub 中呈现 GitHub Flavored Markdown (GFM)。有关详细信息,请参阅“关于在 GitHub 上撰写和格式化内容”。

您可以使用任一处理器使用 GitHub Flavored Markdown。

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

  2. 在您的存储库中,浏览到 _config.yml 文件。

  3. 在文件视图的右上角,单击以打开文件编辑器。

    Screenshot of a file. In the header, a button, labeled with a pencil icon, is outlined in dark orange.

    注意

    您可以选择使用 github.dev 代码编辑器,而不是使用默认文件编辑器编辑和提交文件,方法是选择下拉菜单并单击**github.dev**。您还可以通过单击**GitHub Desktop**克隆存储库并在本地通过 GitHub Desktop 编辑文件。

    Screenshot of a file. In the header, a downwards-facing triangle icon is outlined in dark orange.

  4. 找到以 markdown: 开头的行,并将值更改为 kramdownGFM。完整行应为 markdown: kramdownmarkdown: GFM

  5. 单击**提交更改...**

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

  7. 如果您在 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.

  8. 在提交消息字段下方,决定是将您的提交添加到当前分支还是添加到新分支。如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。有关详细信息,请参阅“创建拉取请求”。

    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.

  9. 单击**提交更改**或**提出更改**。

进一步阅读