shieldcn icon

shieldcn

shieldcn 生成适用于 README 和文档的徽章,样式类似 shadcn/ui 按钮。支持 npm、GitHub、Discord 等服务的直链徽章,并提供 PNG、SVG 和 JSON 输出。

shieldcn

shieldcn 的功能

shieldcn 是一个面向 README、文档以及其他接受图片 URL 的场景的徽章生成器和端点服务。它提供类似 shadcn/ui 按钮风格的徽章,并通过可预测的路径提供 npm、GitHub、Discord、Homebrew、Tokscale、skills.sh、静态和动态 JSON 徽章。

该产品旨在作为 shields.io 的即插即用替代方案,基础使用不需要 API 密钥或构建步骤。它支持 .png 和 .svg 输出,文档还说明了 .json 和 /shields.json 响应,可用于原始数据或兼容 shields.io。

功能

多种徽章端点类型

徽章通过简单且有文档说明的 URL 模式提供,例如 /npm/{package}、/github/{owner}/{repo}、/discord/{serverId}、/skills/{owner}/{repo}/{skill} 和 /badge/{label}-{message}-{color}。

灵活的响应格式

每个徽章都可以渲染为 .png 或 .svg,并且还提供 .json 和 /shields.json 以获取原始数据或兼容 shields.io 的数据。

细致的视觉自定义

徽章支持 shadcn Button 变体、尺寸选项、主题、字体、颜色、图标覆盖、标签与布局控制,以及仅限 SVG 的动画效果,如 pulse、glow 和 shimmer。

图标处理与覆盖

图标会根据提供方自动检测,文档也允许显式使用 Simple Icons slug、React Icons 名称、禁用图标,或传入自定义 SVG data URI。

仓库徽章生成

生成器可以从 GitHub 仓库 URL 自动检测技术栈,并导出可直接复制粘贴的徽章标记,用于 README。

使用场景

  • 开源项目的 README 徽章

    使用直接图片 URL 为项目 README 添加 npm、GitHub、Discord 或类似徽章。文档特别建议 GitHub README 使用 PNG,因为它在不同客户端中的渲染更一致。

  • 面向仓库的徽章生成

    根据 GitHub 仓库 URL 生成徽章,让工具检测技术栈,并将生成的 markdown 或图片 URL 复制到文档或仓库页面中。

  • 文档站点和产品页徽章

    为产品文档、落地页或接受图片标签的内部文档创建按钮和状态样式徽章。

  • 自定义和动态状态徽章

    在需要与单个包或仓库指标无关的徽章时,使用静态、动态 JSON、分组和自定义徽章端点。

  • 按格式交付

    根据渲染需求在 PNG 和 SVG 之间切换;PNG 适合广泛兼容性,而 SVG 适合需要可缩放输出或仅限 SVG 的动画效果。

  • skills.sh 和个人资料徽章工作流

    为 skills.sh 仓库生成技能安装和排名徽章,或通过基于用户名的流程为个人 README 页面生成个人资料徽章。

Pros and Cons

Pros

  • 覆盖了许多常见的开发者徽章来源,包括 npm、GitHub、Discord、X/Twitter、Homebrew、Tokscale 和 skills.sh。
  • 风格更接近 shadcn/ui 按钮,而不是通用的 shields.io 外观。
  • 支持 PNG 和 SVG,以及原始 JSON 和兼容 shields.io 的输出。
  • 提供丰富的视觉控制,包括变体、尺寸、字体、主题、颜色、图标和布局选项。
  • 静态徽章和基础徽章生成无需 API 密钥。

Cons

  • 文档列出了许多端点类型和参数,因此 URL 表面可能需要一些时间来熟悉。
  • 某些高级选项,例如动画效果,仅支持 SVG。

FAQ

shieldcn 可以生成哪些类型的徽章?

它会根据可预测的 URL 模式生成徽章图片。例如,文档展示了 npm、GitHub、Discord、X/Twitter、Homebrew、Tokscale、skills.sh、静态、动态 JSON、flag 和分组徽章端点。

我可以根据 GitHub 仓库 URL 生成徽章吗?

可以。生成器页面支持使用 GitHub 仓库 URL 或 owner/repo 输入来生成仓库徽章,它也将个人资料徽章生成指向基于用户名的流程,适用于个人 README 页面。

shieldcn 支持哪些输出格式?

可以。文档说明支持 .png 和 .svg,且任何端点也可以请求为 .json,或者通过 /shields.json 以兼容 shields.io。

使用 shieldcn 需要 API 密钥或额外设置吗?

文档说明,基础徽章 URL 不需要配置、API 密钥或构建步骤。

Quick Facts

类别
开发者工具
主要用途
README 和文档徽章
输出格式
PNG、SVG、JSON
支持的工作流
通过直接端点或徽章生成器进行基于 URL 的徽章生成
源域名
shieldcn.dev
定价
免费且开源