Read the Docs

ReadTheDocs 是一个文档托管服务。

路径参数
packageName 字符串 — 必需 例如：pip

查询参数
style 字符串 可能的值： [flat, flat-square, plastic, for-the-badge, social] 如果未指定，此徽章的默认样式为 "flat"。 例如：flat
logo 字符串 来自 simple-icons 的图标 slug。您可以在 simple-icons 上点击图标标题以复制 slug，或者可以在 simple-icons 存储库中的 slugs.md 文件 中找到它们。 更多信息。 例如：appveyor
logoColor 字符串 徽标的颜色（支持十六进制、rgb、rgba、hsl、hsla 和 css 命名颜色）。支持 simple-icons 徽标，但不支持自定义徽标。 例如：violet
logoSize 字符串 通过设置 auto 使图标自适应调整大小。对某些较宽的徽标（如 amd 和 amg）很有用。支持 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> 标签或标记语言中无效。