GitHub Readme에 Badge 만들기
오픈소스 프로젝트의 Readme는 뱃지가 있는 경우가 대부분이다. 이러한 뱃지를 통해 이 Repo가 어떤 속성인지를 쉽게 알수 있도록 유저에게 제공 한다. 그럼 뱃지를 어떻게 만들고 게시 할 수 있는지 알아보자.
뱃지를 생성하고 링크하는 방법은 여러가지가 있다.
필자의 경우 shields.io 에서 제공해 주는 서비스가 가장 마음에 들어 해당 내용을 포스팅 한다.
타 Repo 에 있는 뱃지 샘플
정말 멋지다.
스타일
뱃지 서비스 사이트 shields.io에 방문하여 형태, 컬러, 스타일 등 제공되는 샘플을 보자.
필자의 경우 ‘flat-square’ 스타일이 가장 마음에 들었다.
Color
기본적으로 아래와 목록에 해당하는 컬러를 지원한다.
brightgreengreen
yellowgreen
yellow
orange
red
lightgrey
blue
success
important
critical
critical color
[Generic badge](https://img.shields.io/badge/version-0.0.1-critical.svg)
important color
Hex Color도 지원한다.
사이트의 샘플 정보를 참고하여 기본 컬러 또는 원하는 컬러를 이용하며 뱃지를 만들어보자.
Text 로고
단일 Text
![Badge](https://img.shields.io/badge/{ label }-{ color }.svg?{ style(optional) })
Message 를 포함한 Text
![Badge](https://img.shields.io/badge/{ label }-{ message }-{ color }.svg?{ style(optional) })
이미지 로고
이미지를 사용할 경우 네이밍을 알아야 한다. simpleicons.org에서 제공하고 있다.
검색 후 해당하는 logo name 을 입력해 보자.
![Badge](https://img.shields.io/badge/{ label }-{ message }.svg?{ style(optional) }&logo={ logoname }&logoColor={ logo color(optional) })
댓글남기기