ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
記事のバージョン: GitHub.com

Markdown プロセッサを kramdown にアップデートする

まだ Jekyll 3.0.0 のデフォルトの Markdown プロセッサである kramdown を使っていない場合、_config.yml ファイルを使用して Markdown プロセッサを更新する必要があります。

GitHub Pages は、Markdown プロセッサとして kramdown だけをサポートします。

GitHub-flavored Markdown は、kramdown がデフォルトでサポートしています。したがって、GitHub で Markdown を使うのと同じ方法で GitHub Pages の Markdown を使うことができます。

参考: RdiscountRedcarpet のような GitHub フレーバーの Markdown をサポートしている Markdown プロセッサを現在使っている場合、適切にレンダリングするために Markdown ファイルを変更する必要はありません。

Kramdown 以外の Markdown プロセッサを使っている場合、お客様のサイトのコンフィグファイルの Markdown 設定を変更する必要があります。

  1. GitHub で、リポジトリのメインページへ移動します。

  2. リポジトリ中の _config.yml にアクセスしてください。

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

    エディットアイコンでファイルエディタをオープン

  4. Markdown で始まる行を見つけ、値を kramdown に変更してください。

    config.yml での markdown 値

  5. ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「複数の共同作者を持つコミットを作成する」を参照してください。

    変更のコミットメッセージ

  6. コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが master なら、コミットに新しいブランチを作成することにして、プルリクエストを作成してください。

    Commit branch options

  7. [Propose file change] をクリックします。

    ファイルの変更を提案 ボタン

Kramdown の使用について詳しくは、kramdown のクイックリファレンスガイドkramdown のオフィシャルドキュメントを参照してください。

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください