Jekyll を設定する
GitHub Pages は、GitHub Free のパブリックリポジトリ、GitHub Pro のパブリックおよびプライベートリポジトリ、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Server で利用いただけます。
Jekyll の設定のほとんどは、_config.yml ファイルを編集して設定できます。
Jekyll でサイトを設定する方法の詳細については、公式の Jekyll 設定ドキュメンテーションを参照してください。 デフォルトおよびオプションの Jekyll プラグインについては、「Jekyll プラグインを設定する」を参照してください。
変更可能なデフォルト値
以下のデフォルト値が GitHub Enterprise により設定されています。この値は、_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 Pages および 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 Pagesのリポジトリメタデータ を参照してください。
source設定を変更した場合、ページが正しくビルドされない場合があります。 GitHub Pagesは、リポジトリの最上位にあるソースファイルのみを処理します。
フロントマターは必須です
Jekyll では、各 Markdown ファイルの先頭で「フロントマター」を定義しておく必要があります。 フロントマターとは単なるメタデータの集まりで、以下のように 3 つの連続したダッシュで区切られています。
* * *
title: This is my title
## layout: post
Here is my page.
<br />Front matter を省略することもできますが、その場合でも以下のように 3 つの連続したダッシュは必要です。
## \---
Here is my page. ```
ファイルが *_posts* ディレクトリ内にある場合には、ダッシュを完全に省くことができます。
Front matter に関する詳しい情報については、公式の [Jekyll Front matter ドキュメンテーション](http://jekyllrb.com/docs/frontmatter/)を参照してください。
### 参考リンク
- [Jekyll プラグインの設定](/articles/configuring-jekyll-plugins)