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

Markdown プロセッサを選択して、GitHub Pages サイトで Markdown をどのようにレンダリングするかを決めることができます。

この機能を使用できるユーザーについて

GitHub Pagesは、パブリック・リポジトリのGitHub Freeと組織用のGitHub Free、パブリック・リポジトリとプライベート・リポジトリのGitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverで利用できます。

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

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

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

  1. GitHub Enterprise Serverで、サイトのリポジトリにアクセスしてください。
  2. リポジトリで _config.yml ファイルを参照します。
  3. ファイル ビューの右上隅にある をクリックしてファイル エディターを開きます。

ファイルのスクリーンショット。 ヘッダーにある鉛筆アイコンのラベルが付いたボタンが濃いオレンジ色の枠線で囲まれています。

  1. markdown: で始まる行を見つけ、値を kramdown または GFM に変更します。 完全な行は markdown: kramdown または markdown: GFM となります。

  2. [変更のコミット...] をクリックします。

  3. [コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」を参照してください。

  4. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「pull request の作成」を参照してください。

    GitHub pull request のスクリーンショット。メイン ブランチに直接コミットする、または新しいブランチを作成するためのラジオ ボタンが表示されています。 新しいブランチが選ばれています。

  5. [変更のコミット] または [変更の提案] をクリックします。

参考資料