Self-Study/기타

[Github] 깃허브 프로필 README

Raadian 2022. 8. 24. 15:40

References

https://zzsza.github.io/development/2020/07/10/make-github-profile-readme/

https://pgmjun.tistory.com/21

 

서론

평소 개인 혹은 소규모 프로젝트 형상관리(SCM)로 사용되는 Github.

매 번 잔디를 심어 뿌듯하지만 어딘가 허전한 느낌이 들 때가 많다.

만약 그런 마음이 든다면 프로필 README를 통해 자기만의 깃허브 페이지를 꾸며보자!

 

프로필 README 등록

본인 Github 페이지의 Repositories 탭으로 이동한다.

Repository name을 본인 ID로 적은 뒤 Add a README file을 체크 후 Create repository를 눌러 생성한다.

사전에 만들어 놓은 프로필 README 리포지토리가 있어 해당 에러 문구가 뜰 뿐, 최초로 만들어내면 정상적으로 생성될 수 있다.

본인 ID 이름으로 생성된 리포지토리가 정상적으로 생성되었는지 확인한다.

 

프로필 README 꾸미기

프로필 README를 꾸미는 방법은 간단하다.

리포지토리에 있는 README.md 파일만 수정하면 본인 프로필 페이지에 정상적으로 반영된다.

마크다운 문법 특성상 기본적인 html 지식만 있으면 언제든지 꾸밀 수 있으며 디자인 모듈 또한 오픈 소스로 제공되어 있어 대표적인 것들을 소개하고자 한다.

마크다운 렌더링 확인 사이트

https://dillinger.io/

작성한 마크다운 코드의 렌더링 결과를 보여주는 사이트로, 프로필 README 결과물을 보기 위해 여러 번 커밋 할 필요 없이 간편하게 이용할 수 있다.

헤더

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

header 디자인을 제공하는 오픈 API로, 원하는 옵션의 링크만 가져오면 적용이 가능하다.

뱃지

https://shields.io/

이런식으로 썸네일, 이름, 배경 색상(컬러코드)들을 지정하여 뱃지 아이콘을 꾸밀 수 있다.

Git Stats

https://github.com/anuraghazra/github-readme-statshttps://pgmjun.tistory.com/21

본인의 깃허브의 상태를 기준으로 등급을 평가하는 모듈이다.

엥간하면 A+ 등급을 줄 정도로 후하게 준다고 한다…