LoginSignup
188
146
お題は不問!Qiita Engineer Festa 2024で記事投稿!
Qiita Engineer Festa20242024年7月17日まで開催中!

5分でできる!GitHub README プロフィール 💬

Last updated at Posted at 2024-06-29

こんにちは!もみです🐶

皆さん、GitHubプロフィールのREADME は設定していますか?

GitHubのプロフィールを充実させることで、
GitHub上での交流はもちろん、就活や転職でもきっとちょっと役に立ったりと、素敵なご縁に繋がるかもしれません。

たった5分で設定できるので、さっそく設定していきましょう!

🚩 今回作成するプロフィール

シンプルさを保ちつつ、スキルやGitHub上での活動を中心にした自己紹介テンプレートにしてみました!

image (2).png

GitHubリポジトリ:
https://github.com/NonokaM/sample-github-profile/blob/main/README.md

1. リポジトリを作成しよう

まず、ユーザー名と同じ名前のリポジトリを作成しましょう。
( ユーザー名と同一のリポジトリは、特別なリポジトリと認識されて自動的にプロフィールに表示されます )

また、編集を加えていくREADMEファイルのチェックボックスを選択し、ファイルを追加しておきましょう。

image (3).png

2. コードを貼り付けて編集しよう

下記のコードを作成したREADME.mdファイルにコピペ後、コメントアウトの指示に沿って変更するのみで完成するようにしてみました。

ライトモード ↔️ ダークモードの変更方法なども、コメントアウトに含めたのでお好みで変更してみてください!

README.md
<!-- 1. GitHub usernameを変更 -->
<div align="right">
  <img src="https://komarev.com/ghpvc/?username=username" />
</div>


<!-- 2. プロフィールや連絡先を変更 -->
## <img src="https://media.giphy.com/media/hvRJCLFzcasrR4ia7z/giphy.gif" width="28"> Hi there

- 🧑‍💻 I'm a backend engineer.
- 🌱 I’m currently learning go!
- 📫 How to reach me: [Twitter - @username](https://twitter.com/username)
<br>


<!-- 3. 好きな技術スタックに変更 -->
<!-- ライトモート:theme=light, ダークモート:theme=dark -->
<!-- アイコンの選択肢一覧:https://arc.net/l/quote/zizyykfh -->
## 🌱 Skills
<img alt="my skills" src="https://skillicons.dev/icons?theme=dark&perline=7&i=html,css,js,ts,react,next,figma,python,fastapi,go,docker,terraform,aws,gcp" />
<br>


<!-- 4. GitHub usernameを変更, 2箇所 -->
<!-- ライトモート:theme=light, ダークモート:theme=vue-dark  -->
## 🏃‍♀️ Activities
<div align="left"> 
  <img alt="Top Langs" height="170px" src="https://github-readme-stats.vercel.app/api?username=username&theme=vue-dark&layout=compact" />
  <img alt="github stats" height="170px" src="https://github-readme-stats.vercel.app/api/top-langs/?username=username&theme=vue-dark&layout=compact" />
</div>


<!--
This repository is a ✨ _special_ ✨ repository because its `README.md` (this file) appears on your GitHub profile.

Here are some ideas to get you started:

- 🔭 I’m currently working on ...
- 🌱 I’m currently learning ...
- 👯 I’m looking to collaborate on ...
- 🤔 I’m looking for help with ...
- 💬 Ask me about ...
- 📫 How to reach me: ...
- 😄 Pronouns: ...
- ⚡ Fun fact: ...
-->

これにて、GitHubのプロフィールは完成です!
今回使用したサービス以外にも、GitHubプロフィールを充実させる様々なサービスがあるので、自由にカスタムして楽しんでみてください 🥳

おまけ : 使用したライブラリ・サービスの解説

🌟 GitHub Profile Views Counter

閲覧回数を表示するライブラリ

🌟 GIPHY

gif画像を埋め込んで、動きやユニークさを出すのもおすすめです。
今回は👋の動作のgifを下記のサイトから埋め込んでみました。
自作で画像やgifを用意したりしても、よりユニークで良さそうですね☺️

🌟 Skill Icons

言語や技術のアイコンを簡単に設定できるライブラリ

🌟 GitHub Readme Stats

GitHubのプロフィールに統計情報を追加するツール
これを使うと、自分のリポジトリの統計(例えば、言語の使用状況、コミット数、スター数など)をREADMEファイルに簡単に埋め込むことができます。

188
146
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
188
146