Cntlog

GitHubのReadmeでプロフィールを作る方法

運用

投稿日

GitHubのプロフィールページをカスタマイズできると知って、自分でも試してみました。

この記事では、私のやったプロフィールページのカスタマイズ内容とそのやり方を紹介します。

ほぼコピペで済むのでGitHubのアカウントを持っている方でしたら、10分もかからないと思います。

プロフィールページの作り方

GitHubへアクセスして、自分のユーザー名でリポジトリを作ります。

そのリポジトリのREADME.md を編集することで、プロフィールページが完成します。

私のプロフィールページはこのようになっています。

編集したREADME.md

とにかく早く作りたいという方は、下記をコピペしてユーザー名（contiki9）となっているところを自分のGitHubのアカウント名に変更してください。

[![Twitter: maki_saki](https://img.shields.io/twitter/follow/maki_saki?style=social)](https://twitter.com/maki_saki)
![Visitors](https://visitor-badge.glitch.me/badge?page_id=contiki9&left_color=gray&right_color=blue)

![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=contiki9&theme=vue)

![GitHub Stats](https://github-readme-stats.vercel.app/api?username=contiki9&show_icons=true)

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=contiki9&layout=compact&langs_count=6)](https://github.com/anuraghazra/github-readme-stats)

表示している内容について

README.mdはマークダウンなのでHTMLであれば何でも入力ができます。

私の場合はAPIを受け入れて、動的に表示されるもの情報を表示しました。

内容としては以下のものです。

  • Twitterのフォローボタン
  • プロフィールページのアクセス数
  • コントリビューション数のグラフ
  • 自分のリポジトリのcommit数やPR数がわかるカード
  • リポジトリ内で使われている言語の割合がわかるカード

これらのカードなどは下記のサイトが参考になります。

  • GitHub Readme Stats
    • GitHubユーザの統計情報を解析してカードを生成する
  • Shields.io
    • 様々な情報を表示可能なバッジを生成する

プロフィールがあると何が良いのか

転職活動や副業に参加する際自分のポートフォリオのURLを送りますが、その中にGitHubのアカウントのリンクもあると思います。

GiHubの場合ポートフォリオでは見えづらい日々のコードに対しての向き合い方などが汲み取れますが、それをすべてのリポジトリで確認するのは見る側としてはとても大変です。

そのため、さっとわかるような内容を最初に知ってもらうことで見てくれた人の不安を多少なりとも消すことができます。

プロフィールカードは作るのは簡単ですが、GitHubを使いこなしてる感が出てくるのでプロフィールカードがあることで悪印象を持たれることはないと思います。

もちろん、GitHubへのcommitがほとんどない場合は印象は良くないでしょうがそれはプロフィールの有無とは関係ない話ですね。

最後に

プロフィールカードを作って見ましたが、すごく手軽で良いなと思っています。

私はGItHubを通じて仕事が欲しいとか思っているわけではないのですが、GitHubを通じて私に興味を持ってもらえるなら嬉しいです。カジュアル面談への導線や相談事の窓口になればとは考えています。

今は既存の統計情報などを載せているだけなので、今後はnotionで公開してる自分の情報などにもリンクを貼ってより中身のあるものにしていきたいなと思っています。

カテゴリ:運用の記事