Qiita 기사에 자연스럽게(하지만, 알기 쉽게) 환경을 기재한다

4707 단어 배지Qiita환경
소개 요 전날, @uhooi 씨의 이하의 트윗을 보았을 때, 저 자신과 같은 고민이구나라고 생각해, Qiita 기사의 「어디에」, 「4

Qiita에 기사를 투고할 때 언제나 고민하는 것이 「환경」을 쓰는 위치인데, 버전에 따라 동작이 다를 수도 있기 때문에 쓰지만, 흐름을 끊어 버리는 경우가 많다 htps // t. 코/TbpySzD4S3 피 c. 라고 r. 코 m / 미 6kc36에 8H the_uhooi) August 20, 2020


자연스럽게 (그러나 알기 쉽게) 환경을 설명하는 방법



과부족 없이 간결하게 환경을 기재하는 방법을 모색한 결과, OSS의 README.md에서 자주 이용되고 있는 badge 서비스(Shields IO이나 Badgen 등)를 이용해, 환경을 기사의 1위에 badge 표시하기로 결정했습니다. 1



이 기사에서도 Shields IO을 사용하여 OS 버전과 업데이트 날짜를 기사의 맨 위에 badge 표시하고 있습니다.



Shields IO를 사용하여 배지를 표시하는 방법



여기에서는 Shields IO에서 배지를 표시하는 방법을 설명합니다.

Shields IO에서는 다음 형식으로 URL에 액세스하여 배지의 svg 이미지를 얻을 수 있습니다.



https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>


Qiita 기사에서는 다음 markdown을 작성하는 방법으로



![<LABEL>-<MESSAGE>](https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>)


다음과 같은 표시가 가능합니다.

덧붙여 이번은 건드리지 않았습니다만, 외형을 변경할 수 있는 style 옵션이나, 그 외 옵션이 아직도 있기 때문에, 흥미있는 사람은Shields IO 사이트를 확인하십시오.



아래 OS 버전과 업데이트 날짜의 예입니다



e.g. OS 버전



![macOS-11.0 Beta(20A5354i)](https://img.shields.io/badge/macOS-11.0 Beta(20A5354i)-brightgreen)


e.g. 갱신일 ![Last Modified-2020/08/22](https://img.shields.io/badge/Last Modified-2020/08/22-brightgreen)

마지막으로 나는 이번의 방법으로 자연스럽게(하지만, 알기 쉽게) 환경을 기재하면 좋을까라고 생각하고 있습니다만, 정답이 없는 이야기이므로 다른 좋은 방법 알고 있어, 등 코멘트 받을 수 있으면 기쁩니다 참고 정보







  1. @ 미카 눈 씨의 「 Qiita 컨트리뷰션 수를 GitHub의 프로필에 붙여 드릴 수 있는 서비스를 만들었다 」을 읽고, Qiita에서도 badge 표시할 수 있다고, 깨달았습니다. 





좋은 웹페이지 즐겨찾기