본문 바로가기

테크니컬 라이팅

문서에 배지 표시하기

반응형

가끔 깃헙 사이트를 보면 버전이라든지 빌드 상태를 작은 이미지 형태로 표시하는 경우가 있더군요. 저건 무슨 기능이지. 라고 궁금해했는데, 오늘 우연히 몇 가지 방법을 확인했습니다.

 

일단 CI에서 해당 기능을 제공하는 경우가 있더군요. 예를 들어 travis ci 같은 경우에는 빌드 상태에 따라 배지를 자동으로 생성해줍니다. 해당 설정을 넣어두면 빌드 상태에 따라 동적으로 이미지가 업데이트되는 형태입니다.

https://docs.travis-ci.com/user/status-images/

 

Embedding Status Images - Travis CI

Improve this page on GitHub Embedding Status Images You can embed status images (also known as badges or icons) that show the status of your build into your README or website. For example, this badge shows the build status of the travis-web repository: The

docs.travis-ci.com

다른 하나는 shields.io 라는 서비스를 이용하는 겁니다. 원하는 형태로 배지를 만들어주기도 하고, 데이터를 받을 수 있는 경우에는 동적으로도 배지를 만들 수 있습니다.

https://shields.io/category/version

 

Shields.io: Quality metadata badges for open source projects

Love Shields? Please consider donating to sustain our activitiesYour BadgeStaticUsing dash "-" separatorhttps://img.shields.io/badge/ - - .svgDashes --→- DashUnderscores __→_ Underscore_ or Space  →  SpaceUsing query string parametershttps://img.shields.io

shields.io

뭐 이런 배지도 만들 수 있네요.

정기적인 버전 업데이트 정보를 표시하는 용도로도 유용할 것 같은데, 자동으로 업데이트되는 것이 아니면 뭔가 불편할 듯.

 

* 깃헙 아이콘이라고 하기도 하나본데, 깃헙에서만 쓰는 건 아니니~

728x90