amio/badgen
amio
Badgen Service是一个快速的徽章生成服务，支持经典和扁平两种视觉样式，提供静态（URL定义）和动态（第三方服务实时状态）徽章，基于TypeScript构建，使用badgen库实时生成SVG，适用于GitHub、NPM等场景的状态展示。
1 次收藏下载次数: 0状态：社区镜像维护者：amio仓库类型：镜像最近更新：4 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Badgen Service 镜像文档
镜像概述
Badgen Service 是一个快速的徽章生成服务，作为 shields.io 的替代方案，旨在提供更简洁、灵活且高性能的徽章生成能力。其核心优势在于轻量级代码库（约2K LoC）、快速响应速度和全球分布式缓存（基于Vercel Edge Network），支持实时生成SVG格式徽章，广泛应用于项目README、文档页面等场景的状态展示。
核心功能与特性
- 多视觉样式：支持两种风格
- 经典样式：
https://badgen.net - 扁平方形样式：
https://flat.badgen.net
- 经典样式：
- 双徽章类型：
- 静态徽章：通过URL直接定义标签（label）、状态（status）和颜色（color）
- 动态徽章：实时展示第三方服务状态（如GitHub、NPM、Crates等）
- 图标支持：内置图标库及外部图标扩展（基于 https://github.com/badgen/badgen-icons%EF%BC%89
- 技术栈：使用TypeScript编写，基于 https://github.com/amio/badgen 库实时生成SVG
- 容器化：提供官方Docker镜像
amio/badgen，便于本地部署和集成
使用场景
- GitHub项目README中的状态徽章（如贡献者数量、依赖状态、构建状态）
- NPM包版本、下载量等信息展示
- Crates.io Rust包信息展示
- 自定义服务状态监控与可视化
- 文档页面中的动态状态指示
使用方法
开发环境启动
bashnpm run dev
生产环境启动
bashnpm run build && npm start
Docker部署示例
基础运行
bashdocker run -p 3000:3000 amio/badgen
服务启动后，可通过 http://localhost:3000 访问徽章生成服务。例如：
- 静态徽章：
http://localhost:3000/badge/status/green?label=example - 动态徽章（GitHub贡献者）：
http://localhost:3000/github/contributors/badgen/badgen.net
带环境变量配置
bashdocker run -p 3000:3000 \ -e GITHUB_TOKENS="token1,token2" \ -e NPM_REGISTRY="https://registry.npm.taobao.org" \ amio/badgen
配置参数
通过环境变量可配置Badgen Service实例，支持以下参数：
| 环境变量 | 说明 | 格式示例 | 是否必填 |
|---|---|---|---|
GITHUB_TOKENS | GitHub令牌列表（逗号分隔），用于访问GitHub API（动态徽章功能） | ghp_xxx,ghp_yyy | 是（若使用GitHub相关动态徽章） |
GITHUB_API | 自定义GitHub API端点（适用于企业版GitHub） | https://github.mycompany.com/api/v3 | 否 |
GITHUB_API_GRAPHQL | 自定义GitHub GraphQL API端点 | https://github.mycompany.com/api/graphql | 否 |
NPM_REGISTRY | 自定义NPM镜像源 | https://registry.npm.taobao.org | 否 |
SENTRY_DSN | Sentry错误监控数据源名称 | https://xxx@sentry.io/yyy | 否 |
TRACKING_GA | Google Analytics跟踪ID（用于文档页面统计） | UA-XXXXXX-X | 否 |
扩展能力
添加动态徽章
若需支持新的第三方服务动态徽章，可在 api/[服务名].ts 中添加实现（如 api/crates.ts 对应Crates.io徽章），并更新 libs/badge-list.ts 索引。开发时通过 npm run dev 启动服务验证。
自定义图标
可通过 https://github.com/badgen/badgen-icons 项目贡献图标，需使用 https://jakearchibald.github.io/svgomg/ 优化SVG文件。
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
DockerHub 原生拉取命令
docker pull amio/badgen:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"