我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们
文章版本: GitHub.com

配置 Jekyll

GitHub 页面 可用于具有 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。更多信息请参阅“GitHub 的产品。”

通过编辑 _config.yml 文件可配置大多数 Jekyll 设置。

有关使用 Jekyll 配置站点的更多信息,请参阅官方的 Jekyll 配置文档。 有关默认和可选 Jekyll 插件的更多信息,请参阅“配置 Jekyll 插件”。

可更改的默认设置

以下默认值由 GitHub 设置,您可以在 _config.yml 文件中自由覆盖它们:

 github: [metadata]
 encoding: UTF-8
 kramdown:
   input: GFM
   hard_wrap: false
 future: true
 jailed: false
 theme: jekyll-theme-primer
 gfm_quirks: paragraph_end

无法更改的配置设置

GitHub 页面 & Jekyll 会覆盖 _config.yml 文件中的以下设置 ,您无法更改它们:

 lsi: false
 safe: true
 source: [your repo's top level directory]
 incremental: false
 highlighter: rouge
 gist:
   noscript: false
 kramdown:
   math_engine: mathjax
   syntax_highlighter: rouge

提示:

  • 有关仓库元数据对象的内容,请参阅 GitHub 页面 上的仓库元数据
  • 请记住,如果更改了 source 设置,页面可能无法正确构建。 GitHub 页面 只考虑仓库顶层目录中的源文件。

必需前页

Jekyll 要求 Markdown 文件具有在每个文件顶部定义的前页。 前页只是一组元数据,以三个破折号划界:

* * *

标题:这是我的标题

## 布局:发布

此处是我的页面。

    <br />根据需要,您可以选择省略文件的前页内容,但仍需输入三个破折号:
    
    

## \---

此处是我的页面。 ```

如果您的文件在 *_posts* 目录中,您可以完全省略破折号。

有关配置前页的更多信息,请参阅官方的 [Jekyll 前页文档](http://jekyllrb.com/docs/frontmatter/)。

### 延伸阅读

- "[配置 Jekyll 插件](/articles/configuring-jekyll-plugins)"

问问别人

找不到要找的内容?

联系我们