跳至主要内容

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

您可以选择 Markdown 处理器,以决定 Markdown 在您的 GitHub Pages 站点上的渲染方式。

谁可以使用此功能?

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

注意

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

拥有仓库写入权限的人员可以为 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. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

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

延伸阅读

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