Shields – 开源徽章生成与自托管工具

Shields – 开源徽章生成与自托管工具

Shields
Shields 是一个开源的徽章生成服务,用一条图片地址就能把项目的构建状态、版本号、下载量、代码覆盖率等指标渲染成统一的 SVG 徽章。它的定位写在首页标语里——Concise, consistent, and legible badges,也就是简洁、一致、易读。首页把能力拆成四条路径:动态徽章、静态徽章、badge-maker 渲染库与自托管实例。动态徽章面向数百个第三方服务抓取项目指标,静态徽章则允许自定义标签、消息与颜色,按短横线规则拼出地址即可。开发者还能用官方 NPM 库把徽章渲染进自己的应用,或用 docker 镜像把整套服务部署到防火墙内。
网站&在线应用

简介

Shields 的首页像一张能力地图:Dynamic badges 一栏写着「Show metrics for your project. We’ve got badges for hundreds of services.」,把上百个服务的项目指标变成可嵌入的徽章;Static Badges 一栏给出「Create a badge with」的即填即得入口;Badge-Maker NPM library 一栏给出 npm install badge-maker,让徽章在自己的应用里渲染;Host your own instance 一栏则指向 docker 镜像,可以把实例部署在防火墙内。顶栏把 Badges、Documentation、Donate、Community、Blog 与 GitHub 入口排在一起,并支持 Ctrl+K 唤起搜索。徽章目录按用途分组,Activity、Analysis、Build、Chat、Code Coverage、Dependencies、Downloads、Funding、Issue Tracking、License、Monitoring、Platform & Version Support、Rating、Size、Social、Test Results、Version 等分组之外,Core 一栏还列出 Static Badge、Dynamic JSON / Regex / TOML / XML / YAML 与 Endpoint Badge 等核心端点。静态徽章的地址规则很直白:用短横线依次拼上标签、消息与颜色,例如 any_text-you_like-blue,只写消息与颜色也可以;路径里的下划线或 %20 会转成空格、双下划线转成下划线、双短横线转成短横线,颜色支持十六进制、rgb、rgba、hsl、hsla 与 CSS 颜色名,logo 参数取 simple-icons 的图标 slug。可选的 style 支持 flat、flat-square、plastic、for-the-badge 与 social 等取值,cacheSeconds 可以指定图片的 HTTP 缓存时长,文档给的示例是 3600。项目以 Docusaurus 构建文档站,社区入口包括 GitHub、Open Collective 与 Discord,并接受捐赠维持运营。

✨ 优缺点

  • ✅ 样式与配色自由:style 支持 flat、flat-square、plastic、for-the-badge 与 social 等取值,颜色可用十六进制、rgb、rgba、hsl、hsla 与 CSS 颜色名,logo 取 simple-icons 图标。
  • ✅ 服务覆盖面广:动态徽章写明已为数百个服务提供指标徽章,构建、下载量、代码覆盖率、License、社交关注等常见指标都有现成端点。
  • ✅ 地址规则直观:静态徽章按「标签-消息-颜色」拼出图片地址即可得到徽章,无需注册或申请密钥就能直接嵌进 README 与文档。
  • ✅ 渲染库可嵌入:官方 badge-maker 库用 npm install badge-maker 安装,可以在自己的应用程序里直接渲染出徽章图片。
  • ❌ 门槛偏开发者向:徽章主要靠手写地址与查询参数拼装,没有面向普通用户的可视化生成表单,不熟悉路径规则的人需要先读文档。
  • ❌ 依赖上游数据:动态徽章的指标来自第三方服务的公开接口,对方接口变动或限流时,徽章会显示异常或直接报错。

📖 使用方法

  1. 打开站点首页,先按需求选路径:要看现成指标进 Dynamic badges,要自定义内容进 Static Badges。
  2. 在 Badges 目录里按分组挑端点,例如 Build、Downloads、Code Coverage、License 或 Version。
  3. 把端点参数与 style、logo、color、cacheSeconds 等查询参数拼进图片地址,或直接用页面上的表单与 Execute 按钮生成。
  4. 在输出区切换 URL、Markdown、rSt、AsciiDoc、HTML 等格式,复制对应写法粘贴到 README 或文档站。
  5. 需要内网或批量使用时,用 badge-maker 库在应用里渲染,或用 docker 镜像自建一个实例。

💰 收费说明

对使用者免费:徽章渲染不收费,也没有账号与配额概念,站点上看不到付费墙。运营依靠社区捐赠维持,首页明确写着「Please consider donating to sustain our activities」,并提供 Open Collective 入口;项目源码公开在 GitHub 上,官方也鼓励通过加星标帮着扩散。自托管同样不产生授权费用,用官方 docker 镜像就能把实例部署在自己服务器或内网里。

🌐 平台支持

以网页为主要使用方式:徽章最终输出为图片,任何支持外链图片的 Markdown、HTML 或文档系统都能直接嵌入。站点界面用 Docusaurus 构建,现代浏览器打开即可,不需要安装客户端。生成的徽章适合放进 GitHub README、项目文档站或内部看板,也可以配合 badge-maker 库渲染进自建应用,并通过 docker 镜像把服务部署到防火墙内。


截图

Shields

相关链接


功能标签


特色

★
样式与配色自由
style 支持 flat、flat-square、plastic、for-the-badge 与 social 等取值,颜色可用十六进制、rgb、rgba、hsl、hsla 与 CSS 颜色名。
★
覆盖服务众多
动态徽章写明已为数百个服务提供指标徽章,构建、下载量、覆盖率、License、社交关注等常见指标都有现成端点。
★
地址规则直观
静态徽章按「标签-消息-颜色」拼出图片地址即可,无需注册或申请密钥就能嵌入 README 与文档。
★
渲染库可嵌入
官方 badge-maker 库用 npm install badge-maker 安装,可在自己的应用程序里直接生成徽章图片。
★
支持自托管
提供 docker 镜像,可以把 shields 实例部署在防火墙内,适合内网或私有项目使用。
★
缓存时长可控
cacheSeconds 参数可指定徽章图片的 HTTP 缓存时长,文档示例为 3600,方便在实时性与请求量之间取舍。

替代方案

开发者工具
Transform Tools
Transform Tools 是一个免…
Mockaroo
Mockaroo 是一款由美国 Mock…
RegExr
《RegExr》是加拿大创意工作室 gs…
Can I Use
Can I Use 是前端开发圈最著名的…
Overleaf
Overleaf 是面向科研与技术写作者…
网站反馈表单
关注我们

公众号二维码

公众号

公众号二维码

小程序

反馈

网站无法访问了?向我们反馈!
点击下面的 反馈 按钮即可让我们知道!感谢!

为了阻止机器人发送垃圾信息,记得点击验证。

© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享