跳至主要内容

动态 YAML 徽章

动态 YAML 徽章允许您使用 JSONPath 选择器从任何 YAML 文档中提取任意值,并在徽章上显示。

查询参数
url 字符串 必需

YAML 文档的 URL

示例:https://raw.githubusercontent.com/badges/shields/master/.github/dependabot.yml

query 字符串 必需

将用于查询文档的 JSONPath 表达式

示例:$.version

prefix 字符串

要追加到值的可选前缀

示例:[

suffix 字符串

要追加到值的可选后缀

示例:]

style 字符串

可能的值: [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> 标签或标记语言。