[GitHub] README 더 쉽게! 활용하면 좋은 사이트 모음

이전부터 작성하려고 했지만 계속 미루던 README를 드디어 작성했다. 처음에는 README가 무조건 Markdown(.md)으로만 작성해야 하는 줄 알았는데, HTML도 가능하다는 사실을 알게 되었다.

 

어떻게 작성하고 꾸며야 할지 감이 잘 안 잡혀서 구글링을 해보니 자료가 정말 많았고, 덕분에 쉽게 작성할 수 있었다. 특히, 이미 만들어진 템플릿을 가져와서 활용하면 되기 때문에 생각보다 수월했다.

 

그중에서도 이 블로그에서 많은 도움을 받았다. 다양한 참고 자료를 정리해 두셔서 필요한 정보를 찾기가 쉬웠다.

나도 내가 직접 사용한 것 위주로 정리해 두었는데, README는 꾸밀 수 있는 요소가 정말 다양하므로, 여러 자료를 참고하면 더욱 도움이 될 것 같다.

 

특히, 나는 이곳을 많이 참고했다.

Github | 깃허브 리드미 꾸미기 총정리 README A to Z

 

 

1. Header & Footer

README에서 가장 먼저 눈에 띄는 헤더(Header)와 푸터(Footer)를 추가할 수 있는 오픈소스다. 다양한 디자인이 제공되기 때문에 원하는 스타일을 골라 자유롭게 활용할 수 있다.

사이트: https://github.com/kyechan99/capsule-render

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

 

2. Badge (뱃지)

내가 보유한 스킬이나 자격을 README에 표시할 수 있는 요소다.

종류가 굉장히 다양해서 필요한 뱃지를 찾아 복사해서 사용하면 된다.

사이트: https://github.com/Envoy-VC/awesome-badges

GitHub - Envoy-VC/awesome-badges: 😎 A curated list of GitHub badges for your next project

아이콘을 활용하는 것도 가능하다. 다양한 아이콘을 추가하면 시각적으로 더 깔끔하고 직관적인 구성을 만들 수 있다.

사이트: https://simpleicons.org/

https://simpleicons.org/

 

3. GitHub Stats

GitHub 활동을 한눈에 보여줄 수 있는 기능이다. Total Stars, Total Issues 등 다양한 지표를 시각적으로 표현할 수 있으며, 내가 자주 사용하는 프로그래밍 언어도 함께 표시할 수 있다.

사이트: https://github.com/anuraghazra/github-readme-stats

GitHub - anuraghazra/github-readme-stats: :zap: Dynamically generated stats for your github readmes

 

 

4. solved.ac (잔디)

코딩 테스트 티어를 예쁘게 시각화할 수 있는 기능이다. 프로그래밍 실력을 한눈에 보여줄 수 있어 활용도가 높다.

사이트: https://github.com/mazassumnida/mazandi

GitHub - mazassumnida/mazandi: ✅ solved.ac 잔디를 예쁘게 보여주는 프로필 카드 API

 

5. README 생성 도구

원하는 요소를 선택하고 입력하면 자동으로 코드를 생성해주는 사이트도 있어 README를 더욱 쉽게 완성할 수 있다.

나는 이걸 나중에 알게 되어 이미 GitHub에서 직접 필요한 요소들을 찾아서 추가한 상태였지만, 쉽고 빠르게 README를 만들고 싶다면 이런 도구를 활용하는 것도 좋은 방법이다.

사이트: https://github-profile-readme-editor.netlify.app/