Skip to main content

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

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

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

{data variables.product.prodname_pages %}は、パブリック・リポジトリのGitHub Freeと組織用のGitHub Free、パブリック・リポジトリとプライベート・リポジトリの、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverで利用できます。 詳しくは、「GitHub のプラン」をご覧ください。

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

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

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

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

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

注: 既定のファイル エディターを使ってファイルの編集とコミットを行う代わりに、必要に応じて github.dev コード エディターを使用できます。それには、 ドロップダウン メニューを選択し、 [github.dev] をクリックします。 また、 GitHub Desktop をクリックして、GitHub Desktop を使用してリポジトリを複製し、ローカルでファイルを編集することもできます。

ファイルのスクリーンショット。 ヘッダーの下向き三角形のアイコンが、濃いオレンジ色の枠線で囲まれています。

1. `markdown:` で始まる行を見つけ、値を `kramdown` または `GFM` に変更します。 完全な行は `markdown: kramdown` または `markdown: GFM` となります。
  1. [変更のコミット...] をクリックします。

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

  3. GitHub.com のアカウントに複数のメール アドレスが関連付けられている場合は、[メール アドレス] ドロップダウン メニューをクリックし、Git 作成者のメール アドレスとして使用するメール アドレスを選びます。 このドロップダウンメニューには、検証済みのメールアドレスだけが表示されます。 メール アドレスのプライバシーを有効にした場合は、no-reply がコミット作成者の既定のメール アドレスになります。 no-reply メール アドレスの正確な形式については、「コミットメールアドレスを設定する」を参照してください。

    GitHub pull request のスクリーンショット。コミット作成者のメール アドレスを選ぶためのオプションを含む、ドロップダウン メニューが表示されています。 octocat@github.com が選ばれています。

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

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

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

参考資料