shields

这里是Shields.io的家园，一个提供简洁、一致和易读的SVG和光栅格式徽章的服务，可以轻松地包含在GitHub的readme文件或任何其他网页中。该服务支持数十种持续集成服务、包注册表、发行版、应用商店、社交网络、代码覆盖率服务和代码分析服务。每月它提供超过16亿次图像服务，被世界上一些最受欢迎的开源项目使用，如VS Code、Vue.js和Bootstrap等。

这个仓库包含：

Shields.io的前端和服务器代码
一个用于生成徽章的NPM库
- 文档
- 更新日志
徽章设计规范

示例

代码覆盖率百分比：
稳定版本号：
包管理器发布：
第三方依赖状态：
静态代码分析等级：
语义化版本遵守情况：
Liberapay每周捐赠金额：
Python包下载量：
Chrome网上应用店扩展评分：
Uptime Robot正常运行时间百分比：

制作你自己的徽章！（快速示例：https://img.shields.io/badge/left-right-f39f37）

快速开始

浏览完整的徽章列表，使用搜索栏或浏览类别来找到特定的徽章。点击徽章填写该徽章类型所需的数据元素（如你的用户名或仓库），并可选择进行自定义（标签、颜色等）。然后它就可以使用了！

使用底部的按钮复制你的徽章URL或代码片段，然后可以添加到GitHub的readme文件或其他网页中。

贡献

Shields是一个社区项目。我们欢迎你通过问题和拉取请求参与其中！你可以仔细阅读贡献指南。

在添加或更改服务时，请添加测试。

这个项目有相当多的建议积压！如果你是项目新手，也许你想打开一个拉取请求来解决其中之一。

你可以阅读如何添加徽章的教程。

如果你打算报告或贡献与安全漏洞相关的修复，请先参考我们的安全政策。

开发

安装Node 20或更高版本。你可以使用你选择的包管理器。测试需要在Node 20和22上通过。
克隆这个仓库。
运行npm ci安装依赖。
运行npm start启动徽章服务器和前端开发服务器。
打开http://localhost:3000/查看前端。

当服务器源文件发生变化时，徽章服务器应该自动重启（使用nodemon）。当前端文件发生变化时，前端开发服务器（docusaurus start）也应该自动重新加载。但是，徽章定义只在服务器首次启动前构建。要重新生成这些，可以运行npm run prestart或手动重启服务器。

要从命令行调试徽章，运行npm run badge -- /npm/v/nock。它也适用于完整的URL，如npm run badge -- https://img.shields.io/npm/v/nock。

使用npm run debug:server以调试模式启动服务器。 [这个方法][nodemon debug]展示了如何在VS Code中调试Node.js应用。

Shields对Gitpod有实验性支持，这是一个预配置的在浏览器中运行的开发环境。要使用Gitpod，点击下面的按钮并用GitHub登录。Gitpod还提供了一个浏览器插件，但不是必需的。请在问题#2772中报告任何Gitpod的错误、问题或建议。

[快照测试][Snapshot tests]确保我们不会无意中做出影响SVG或JSON输出的更改。当有意更改输出时，运行SNAPSHOT_DRY=1 npm run test:package预览保存的快照的更改，运行SNAPSHOT_UPDATE=1 npm run test:package更新它们。

服务器可以配置为使用Sentry（[配置][sentry configuration]）和Prometheus（[配置][prometheus configuration]）。我们的完整测试套件以及代码覆盖率每天都会运行。

搭建您自己的服务器

关于搭建您自己的服务器的文档。

历史

b.adge.me 是这项服务最初的网站。当时 Heroku 有一个限制，使得很难在其上使用顶级域名，因此使用了这个奇怪的域名。它使用了 2013 年开发的一个名为 gh-badges 的库的代码，两者都是由 Thaddée Tyl 开发的。该项目通过使用 b.adge.me 的代码与 shields.io 合并，并关闭了 b.adge.me。

最初的徽章规范由 Olivier Lacan 于 2013 年开发。它受到了 Travis CI 和类似徽章的启发（当时徽章数量要少得多）。2014 年，Thaddée Tyl 在 Travis CI 员工的帮助下重新设计了它，并说服所有人切换到新设计。旧设计就是现在所说的塑料风格；新设计是扁平风格。

你可以阅读更多关于项目的起源、SVG 徽章规范的动机和规范本身的内容。