Enterprise Server 3.20 は、現在リリース候補として使用できます。

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 gem は一部のワークフローで引き続きサポートされますが、GitHub Pages サイトのデプロイと自動化のための推奨される方法は GitHub Actions になりました。

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

GitHub Pages は、kramdown と GitHub の独自の Markdown プロセッサという 2 つの Markdown プロセッサをサポートしています。後者は GitHub を通じて GitHub Flavored Markdown (GFM) をレンダリングする際に使われます。 詳しくは、「GitHubでの書き込みと書式設定について」をご覧ください。

GitHub フレーバーの Markdown はどちらのプロセッサでも使用できます。

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

  2. リポジトリで _config.yml ファイルを参照します。

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

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

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

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

  6. [コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」をご覧ください。1. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「pull request の作成」をご覧ください。

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

参考資料

  •         [kramdown のドキュメント](https://kramdown.gettalong.org/documentation.html)

  •         [GitHub Flavored Markdown の仕様](https://github.github.com/gfm/)