Repolode
badges

badges/shields

Shields.io 是一个生成简洁 SVG 与位图状态徽章的服务,并提供 NPM 库 badge-maker。

Star
27,364
Fork
5,630
未关闭 Issue
295
最近提交
20小时前

这是什么?

Shields.io 可以生成风格统一、清晰易读的徽章,用来展示构建状态、版本号、下载量、测试覆盖率等指标。使用时只需把 URL 指向 CI 服务、包仓库、应用商店或代码分析工具等数据源,就能把生成的图片嵌入 GitHub README 或任何网页。服务支持数十种持续集成服务、包管理仓库、社交平台和代码质量工具。

本仓库包含 Shields.io 的前端与服务端代码、用于程序化生成徽章的 NPM 库 badge-maker,以及徽章设计规范。开发者也可以通过静态 URL 自定义标签、信息和颜色,或自行部署服务,并可选接入 Sentry 与 Prometheus。

项目由社区维护,服务端基于 Node.js,文档站点使用 Docusaurus 构建。

核心功能

  • 01通过 URL 直接生成 SVG 与位图徽章,无需账号
  • 02支持众多 CI 服务、包仓库、应用商店和代码分析工具
  • 03提供 badge-maker NPM 库,可在代码中生成徽章
  • 04支持自定义静态徽章,标签和颜色可任意设置
  • 05可自行部署,并可选接入 Sentry 与 Prometheus

适用场景

  • 为 GitHub README 添加构建、覆盖率和版本徽章
  • 在项目主页展示包下载量或发布版本
  • 在 Node.js 构建脚本中使用 badge-maker 程序化生成徽章
  • 为组织内部部署私有徽章服务

快速上手

  1. 1

    使用你偏好的包管理器安装 Node 24

  2. 2

    克隆本仓库

  3. 3

    安装依赖

    npm ci
  4. 4

    启动徽章服务器和前端开发服务器,然后打开 http://localhost:3000/

    npm start

使用前须知

  • 本地开发需要 Node 24 并克隆完整仓库。

标签

#badge#svg#status-badge#ci#readme#nodejs#badge-generator#badge-maker#github#hacktoberfest

常见问题

shields 是什么?
Shields.io 是一个生成简洁 SVG 与位图状态徽章的服务,并提供 NPM 库 badge-maker。 Shields.io 可以生成风格统一、清晰易读的徽章,用来展示构建状态、版本号、下载量、测试覆盖率等指标。使用时只需把 URL 指向 CI 服务、包仓库、应用商店或代码分析工具等数据源,就能把生成的图片嵌入 GitHub README 或任何网页。服务支持数十种持续集成服务、包管理仓库、社交平台和代码质量工具。
shields 可以免费使用吗?用的什么许可证?
shields 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
shields 还在维护吗?
活跃维护中。shields 最近一次提交是在 2026年11月6日。
shields 适合用来做什么?
为 GitHub README 添加构建、覆盖率和版本徽章 在项目主页展示包下载量或发布版本 在 Node.js 构建脚本中使用 badge-maker 程序化生成徽章 为组织内部部署私有徽章服务
shields 怎么安装和运行?
使用你偏好的包管理器安装 Node 24 克隆本仓库 安装依赖: npm ci 启动徽章服务器和前端开发服务器,然后打开 http://localhost:3000/: npm start
在哪里获取 shields?
源代码和安装说明在 GitHub 上:https://github.com/badges/shields

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目