Skip to content

Shields.io

Shields.io 是一个提供简洁、一致和易读的 SVG 和位图格式徽章的服务,可以轻松地包含在 GitHub 的 README 文件或任何其他网页中。

ref-reporef-online-toolref-official-doc

Tip

由于此项目支持的徽章种类非常多,且功能强大,这里只简单介绍-静态徽章,其他徽章使用方式还请移步官方文档。

参数

点击显示/关闭参数

名称类型必填默认值参数描述更多描述
ref-params
badgeContentstringtrue徽章内容格式:标签-消息-消息背景颜色
ref-querys
stylestringflat徽章整体风格可选值:flat flat-square plastic for-the-badge social
logostringLogo 图标名称支持 Base64,slugs.mdSimple Icons
logoColorstringLogo 颜色支持格式:HEX RGB RGBA HSL HSLA CSS颜色,适用于 simple-icons 库中的标志,但不适用于自定义标志。
logoSizestringLogo 自适应大小可选值:auto
labelstring左侧标签文字覆盖 badgeContent标签 部分。
labelColorstring左侧标签背景颜色支持格式:HEX RGB RGBA HSL HSLA CSS颜色,适用于 simple-icons 库中的标志,但不适用于自定义标志。
colorstring右侧消息背景颜色覆盖 badgeContent消息背景颜色 部分, 支持格式:同上 logoColor
cacheSecondsstring3600HTTP 缓存有效期单位:秒,规则应用于推断每个徽标的默认值,任何低于默认值的指定都将被忽略。
linkstring指定点击徽标左侧/右侧应执行的操作注意:这仅在将徽标集成到 &lt;object> HTML 标签时有效,但不适用于 <img> 标签或标记语言。
txt
https://img.shields.io/badge/{badgeContent}{?style,logo,logoColor,logoSize,label,labelColor,color,cacheSeconds,link}

示例

markdown
<!-- badges/shields -->
![静态徽章](https://img.shields.io/badge/badges/shields-555555?logo=github)
静态徽章
markdown
![颜色徽章](https://img.shields.io/badge/F94144-F94144)
Color Badge F94144Color Badge F3722CColor Badge F8961EColor Badge F9844AColor Badge F9C74FColor Badge 90BE6DColor Badge 43AA8BColor Badge 4D908EColor Badge 577590Color Badge 555555Color Badge 277DA1

Badge Collection (v3.0.4) MIT Licensed