GitHubのProfileページにREADMEを追加した。

tl;dr

  • GitHubのProfileページに自分のREADMEを載せることが出来るようになった。

f:id:teitei_tk:20200801030736p:plain

いつからか分からないが、このようにGitHubのProfileページに自分のREADMEを載せることが出来るようになっている。 いくらか調べてみたが、どれも一次ソースが無いので何時から始まったからは分からなかった。

dev.to

やり方は簡単でGitHub上で、下記の手順で出来る。

  1. 自分のGitHubのアカウント名と同じ名前のRepositoryを作る
  2. RepositoryにREADME.mdを編集してpushする。

私の場合はteitei-tkというアカウント名なので、teitei-tkというrepositoryを作った。 github.com

他の人がどんなREADMEを書いているのか知りたい場合や、どんなツールがあるのかはawsome-github-profile-readmeというRepositoryによくまとまっているので、そこを見ると良い github.com

結構いろんなことが出来て、自分のGitHubのstatsを表示したり、GitHubアカウントで一番利用している言語を表示することが出来たりする。

f:id:teitei_tk:20200731220449p:plain f:id:teitei_tk:20200731221317p:plain

その他にもShields.ioとSimpleIconsを利用してカスタムBadgeをつけれたりもする shields.io simpleicons.org

これは試しに作ったRubyRailsのカスタムBadge

Ruby RubyOnRails

ソースコードはこんな感じ

![Ruby](https://img.shields.io/badge/-Ruby-CC342D?style=flat-square&logo=Ruby)
![RubyOnRails](https://img.shields.io/badge/-Ruby%20on%20Rails-CC0000?style=flat-square&logo=Ruby+on+Rails)

具体的にはこのように書く。

![](https://img.shields.io/badge/-(message)-(badgeの色。16進数でも可能)?style=(表示するstyle)&logo=(simpleIcons.orgにあるlogoの名前)&logoColor=(logoの色)

StatsとBadgeの詳しいことはQiitaに良いまとめ記事があるのでそこに譲る。

qiita.com

qiita.com

個人的な感想

LaprasやFindyのActivityLogやスキルまとめなどと相性が良さそうなので、Lapras社とFindy社はGitHub Profileに載せることが出来るBadgeを作って欲しい。

まとめ

  • 自分のGitHubアカウントのトップページにREADMEを載せることが出来るようになった。
  • GitHub上のStatsやBadgeを載せたりカスタマイズが出来る。

ref

dev.to

github.com

qiita.com

qiita.com