본인의 깃허브 꾸미기 (README.md 꾸미기)

안녕하세요 반갑습니다~!! 👋👋

개발자들 사이에서 가장 많이 사용되는 GitHub, 그런 GitHub를 꾸미는 방법을 오늘은 간략하게 알아보도록 하겠습니다.

깃허브는 개발자의 포트폴리오로 사용되기 때문에 아무래도 조금 더 이쁘게 꾸며놓으면 GitHub에 방문한 분들도 저의 기술 스펙, 프로젝트의 경험을 어필하는데도 도움이 될 것이기에 지금부터 천천히 따라오시기 바랍니다 

 

또한 많은 "개발자들마다 자신의 README 파일을 꾸미는 방법이 다르기 때문에" 본글은 저의 GitHub를 주제로 얘기합니다.

 

https://github.com/seonghoo1217

우선 제 GitHub를 보시면 위 사진에서 눈치 채신분들도 있으시겠지만 README파일의 경로가 제 이름으로 된 Repo밑에 있습니다. 그렇기 때문에 우선 자신의 GitHub아이디 이름으로 된 레포지토리를 하나 생성해줄 것입니다.

 

고양이가 나타나서 ✨ special  ✨ 레포지토리라고 알려줍니다

주의점으로는, 레포지토리 생성 시에 반드시 README.md파일을 추가해주세요

 

그러면 본격적으로 GitHub를 꾸밀 준비가 완료되었습니다. 저는 우선 제 GitHub에 처음 방문하시는 분들에게 안내하는 목적으로 README.md파일을 꾸몄기 때문에 안내문구를 하나 만들어주겠습니다. 

 

-헤더 부분-

 

헤더 부분은 'capsule-render`라는 오픈 API를 사용해주었습니다. 아래 링크에서 본인이 원하는 스타일로 제작 가능합니다.

 

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

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

 

저 같은 경우는 이렇게 사용하였습니다. 사용법은 우선

![header](https://capsule-render.vercel.app/api? 헤더에 capsule-render api사용을 명시적으로 적어준 후

type=waving& //파도 모양

color=auto& //색변 경자동

height=300& //크기

section=header& //위치

text=Welcome& //메인이 될 글

fontSize=90&animation=fadeIn&fontAlignY=38& //글씨 크기와 애니메이션 설정

desc=Seonghoo1217's%20GitHub%20Profile&descAlignY=51&descAlign=62 //desc에 추가 설명 

 

이렇게 하면 헤더는 끝납니다.

 

 

뱃지

해당 뱃지들은 https://shields.io/ 링크에서 사용가능합니다

Shields.io: Quality metadata badges for open source projects

 

SNS 뱃지들은 아래형태처럼 사용가능하며

 

<a href="클릭시 이동할 링크" target="_blank"><img src="https://img.shields.io/badge/문자-색코드?style=flat-square&logo=이미지 이름&logoColor=white"/></a>  

 

기술스펙뱃지들은 아래형태처럼 사용가능합니다.

<img src="https://img.shields.io/badge/문자-색코드?style=for-the-badge&logo=이미지 이름&logoColor=black">

 

이미지이름,색코드들은 https://simpleicons.org/ 에서 찾을수있습니다.

Simple Icons

 

Hits

Hits 사용은 간단하다 Hits API를 이용하면 오늘방문자/총방문자 순으로 나옵니다.

<a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2F본인의 깃허브아이디%2Fhit-counter&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false"/></a> 에서  본인의 깃허브아이디만 바꿔주면 쉽게사용할수 있습니다.

 

프로필요약 API

 

 

 

 

 

자신의 총 커밋수,풀리퀘스트수,이슈생성,한 프로젝트에 기여한수등 여러가지정보가 한눈에 쉽게보이는 프로필을 보여줄수있는 API입니다.

 

사용법은 간단하게 아래처럼 api사용을 위한 호출에서 자신의 깃허브아이디만 넣어주면됩니다.


 

이상으로 README파일을 꾸며 자신의 GitHub를 꾸며보는  글에대한 정리를 마치겠습니다. 모두 자신의 포트폴리오를 잘꾸미시면 좋겠습니다 😀