Skip to main content

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

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

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

  1. 在 GitHub 上,导航到站点的仓库。

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

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

    编辑文件按钮

    注意:除了使用默认文件编辑器编辑和提交文件,还可以选择使用 github.dev 代码编辑器,方法是单击 旁边的下拉菜单并选择“在 github.dev 中打开” 。

    编辑文件按钮下拉菜单

  4. 找到以 markdown: 开头的行,然后将值更改为 kramdownGFMconfig.yml 中的 Markdown 设置 1. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建具有多个共同作者的提交”。 更改的提交消息

  5. If you have more than one email address associated with your account on GitHub.com, click the email address drop-down menu and select the email address to use as the Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then <username>@users.noreply.github.com is the default commit author email address. For more information, see "Setting your commit email address." Choose commit email addresses

  6. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建新的拉取请求”。 提交分支选项 1. 单击“提供新文件”。 “提供新文件”按钮

延伸阅读