#2 Github README

정상준·2022년 10월 27일
0

Github

목록 보기
7/7
post-thumbnail

저번시간에 했던 README는 내가 push한 프로젝트를 설명하는 README 였다면 이번시간에는 전반적으로 나의 github프로필을 꾸며보는 README를 만들어보고자한다.


  1. 내 아이디와 똑같은 레포지토리 만들기

    나의 계정명과 같은 이름으로 레포의 이름을 지정해준다. 그럼 아래와 같이 특별한 레포를 생성한다는 것을 알 수 있다.

  1. Public으로 설정

나의 프로필을 다른사람들에게 공개할 것이기 때문에 공개범위는 Public으로 설정해준다.

  1. Add a README file


다음과 같이 Add a README file에 체크해준 후 레포를 생성해주자.


📝 뱃지 사용

  • 프레임워크나 사용 가능한 언어 등을 간결하게 표현하고 싶을 때

  • 블로그, 노션, 유튜브 등 다양한 링크들의 바로가기를 만들고 싶을때

직접 커스텀
https://shields.io/

아래 코드 복사해서 적절히 변형하기

뱃지의 색상과 로고 이름을 모아보는 사이트
https://simpleicons.org/

<img src="https://img.shields.io/badge/이름-색상코드?style=flat-square&logo=로고명&logoColor=로고색"/>

이름 : 뱃지에 쓸 이름(내용)

색상코드 : # 제외하고 입력 (ex. #FF1133 -> FF1133)

로고명 : 아이콘 이름 정확하게 입력(위 사이트 참고)

로고색 : 로고의 색깔

예시 )

<img src="https://img.shields.io/badge/Firebase-FFCA28?style=flat-square&logo=firebase&logoColor=white"/>

뱃지에 링크걸기

-><a></a> 태그 이용

<a href="링크"><img src="위에있는뱃지코드"/>

적용예시


📝 방문자 수

https://hits.seeyoufarm.com/

  • TARGET URL : 방문자를 조회할 페이지의 링크
  • Add Icon : 로고를 선택하여 넣을 수 있다
  • ICON COLOR : 아이콘의 색상
    등등 나머지는 쉽게 이해 가능하다.

📝 Top Languages card

깃 허브에서 자주 사용하는 언어를 보여준다.

  • 특정 언어를 제외시키거나, 특정 레포지토리를 제외시키거나, 보이는 언어의 개수를 조정 등 구체적인 설정도 가능하다

  • 작은 버전으로 크기를 바꿀수도 있고 테마도 변경 가능

예시

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=JoungSangJun)](https://github.com/anuraghazra/github-readme-stats)

Top Langs

자세한 설명은
https://github.com/anuraghazra/github-readme-stats


📝 백준 티어 리드미에 보여주기

예시

[![Solved.ac 프로필](http://mazassumnida.wtf/api/v2/generate_badge?boj=백준아이디)](https://solved.ac/백준아이디)

![mazandi profile](http://mazandi.herokuapp.com/api?handle=백준아이디&theme=warm)

profile
안드로이드개발자

0개의 댓글