본문 바로가기
git

Github _ readme.md 꾸미기

by alotus 2024. 9. 1.
728x90
반응형

프론트엔드를 꿈꾸며, 해야 할 일 중 하나가 깃허브를 관리하는 것이라고 들었다.

퍼블리셔로 일 할 때는 많이 신경 쓰지도 않았고 아직까지도 습관이 잘 되지 않는 부분이기도 했다.

 

그래서 이 마음을 좀 다져보고자 readme를 꾸미는 방법부터 알아봤다.

그리고 나중에 참고할 일이 있지 않을까 싶어 기록도 남겨보기로 했다.

 

1. 프로필용 repository 만들기.

다들 첫 번째로 보여주는 리드미가 포트폴리오 올라가있는 레퍼지토리인 줄 알았는데 프로필용이 따로 있었다는 것을 처음 알았다..

 

프로필용 readme를 위해서는 본인의 아이디와 동일한 repository를 생성해야 한다.

 - Repositories에서 New를 클릭해 새로운 레퍼지토리를 생성한다.

 

 - 레퍼지토리명은 꼭! 본인의 아이디와 동일하게 작성해야 한다. (왼쪽에 Owner와 동일하게 작성하면 된다)

 - 그리고 Add a README file을 체크하고, 스크롤을 아래로 내려 Create Repository 버튼을 누른다.

    아래 이미지에는 체크가 풀린 상태이다. 저 부분이 체크되어 있어야 한다.

 

 

2. header / footer 꾸미기

상하단을 꾸미는데는 아래 사이트를 참고했다. 색상부터 높이, 방향 등 꽤 다양하게 설정 가능하고 디자인 선택도 가능하다.

https://github.com/kyechan99/capsule-render

 

GitHub - kyechan99/capsule-render: 🌈 Dynamic Coloful Image Render

🌈 Dynamic Coloful Image Render. Contribute to kyechan99/capsule-render development by creating an account on GitHub.

github.com

 

 

3. 기술스택 꾸미기

<img src="https://img.shields.io/badge/로고명-색상?style=모양&logo=로고명&logoColor=로고색상"/>

 

로고 모양 등 자세한 사용법은 아래 사이트를 참고하면 된다.

https://shields.io/badges

 

Static Badge | Shields.io

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.

shields.io

 

스킬, 회사명, 색상 같은 것은 아래 사이트를 참고했다.

https://simpleicons.org

 

 

4. 사용언어 보여주기

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=깃허브 아이디)

 

 

위 코드를 통해 아래와 같은 이미지를 생성할 수 있다.

 

아래 사이트를 통해 더 자세한 사용법을 확인할 수 있다.

https://github.com/anuraghazra/github-readme-stats/blob/master/docs/readme_kr.md

728x90
반응형

'git' 카테고리의 다른 글

Github 이전 커밋의 유저 정보 변경, 잔디 복구  (0) 2024.10.17