GitHub のREADME にgif 画像を表示する1番簡単な方法 #github #gif

画像を

GitHubのREADMEにgif画像を貼り付けたいってことってありますよね。今回作ってみたこれ↓でも1枚だけ貼り付けたい感じになりました。

uchimanajet7.hatenablog.com

当然Google先生github readme gifとか入力して調べてみるわけですが

github readme gif
https://www.google.co.jp/search?q=github+readme+gif

どーやら↓の2つの方法が主流っぽい感じ?

  1. リポジトリにmaster branch以外の画像のbranchを切りそこに画像をアップロード
  2. GitHub Wikiリポジトリに画像用フォルダを作りそこに画像をアップロード

1の方法は確かに手軽だけど、それだけのためにbranchが残り続けるのが個人的には好きじゃないので却下。これするなら素直にmaster branchに画像ファイル追加するなぁ

2の方法は利用したこともあるし、Wiki使ってドキュメント書くならアリだと思うんですが・・・今回はファイル1個なのが迷うところ。

2と似てるけどGitHub Pagesでも同じようなことは出来ますよね。こっちもページ公開するならアリだと思うけど、今回はファイル1個・・・

もっと手軽に

f:id:uchimanajet7:20170812170547p:plain

画像1個で画像自体のバージョン管理が必要ないので、もっと簡単に出来ないかなぁーと。そこで思いついたのが以下の方法になります。

  • GitHubリポジトリにissueを起こして、そのissueに画像を貼り付ける
  • issueの画像はMarkdown記法でリンクが記述されているのでそれをコピー
  • 画像を貼りたいREADMEにこのリンクを張り付ければOK

f:id:uchimanajet7:20170812170338p:plain

今回はこの方法を利用しているので、実際にissueに貼った画像を使ってREADMEに画像を貼り付けています

github.com

github.com

この方法の良いところ

  • issueを作って画像を貼り付けるだけなので手軽
  • 余計なbranchが残り続けることもない
  • issueなので、そのissueのためにbranch切ってpull request起こせば、なんでこうなってるのかがあとからもわかる
  • そもそもREADMEを更新するのでpull requestを起こすはず
  • issueなので対応が終わったらcloseしちゃえば良い
  • 画像を差し替えたい場合も、差し変えるためのissueを起こせば同様の手順でOK
  • issueの画像リンクがMarkdown記法なので、そのままコピペできる
  • 何と言っても手軽

ということで、手軽で良い感じかと。 何かの参考になれば。

以上になります。