トマシープが学ぶ

Unity/VR/AR/デザイン好きのミーハー 記事内容は自分用のメモです

Githubのreadmeによくついているマークを使ってみる!【バッチ】

バッチ

これ

f:id:bibinbaleo:20200204095208p:plain

http://img.shields.io/badge/license-MIT-blue.svg?style=flat←このボタン

これはいったい何なんだろう??ってずっと気になってたけど、とあるリポジトリのreadmeのrawデータを見てリンク飛んだら分かった。

Shields.ioというサイトで作ることができるバッチというものだって!

shields.io

使用例

f:id:bibinbaleo:20200204095423p:plain

kubectx/README.md at master · ahmetb/kubectx · GitHub

![Latest GitHub release](https://img.shields.io/github/release/ahmetb/kubectx.svg)
![GitHub stars](https://img.shields.io/github/stars/ahmetb/kubectx.svg?label=github%20stars)
![Travis (.org) branch](https://img.shields.io/travis/ahmetb/kubectx/master.svg)
![Proudly written in Bash](https://img.shields.io/badge/written%20in-bash-ff69b4.svg)

 

VRTK

f:id:bibinbaleo:20200204095233p:plain

VRTK/README.md at master · ExtendRealityLtd/VRTK · GitHub

[![License][License-Badge]][License]
[![Backlog][Backlog-Badge]][Backlog]
[![Documentation][Academy-Badge]][Academy]

[![Slack][Slack-Badge]][Slack]
[![Videos][Videos-Badge]][Videos]
[![Twitter][Twitter-Badge]][Twitter]

VRTKの書き方よくわからない。なんでこれで表示されるんだ????

作る

バッチを作るサイトはいくつかあるみたいだけど、多分Shields.ioが一番有名?

shields.io

リポジトリ情報から

リポジトリの情報を解析してコードサイズなどのバッチを作ってくれる機能がありました。

例えばsizeという項目を押して、作りたいバッチをクリック。

f:id:bibinbaleo:20200204093701p:plain

user名とリポジトリ名を入れると作ってくれました。

f:id:bibinbaleo:20200204093526p:plain

何のサイズなんだろう?もっと大きい気がするけど・・・

まあいいや!できた。

https://img.shields.io/github/languages/code-size/bibinba/VRUIPartsCollection

はてなブログにはcommand+Shift+Vでいつものリンクのように貼れば画像で表示される。

urlはこんな感じ。urlでどういう情報なのかがわかる

https://img.shields.io/github/languages/code-size/bibinba/VRUIPartsCollection

 

 

他にもreleaseの最新バージョン表示してくれる機能もあった。

https://img.shields.io/github/v/release/bibinba/VRUIPartsCollection

https://img.shields.io/github/v/release/bibinba/VRUIPartsCollection

 

参考

kic-yuuki.hatenablog.com

ライセンス

qiita.com

http://img.shields.io/badge/license-MIT-blue.svg?style=flat

http://img.shields.io/badge/license-MIT-blue.svg?style=flat

こんな感じのurl

ロゴ

こちらのジェネレーターでUnityロゴバッチ作れました。

tech-blog.s-yoshiki.com

f:id:bibinbaleo:20200204094951p:plain

 

できた!

https://img.shields.io/badge/-Unity-000000.svg?logo=unity&style=popout

https://img.shields.io/badge/-Unity-000000.svg?logo=unity&style=popout

オリジナルバッチ

f:id:bibinbaleo:20200204092759p:plain

オリジナルもできた

https://img.shields.io/badge/%E3%83%88%E3%83%9E-%E3%82%B7%E3%83%BC%E3%83%97-orange

http://img.shields.io/badge/トマ-シープ-orange

Githubに貼る

例えばhttp://img.shields.io/badge/license-MIT-blue.svg?style=flatだったら、こんな感じの表記をmarkdownでする。

[![aaa](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE.md)

赤いリンクがShields.ioで作ったバッチ画像のリンク。

青いリンクがボタンを押したときに表示されるリンク。今回は同じフォルダに入っているので相対パス的な感じでファイル名だけ書いている。

最初の緑の[]の中はalt属性なので書かなくても大丈夫。書くと優しい

代替テキスト(alt属性)の目的や役割を理解し、やさしいサイト作りを目指そう! : ビジネスとIT活用に役立つ情報

 

VSCodeのマークダウンプレビューでは表示されない・・・

f:id:bibinbaleo:20200204092250p:plain

でもプッシュしたらgithub上では表示された!

f:id:bibinbaleo:20200204092252p:plain

と思ったら別のバッチはVSCodeでも表示された。何の違いだ?

f:id:bibinbaleo:20200204094402p:plain

最後に

楽しい!謎が解けてよかった!

最初、「github,readme,ボタン」とかで検索してたけど全然引っ掛からなくてマジでモヤモヤしてた。