跳至主要内容

使用 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 构建都将从 2024 年 6 月 30 日起使用 GitHub Actions。不需要其他更改,但必须在存储库中启用 GitHub Actions 才能继续构建。有关启用 GitHub Actions 的更多信息,请参阅“管理存储库的 GitHub Actions 设置”。

具有存储库写权限的人员可以为 GitHub Pages 网站设置 Markdown 处理器。

GitHub Pages 支持两个 Markdown 处理器:kramdown 和 GitHub 自有的 Markdown 处理器,该处理器用于在整个 GitHub 中呈现GitHub 风味 Markdown (GFM)。有关更多信息,请参阅“关于在 GitHub 上书写和格式化”。

你可以将 GitHub 风味 Markdown 与任一处理器一起使用,但只有我们的 GFM 处理器始终与你在 GitHub 上看到的成果相匹配。

  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.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.

  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. 单击提交更改建议更改

进一步阅读