最近在整理发表论文的代码,因此会整理一些这相关的工具。

在很多 GitHub 项目中,会有一些看起来很专业的徽章,比如 MIT Lisence 这种。其实,这种徽章都是来源于 shields.io 这个项目。

该项目支持的徽章包括多种类型:

  1. 静态徽章,也就是徽章上的内容和配色方案都是固定的。
  2. 动态徽章。这类徽章可以获取项目或者网站的部分数据信息,比如 GitHub 仓库的 star 数等。

# 静态徽章

静态徽章的内容是直接写死在对应的网址中的。比如刚才提到的 MIT Lisence 徽章,对应的代码为

https://img.shields.io/badge/lisence-MIT-yellow

其中包括两个 - 分割线,第一个用来分隔徽章左右两侧的内容,第二个用来确定徽章右侧的配色。

# 动态徽章

动态徽章的自由度比较大,既可以在 JSON 文档、XML 文档等中获取数据,也可以直接将主要网站(比如 GitHub)等信息授权给 shields.io , 然后获取网站上的部分数据。

如果是主要的网站,那么可以直接在官网上搜索,比如在右上角搜索栏搜索 GitHub Stars 等,就可以直接创建对应的徽章。

# 在徽章中自定义图标

一个例子是:Python. 其对应的代码如下:

![Python](https://img.shields.io/badge/Python-3.10-green?style=flat-square\&logo=python\&logoColor=white)

这里使用的图标来自 Simple Icons. 对于其余的设置,看看其实也大概懂了。

# References

  • shields.io
  • Github 项目中看起来很专业的徽章是怎么来的 - 巫師練法術的文章 - 知乎