跳至主要内容

GitHub package.json dev/peer/optional 依赖版本

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

路径参数
user 字符串 必填

示例:gatsbyjs

repo 字符串 必填

示例:gatsby

kind 字符串 必填

可能的值: [dev, peer, optional]

示例:dev

packageName 字符串 必填

这可能是无范围包的名称,例如 package-name,或 范围包,例如 @author/package-name

示例:cross-env

查询参数
filename 字符串

示例:packages/gatsby-cli/package.json

style 字符串

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

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

示例:flat

logo 字符串

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

示例: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> 标签或标记语言。