跳到主要内容

动态 JSON 徽章

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

查询参数
url 字符串 必需

指向 JSON 文档的 URL

示例:https://github.com/badges/shields/raw/master/package.json

query 字符串 必需

一个 JSONPath 表达式,将用于查询文档

示例:$.name

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> 标签或标记语言中。