GitHubのREADMEに画像を表示したい

Sinatraでのメモアプリ作成も終わりに近づいてきました。作成したリポジトリのREADMEに画像を表示したかったので方法を調べました。

結論

新規issueページで画像URLを生成して、READMEに生成した画像URLを貼り付ける。

手順

  1. 対象リポジトリIssues タブ内のNew issue から新規issueページを開く。
  2. comment 欄に追加したい画像をドラッグ、もしくはペースト(画像URLが生成される)。
  3. Submit new issue でissue作成。
  4. 生成された画像URLをREADME.mdに貼り付ける。
  5. 作成したissueをcloseする。

注意点

  • リポジトリページのREADMEの編集画面でも画像URLの生成は可能だが、誤ってファイルを更新してしまうと不要なコミットを作成してしまう可能性があるのでREADMEの編集画面では行わない方が良い。
  • 対象リポジトリのissueでなくても画像URLは生成できる。
  • 新規issueを作成しなくても画像URLは生成できる。
  • 対象リポジトリでissueを作成して画像URLを残しておいた方がログを残すという意味では良さそう。

まとめ

画像を貼り付けたいだけなのにわざわざissueを作成するのはどうかと思ったが、GitHubの仕様上この方法しか今のところ無さそうなので仕方ない。 今回のようなコードとは関係無さそうな雑用的なこともこれからどんどん増えていくので出来るだけ早くキャッチアップできるようになりたい。

参照

TIL/readme_add_image.md at master · karlley/TIL

【GitHub】README.md に画像を表示させる簡単な方法 - Qiita