Skip to main content

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

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

GitHub Pagesは、GitHub Free及びOrganizationのGitHub Freeのパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverのパブリック及びプライベートリポジトリで利用できます。 詳細については、「GitHub's products」を参照してください。

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

GitHub Pages は 2 つの Markdown プロセッサをサポートしています。kramdown と GitHub の独自の Markdown プロセッサで、後者は GitHub Enterprise Cloud を通じて GitHub Flavored Markdown (GFM) をレンダリングする際に使用されます。 詳細については、GitHub での書き込みと書式設定に関するページを参照してください。

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

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

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

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

    [ファイルの編集] ボタン

    注: ファイルの編集とコミットに既定のファイル エディターを使うのではなく、必要に応じて github.dev コード エディターを使用できます。それには、 の横にあるドロップダウン メニューをクリックし、 [Open in github.dev](github.dev で開く) を選びます。

    ファイルの編集ボタンのドロップダウン

  4. markdown: で始まる行を見つけ、値を kramdown または GFM に変更します。 config.yml の Markdown 設定 1. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳細については、「複数の共同作成者とのコミットの作成」を参照してください。 変更のコミット メッセージ

  5. If you have more than one email address associated with your account on GitHub.com, click the email address drop-down menu and select the email address to use as the Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then <username>@users.noreply.github.com is the default commit author email address. For more information, see "Setting your commit email address." Choose commit email addresses

  6. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳細については、「新しい pull request の作成」を参照してください。 コミット ブランチのオプション 1. [新しいファイルの提案] [新しいファイルの提案] ボタンをクリックします

参考資料