跳至主要内容

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

branch 字符串 必需

示例:master

查询参数
filename 字符串

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

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> 标签或标记语言则无效。