Skip to main content

Enterprise Server 3.20 目前作为发布候选版本提供。

使用 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-pages gem 仍然支持某些工作流,但现在推荐使用 GitHub Actions 来部署 GitHub Pages 网站并实现其自动化。

拥有仓库写入权限的人可为 GitHub Pages 站点设置 Markdown 处理器。

GitHub Pages 支持两种 Markdown 处理器:kramdown 和 GitHub 自有的 Markdown 处理器,用于渲染 GitHub 风格 Markdown(GFM) 有关详细信息,请参阅“关于在GitHub上撰写和格式化”。

你可以使用任一处理器处理 GitHub 风格 Markdown

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

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

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

    文件的屏幕截图。 在标头中,标有铅笔图标的按钮以深橙色标出。

  4. 找到以 markdown: 开头的行,然后将值更改为 kramdownGFM。 整行应显示为 markdown: kramdownmarkdown: GFM

  5. 单击“提交更改...”

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

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

    GitHub 拉取请求的屏幕截图,其中显示了一个单选按钮,用于直接提交到主分支或创建新分支。 已选择“新建分支”。

  8. 单击“提交更改”或“建议更改” 。

延伸阅读

  •         [kramdown 文档](https://kramdown.gettalong.org/documentation.html)
    
  •           [GitHub 支持的 Markdown 规范](https://github.github.com/gfm/)