[Github] README.md

Eugenie·2022년 8월 15일
0

Hits

여러 개발자들이 이용하고 있는 Github 에는 특별한 기능이 있다.
Design Github profile using README.md 라는 기능이다.

이 기능에 대해서 이미 알고 있는 사람들도 많을테지만
좀 더 잘 활용할 수 있는 방법에 대해 정리해보고자 한다.

본인의 계정 이름과 동일한 repository 를 생성하면

You found a secret! [RepositoryName] is a ✨special✨ 
repository that you can use to add a README.md 
to your GitHub profile. 
Make sure it's public initialize it with 
a README to get started.

이라는 문구와 함께 profile 기능을 이용할 수 있게 된다.

기능을 사용할 수 있도록 초기 설정을 하였다면
자유롭게 READEME 를 수정하여 사용하면 된다.

🎖 Badge

아래와 같이 커스텀한 뱃지를 추가할 수 있다.

Tech Blog Badge

뱃지를 나타내는 코드는 다음과 같다.

[![Tech Blog Badge](http://img.shields.io/badge/-Velog-12b886?style=round-square&logo=Vimeo&logoColor=white&link=https://velog.io/@eugenie8/)](https://velog.io/@eugenie8)

shields.io 라는 사이트에서 직접 커스텀하거나
위의 코드 일부를 수정하여 사용할 수도 있다.
코드 내의 속성은 어렵지 않기 때문에 적용해보면서 자연스럽게 알 수 있다.

아이콘에 대한 정보는 Simple Icons 라는 사이트에서 확인해 볼 수 있다.

위의 뱃지는 해당 뱃지를 눌렀을 때 이동하고자 하는 링크를 포함하였다.

🚪 Visitors

이 글의 가장 최상단에도 있는
방문자 수를 나타내는 뱃지를 추가할 수도 있다.

Hits

이 글의 방문자 수 뱃지의 코드는 다음과 같다.

[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fvelog.io%2F%40eugenie8%2FGithub-README.md&count_bg=%2312B886&title_bg=%23555555&icon=iconify.svg&icon_color=%23E7E7E7&title=view&edge_flat=false)](https://hits.seeyoufarm.com)

hits 라는 사이트에서 커스텀 가능하며,
한 번 스타일을 정해놓고 계속해서 쓰고자한다면 일부 수정해서 사용할 수 있다.

필자는 velog 의 게시글마다 동일한 스타일의 방문자 수 뱃지를 사용하고 있기 때문에
count 앞의 부분만 게시글의 링크로 수정하여 쓰고 있다.

profile 위와 아래에 헤더 또는 푸터를 추가할 수 있다.

header

footer

위의 헤더와 푸터의 코드는 다음과 같다.

![header](https://capsule-render.vercel.app/api?type=waving&color=auto&height=200&section=header&text=Welcome!&fontSize=90)

![footer](https://capsule-render.vercel.app/api?type=waving&color=auto&height=100&section=footer&text=&fontSize=90)

section 값을 header 혹은 footer 로 주면 방향을 바꿀 수 있다.
형태도 다양하고 색상도 커스텀할 수 있다.
자세한 활용방법은 capsule-render 을 참고하는 것이 좋을 것 같다.

📏 Stats

Github 계정에 대한 평가를 보여주는 카드를 추가할 수도 있다.

YuJeanCho's github stats

카드의 코드는 다음과 같다.

<img src="https://github-readme-stats.vercel.app/api?username=fhsi1&show_icons=true&theme=radical" alt="YuJeanCho's github stats" /></a> 

간단하게 username 에 해당하는 부분을 본인의 계정으로 바꿔주면 된다.

테마 적용이나 자세한 사용법은 GitHub Readme Stats 을 참고하는 것이 좋을 것 같다.

🥇 Top Language

Github 계정에서 가장 많이 다루고 있는 언어를 보여주는 카드를 추가할 수 있다.

Top Langs

특정 언어, 특정 repository 를 제외하는 등의 조정도 가능하다.
테마 적용이나 자세한 사용법은 GitHub Readme Stats 을 참고하는 것이 좋을 것 같다.

BOJ Solved.ac Tier

백준을 꾸준히 풀고있다면 관심이 갈만한 카드인 것 같다.

테마나 크기도 고를 수 있기 때문에
자세한 사용법은 Project Mazassumnida 를 참고하는 것이 좋을 것 같다.

LeetCode

리트코드를 꾸준히 풀고있다면 관심이 갈만한 카드인 것 같다.

테마나 크기도 고를 수 있기 때문에
자세한 사용법은 LeetCode Stats Card 를 참고하는 것이 좋을 것 같다.


📚 Reference
Github Profile Readme로 프로필 꾸미기
Github Readme 꾸미기 총정리
capsule-render
GitHub Readme Stats
Project Mazassumnida

profile
🌱 iOS developer

0개의 댓글