跳至主要内容

GitHub 提交状态

显示标签、提交或分支的状态,由提交状态 API 报告。现在,GitHub Actions 和许多第三方集成通过 Checks API 报告状态。如果此徽章未显示预期值,请尝试使用相应的检查运行徽章。您可以在 GitHub 文档 中阅读有关状态检查的更多信息。

如果您的 GitHub 徽章出错,可能是因为您遇到了 GitHub 的速率限制。您可以通过 添加 Shields GitHub 应用程序(使用您的 GitHub 帐户)来提高 Shields.io 的速率限制。

路径参数
user 字符串 必需

示例:badges

repo 字符串 必需

示例:shields

commit 字符串 必需

示例:91b108d4b7359b2f8794a4614c11cb1157dc9fff

查询参数
style 字符串

可能的 value:[flat, flat-square, plastic, for-the-badge, social]

如果未指定,此徽章的默认样式为“flat”。

示例:flat

logo 字符串

来自 simple-icons 的图标标识。您可以在 simple-icons 上点击图标标题以复制标识,或者可以在 simple-icons 存储库的 slugs.md 文件 中找到它们。 更多信息.

示例:appveyor

logoColor 字符串

徽标的颜色(支持十六进制、rgb、rgba、hsl、hsla 和 css 命名颜色)。支持 simple-icons 徽标,但不支持自定义徽标。

示例:violet

logoSize 字符串

通过设置 auto 使图标自适应调整大小。对一些较宽的徽标(如 amdamg)很有用。支持 simple-icons 徽标,但不支持自定义徽标。

示例:auto

label 字符串

覆盖默认的左侧文本(URL 编码 对于空格或特殊字符是必需的!)

示例:healthiness

labelColor 字符串

左侧部分的背景颜色(支持十六进制、rgb、rgba、hsl、hsla 和 css 命名颜色)。

示例:abcdef

color 字符串

右侧部分的背景颜色(支持十六进制、rgb、rgba、hsl、hsla 和 css 命名颜色)。

示例:fedcba

cacheSeconds 字符串

HTTP 缓存生命周期(规则用于推断每个徽章的默认值,任何低于默认值的指定值都将被忽略)。

示例:3600

link 字符串[]

指定单击徽章的左侧/右侧应该做什么。请注意,这仅在将徽章集成到 <object> HTML 标签中时有效,而对于 <img> 标签或标记语言则无效。