GitHub上的很多开源项目,首页上都会有一些小的徽章,这些徽章用来展示项目的pod版本,支持平台,隐私协议等,类似这样:
那么,如何给我们的项目添加这些徽章呢?下面我为大家详细讲解~
基本使用
首先,我们打开Shields的官网,然后点击Get started
:
进入新的页面之后,默认选中的是Static Badge
类型的徽章,页面右侧就是生成徽章的地方:
中间的部分是对生成徽章的参数的说明:
大致的意思是说,将你想做成徽章的内容用-
进行连接,内容部分的空格用下划线_
或者%20
代替,然后还可以用-
拼接一些参数,用来设置徽章的样式,比如背景色,风格等。
关于颜色,文档中有如下说明:
The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.
Example: violet
意思是说,你除了可以用具体的色值(hex, rgb, rgba...)表示以外,还可以直接用css支持的颜色命名
来表示。
更多的参数说明,可以参照页面中间部分的说明文档。
这里用pod版本号的徽章进行举例,假设版本是1.0.0
,版本号的部分背景色是蓝色:
想添加更多的参数,可以点击Show optional parameters
,根据文档说明添加自己想要的功能。
这样,徽章就生成完毕了,我们可以复制徽章的地址到我们的README.md
文件,更新之后,我们的项目主页就有pod版本的徽章了~
更多说明
上边只是举个例子,如何制作一个徽章,而关于pod相关徽章,其实是不建议直接使用Static Badge
的,因为Shields
提供了很多特殊徽章的制作方式,页面的左侧就是支持徽章类型的列表,比如pod版本
的徽章,我们可以选中Version
下的Cocoapods
这一项,这一项是专门为Cocoapods
的版本制作徽章的。
如果我们不知道去哪里找,也可以在右上角搜索Cocoapods
,在搜索的结果里选择和版本相关的项。
我们只需要指定spec
,即需要制作徽章的pod库名称
,就可以生成该库当前在cocoapods的最新版本的徽章,以LSYNetworking
为例:
大家可以看到,我并未指定具体的版本号,Shields
就会自动为我生成最新版本的徽章,生成的徽章链接也是和我们的库相关的,并且,后续我们发布了新的版本,徽章也会实时更新,不需要每次发版都修改README.md
文件,下面是生成的连接:
https://img.shields.io/cocoapods/v/LSYNetworking
对比一下之前用Static Badge
生成的徽章:
https://img.shields.io/badge/pod-v1.0.0-blue
除了pod版本
,还有更多的类型可供选择:
LICENSE协议:License
->Cocoapods
支持平台:Platform & Version Support
->Cocoapods platforms
网友评论