Setting a Markdown processor for your GitHub Pages site using Jekyll

People with write permissions for a repository can set the Markdown processor for a GitHub Pages site.

GitHub Pages supports two Markdown processors: kramdown and GitHub's own Markdown processor, which is used to render GitHub Flavored Markdown (GFM) throughout GitHub. For more information, see "About writing and formatting on GitHub."

You can use GitHub Flavored Markdown with either processor, but only our GFM processor will always match the results you see on GitHub.

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

2. In your repository, browse to the _config.yml file.

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

4. Find the line that starts with markdown: and change the value to kramdown or GFM.

5. 在页面底部，输入一条简短、有意义的提交消息，描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 更多信息请参阅“创建有多个合作作者的提交”。

6. 如果您有多个电子邮件地址与您的帐户相关联 GitHub.com ，请单击电子邮件地址下拉菜单并选择电子邮件地址作为 Git 作者电子邮件地址。 只有经过验证的电子邮件地址才会出现在此下拉菜单中。 如果您启用了电子邮件地址隐私保护，则 <username>@users.noreply.github.com 为默认的提交作者电子邮件地址。 更多信息请参阅“设置提交电子邮件地址”。

7. 在提交消息字段下面，确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支，则应选择为提交创建新分支，然后创建拉取请求。 更多信息请参阅“创建新的拉取请求”。

8. 单击 Propose new file（提议新文件）。

Further reading

• kramdown Documentation
• GitHub Flavored Markdown Spec