Jekyll を使用して、GitHub Pages サイトの Markdown プロセッサを設定する

リポジトリへの書き込み権限があるユーザは、GitHub Pages サイトに対して Markdown プロセッサを設定できます。

GitHub Pages は 2 つの Markdown プロセッサをサポートしています。kramdown と GitHub 独自の拡張 CommonMark プロセッサで、後者は GitHub Enterprise を通じ GitHub フレーバーの Markdown をレンダリングする際に使用されます。 詳しい情報については、「GitHubでの執筆とフォーマットについて」を参照してください。

GitHub フレーバーの Markdown はどちらのプロセッサでも使用できますが、GitHub Enterprise に表示される結果と一致するのは常に CommonMark プロセッサのみです。

1. GitHub Enterpriseで、サイトのリポジトリにアクセスしてください。

2. リポジトリの _config.yml ファイルを開きます。

3. ファイルビューの右上の隅で、 をクリックしてファイルエディタを開きます。

   

4. markdown で始まる行を見つけ、値を kramdown または GFMに変更します。

   

5. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。

   

6. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチが master であれば、コミット先として新しいブランチを作成することを選択し、続いてプルリクエストを作成しなければなりません。 詳しい情報については「新しいプルリクエストの作成」を参照してください。

   

7. Propose new file（新規ファイルの提案）をクリックしてください。

   

参考リンク

• kramdown のドキュメント
• GitHub Flavored Markdown の仕様