[Github] Github Profile 꾸미기 | README.md 파일로 나만의 깃허브 프로필 만들기 | 예비 개발자 포트폴리오 관리법

 

 

 

[Github]

README.md 파일로 나만의 깃허브 프로필 만들기

 

 

---

 

 

깃허브 메인 페이지에 항상 무언가 꾸밀 수 있는 기능이 추가되었으면 좋겠다라는 생각이 있었는데

알고보니 올해 깃허브에 나만의 프로필을 꾸밀 수 있는 기능이 추가되었다 !!

이런거 꾸미고 만드는걸 좋아해서 당장 여러 레퍼런스들을 찾아보며 따라해보게 되었다.

 

 

---

 

 📌 공식 문서 📌

docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme

Managing your profile README - GitHub Docs

 

우선 깃허브 공식 문서에 본인 Github 계정 아이디로 된 레포지토리 생성부터

README.md 파일 생성 절차까지 너무 친절하게 설명이 되어있고

해당 링크만 따라해도 전혀 문제가 없으니 관련 설명은 생략하고자 한다.

 

공식문서를 보고 깃 레포지토리를 만들었다.

 

---

 

이제 본격적으로 README.md 파일에 들어갈 것들을 작성해주면 된다 !

이미 이것과 관련하여 여러 뱃지들과 오픈소스들이 공유되고 있어 그 중에 맘에 드는 것들을 추가하면 된다.

설명도 친절하고 레퍼런스를 많이 찾을 수 있어 쉽게 추가할 수 있었다.

 

나는 우선적으로

1. 내 깃헙 방문자 수 조회 뱃지

2. Commit, Issue, PR 등의 개수를 확인할 수 있는 Stats

3. 나의 기술 스택 뱃지들

을 추가해보기로 했다.

 

 

---

 

 

 

1. 내 깃헙 방문자 수 조회 뱃지 (hits.seeyoufarm.com/)

HITS

 

해당 사이트에서 뱃지를 만든 모습

 

해당 사이트에 접속하면 쉽게 뱃지를 만들 수 있고, 내 취향에 맞게 커스터마이징도 가능하다.

처음에는 어떻게 커스터마이징 할까 고민하다가, 2021년도 팬톤 컬러 색으로 한번 커스터마이징 해보았다.

(후에 너무 다른 뱃지들이랑 따로 놀아서 색깔을 변경했다)

 

 

 

2. Git 사용량 통계

(github.com/anuraghazra/github-readme-stats/blob/master/docs/readme_kr.md) 참고

anuraghazra/github-readme-stats

 

해당 링크를 타고 가면 한국어로 된 친절한 마크다운 설명서가 있다.

Commit, Issue, PR 등의 개수를 확인할 수 있는 Stats를 보여주는 위젯을 README에 추가할 수 있다.

원하지 않는 통계를 숨길 수도 있고, 테마 설정을 통해 테마 변경도 가능하며, 색깔 변경등의 다양한 커스터마이징이 가능하다.

또한, 기본으로 제공되는 핀 기능 대신에 README에 레포지토리 핀을 제공하여 6개 이상의 핀 설정이 가능하기도 하다.

 

Simple is best... 기본 테마가 젤 이쁜 것 같다 ㅎㅎ

 

나는 아직 Contribute 경험이 없고 Star도 별로 없어서 그건 일단 숨김처리 해놓았다.

나중에 오픈소스 컨트리뷰팅도 하고, 여러 플젝을 통해 Star 개수도 좀 쌓이면 숨김 해제할 예정이다.

 

 

 

3. 나의 기술 스택 뱃지들 ( shields.io/ , simpleicons.org/ )

Simple Icons

Shields.io: Quality metadata badges for open source projects

 

뭔가 여태까지 내가 배웠거나, 프로젝트를 했던 언어와 프레임워크, 툴 등등을 정리해서 보여주면 좋을 것 같다는 생각에 기술스택을 뱃지로 정리해보았다. 위에 있는 두 사이트를 참고해 추가하였으며, 밑에 있는 레퍼런스 블로그 게시물을 통해 더 쉽게 추가할 수 있었다.

shields.io/ 에 들어가면 더 다양한 뱃지들을 구경할 수 있다. 프로젝트 성격에 맞게, 그리고 취향에 맞게 원하는 뱃지를 골라 추가한다면 더 보기 좋은 깃헙이 될 것이라고 생각한다. 앞으로 나도 자주 횔용해보고 싶다.

 

 

추가한 기술 스택들

 

처음에는 무작정 따라하다가 잘 안됐던 것들도 있어서 시행착오를 좀 겪었는데,

특히 마크다운 태그와 html 태그 혼용 시 한쪽이 적용이 안 될 때가 많아서 시간이 좀 걸렸다.

그리고 계속 수정하다보니 의미없는 커밋 수가 쌓여가는게 너무 싫어서 이것저것 해보다가 결국 레포지토리를 다시 파기까지 했다...ㅠㅠ

찾아보니 미리 마크다운 태그와 HTML/CSS 태그를 확인해볼 수 있는 사이트가 있길래 추후에는 주로 그것들을 활용해 1차 확인 후 수정을 진행했다. 밑에 내가 이용한 사이트 링크를 추가했다.

아직 마크다운 문법이 익숙치 않아 조금 애를 먹어서, 다음에 각잡고 많이 쓸 것 같은 마크다운 문법을 꼭 정리해서 여기에 포스팅해보고 싶다는 생각이 들었다. 

 

---

 

txt 문서 만들기는 귀찮고 HTML/CSS 코드 확인해보고는 싶을때 이용하기 좋은 사이트 ( www.cssdesk.com/ )

CSSDesk - Online CSS Sandbox

 

커밋하기 전 마크다운 수정사항이 제대로 반영되었는지 확인하기 좋은 사이트 ( dillinger.io/ )

Online Markdown Editor - Dillinger, the Last Markdown Editor ever.

 

---

 

이렇게 해서 완성된 내 깃허브 프로필 !!

앞으로 이것저것 뱃지나 오픈소스 추가해서 더 이쁘게 꾸며볼 예정이다.

완성된 프로필은 ( github.com/leejieuns2/leejieuns2 ) 에서 확인할 수 있다😆😆

 

 

 

 

✨ Reference ✨

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

Github Profile Readme로 프로필 꾸미기

velog.io/@woo0_hooo/Github-github-profile-%EA%B0%84%EC%A7%80%EB%82%98%EA%B2%8C-%EA%BE%B8%EB%AF%B8%EA%B8%B0

[Github] github profile 예쁘게 꾸미기