Shields.io
Shields.io 是一个提供简洁、一致和易读的 SVG 和位图格式徽章的服务,可以轻松地包含在 GitHub 的 README 文件或任何其他网页中。
Tip
由于此项目支持的徽章种类非常多,且功能强大,这里只简单介绍-静态徽章,其他徽章使用方式还请移步官方文档。
参数
点击显示/关闭参数
名称 | 类型 | 必填 | 默认值 | 参数描述 | 更多描述 |
---|---|---|---|---|---|
badgeContent | string | true | 徽章内容 | 格式:标签-消息-消息背景颜色 。 | |
style | string | flat | 徽章整体风格 | 可选值:flat flat-square plastic for-the-badge social 。 | |
logo | string | Logo 图标名称 | 支持 Base64,slugs.md,Simple Icons。 | ||
logoColor | string | Logo 颜色 | 支持格式:HEX RGB RGBA HSL HSLA CSS颜色 ,适用于 simple-icons 库中的标志,但不适用于自定义标志。 | ||
logoSize | string | Logo 自适应大小 | 可选值:auto 。 | ||
label | string | 左侧标签文字 | 覆盖 badgeContent 中 标签 部分。 | ||
labelColor | string | 左侧标签背景颜色 | 支持格式:HEX RGB RGBA HSL HSLA CSS颜色 ,适用于 simple-icons 库中的标志,但不适用于自定义标志。 | ||
color | string | 右侧消息背景颜色 | 覆盖 badgeContent 中 消息背景颜色 部分, 支持格式:同上 logoColor 。 | ||
cacheSeconds | string | 3600 | HTTP 缓存有效期 | 单位:秒,规则应用于推断每个徽标的默认值,任何低于默认值的指定都将被忽略。 | |
link | string | 指定点击徽标左侧/右侧应执行的操作 | 注意:这仅在将徽标集成到 <object> HTML 标签时有效,但不适用于 <img> 标签或标记语言。 |
txt
https://img.shields.io/badge/{badgeContent}{?style,logo,logoColor,logoSize,label,labelColor,color,cacheSeconds,link}
示例
markdown
<!-- badges/shields -->

markdown
