🌠

GitHubProfileのページを可能な限りキラキラさせる方法

2020/09/16に公開約5,800字

GitHubProfile ページとは

GitHub の自分の Profile ページを自由にカスタマイズできるのご存知ですか??

https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/about-your-profile

↓↓↓ こういうやつです ↓↓↓


イケてる?エンジニアは結構カスタマイズして公開してみてるみたいなんで、一度は目にしたことがあるかと思います。この流行に乗り遅れないようにちょっとでもキラキラにしてみたくないですか??

結構いろんなことができるんで、ゲームを公開している人今聞いてる音楽を教えてくれる人好きなアニメ・マンガを羅列している人など様々ですが、エンジニア的な情報だけを可能な限りビジュアライズしてくれるようにする方法を紹介したいと思います。

私の GitHubProfile を晒す

ここに私の Profile がありますので晒しておきます。
yutkat profile

全体をスクショしてみるとこんな感じです。

画像やグラフが多めでなんかすごいエンジニアな感じがしますよね!(なお実際の実力が伴っているわけではない)
重複している情報もありますが、キラキラのためには仕方ありません。

作り方

1. 自分のユーザー名のリポジトリを作って GitHubProfile に表示する

公式にやり方が載ってますのでそちらを参照して作ってください。正直クリックするだけです。

https://docs.github.com/ja/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme

2. バッジ部分を作成する

内容は

  • Profile ページの閲覧カウンター数
  • Twitter のアカウントフォロワー数
  • GitHub のアカウントフォロワー数
  • Reddit のカルマ
  • Stackoverflow の実績
  • Qiita のコントリビュート数
    です。

ここのほとんどのバッジは、 shields.iohttps://shields.io/category/social とかから作成しているだけです。
それ以外で使用しているのは、Profile の閲覧数は https://github.com/antonkomarev/github-profile-views-counter を、Qiita のコントリビュート数は https://qiita.com/mikkame/items/f2c60d9caf8a8e38ec50 を利用させていただいています。

私のREADME.mdの ↓↓↓ の部分のユーザー名部分を変えればいいと思います。

<p align="left">
  <a href="https://github.com/yutkat/yutkat/">
    <img src="https://komarev.com/ghpvc/?username=yutkat" alt="yutkat" />
  </a>
  <a href="http://twitter.com/yutkat">
    <img height="20" src="https://img.shields.io/twitter/follow/yutkat?label=Twitter&logo=twitter&style=flat" />
  </a>
  <a href="https://github.com/yutkat">
    <img height="20" src="https://img.shields.io/github/followers/yutkat?label=follow&logo=github&style=flat" />
  </a>
  <a href="https://www.reddit.com/user/yutkat">
    <img height="20" src="https://img.shields.io/reddit/user-karma/combined/yutkat?label=Reddit&logo=reddit&style=flat" />
  </a>
  <a href="https://stackoverflow.com/users/5720201/yutkat">
    <img height="20" src="https://img.shields.io/stackexchange/stackoverflow/r/5720201?label=StackOverflow&logo=stack-overflow&style=flat" />
  </a>
  <a href="http://qiita.com/yutkat">
    <img height="20" src="https://qiita-badge.apiapi.app/s/yutkat/posts.svg" />
  </a>
  <//qiita.com/yutkat">
    <img height="20" src="https://qiita-badge.apiapi.app/s/yutkat/contributions.svg" />
  </a>
</p>

3. 上の方のグラフ部分を作成する

ここでは3つのサービスを使って活動実績を表示してます。

GitHubReadmeStats

たぶん GitHubProfile の中で一番よく見かける個人の GitHub の活動履歴からランクを作成してくれるものです。

完全に余談ですが、私はこのランクは幽 ☆ 遊 ☆ 白書の妖怪ランクと同じ定義と考えていて、S 級妖怪(ランク)の人は手が付けられないので、あまり刺激しないほうがよいでしょう。

トロフィー

ryo-maさんの作ったサービスを利用してます。Qiita の記事にわかりやすく紹介されてるのでそちらを参考にすればよいと思います。

github-profile-summary-cards

情報的には GitHubReadmeStats とあまり変わりませんが、こちらは GitHubActions を使う必要があります。重複している情報も多いので必須ではないですが、private コンテンツの情報が取れるのが強みです。

4. スキル一覧っぽいのを作成する

GitHub Profile README Generator からアイコン部分だけをもらいました。
このサイトでそのまま作ってもいいんですが、結構ダサめに仕上がってキラキラ度が下がるので要注意です。

5. 下の統計データっぽいところを作成する

wakatime

統計データは wakatime を使って取得しますので、wakatime に登録する必要があります。私も wakatime はこの Profile を作るときに初めて触ったのですが、他の作業時間可視化ツールと比べて、どの言語、どのリポジトリをどれくらい触ったかがわかって、これだけでもとても楽しいです。
※作業を記録するためにはエディターにプラグインを入れる必要があります

無料版でも最新2週間のデータなら保存してくれます。(できれば有料版を使いたいくらいなんですが月 9 ドルはちょっと高いですよね。。。)

Profile-Readme-WakaTime(統計情報のサマリー用)

何時間作業したかのサマリーを wakatime から取得して画像化してくれるのが

https://github.com/avinal/Profile-Readme-WakaTime

です。画像は自分のリポジトリの images の下に作成されます。
このツールは GitHubActions を使っています。基本的に README に書いてあるものをコピペするだけなので難しくはないはずです。参考に私の設定のリンクを貼っておきます。 https://github.com/yutkat/yutkat/blob/main/.github/workflows/main.yml

本来はよく使われている
waka-readme
を使いたいのですが、後述の waka-readme-stats と埋め込みするときのキーワードがかぶっているため使えませんでした。(waka-readme は悪くない waka-readme-stats 側が fork していてそのまま同じキーワードで置換していることに問題がある)

waka-readme-stats(統計情報の詳細用)

私の GitHubProfile で一番下の折りたたみ部分になっているところにある、wakatime が集計した統計情報の詳細を公開するための部分です。
いつ作業してるか、何曜日に進捗が出てるか等々作業内容が丸裸です。

この情報を出すためにはこのリポジトリを使う必要があります。

基本な使い方としては wakatime に登録して、API キー、GitHub のアクセストークンを払い出し、GitHubActions で動かすだけです。
また、自分の Profile の方の README にはデータを埋め込む目印として

<!--START_SECTION:waka-->
<!--END_SECTION:waka-->

を記述する必要があります。

詳しくは README を読んでみてください。(そんなに難しくない)

もっと輝きたいあなたに

awesome-github-profile
に超キラキライケてる Profile がいっぱい載ってます。もっとキラキラしたい方は参考にしてみてください。

最後に

GitHubProfile は最近カスタマイズできるようになったんで、これからもまだまだいろいろなサービス、試み、トレンドがでてくると思います。

キラキラは一夜にしてならず!アンテナを張って、常に自分磨きの努力を続けていきましょう!!

Discussion

ログインするとコメントできます