SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场shieldcn-badges

shieldcn-badges

写作与研究

查看项目

更新于 10-20 08:36

技能介绍

用途

shieldcn Badges 用于为 README 和文档添加 shadcn/ui 风格的视觉素材，包括徽章、徽章组、图表、页头横幅、赞助者网格和贡献者图像。所有素材都以图片 URL 形式提供，可直接嵌入 Markdown。

主要能力

  • 徽章：覆盖 GitHub（星标、分叉、许可证、发布、CI 状态、议题、PR、贡献者、最近提交、Watchers、下载量、Dependabot）、包管理器（npm、PyPI、Crates.io、Docker Hub、JSR、Homebrew、Maven、Packagist、RubyGems、NuGet、Pub.dev、CocoaPods、Bundlephobia）以及社交、质量与技能类数据（Discord、Reddit、Bluesky、YouTube、Mastodon、Hacker News、Codecov、VS Code、WakaTime、Skill 安装/排名）。
  • 自定义徽章：静态徽章、动态 JSON 徽章、HTTPS 端点代理，以及通过 /group/ 将多个徽章合并为一张图。
  • 样式参数：variant、size、mode（明/暗）、theme 主题色、font 字体、split 双色、logo、颜色、渐变、statusDot、animate 以及尺寸微调参数。
  • 图表：GitHub 议题趋势、贡献提交、npm 下载历史、内联数值或远程 JSON 数值图表。注意星标历史图表已停用（GitHub 限制 stargazers API），此类 URL 返回透明图，星标数量徽章仍可用。
  • 页头横幅：surface、gradient、dots、grid、graph、glow、transparent 等预设，支持标题、副标题、logo、对齐、配色等参数。
  • 赞助者与贡献者图像：/sponsors/{login}.svg 与 /contributors/{owner}/{repo}.svg，支持卡片背景系统与数量控制。

使用方式

通过 Skills CLI 安装：

npx skills add jal-co/shieldcn

可加 --global 全局安装，或用 --agent AGENT_NAME 指定代理；也可用 npx skills use jal-co/shieldcn@shieldcn-badges 一次性使用。

URL 基本形式：

https://shieldcn.dev/{provider}/{...params}.svg
https://shieldcn.dev/{provider}/{...params}.png
https://shieldcn.dev/{provider}/{...params}.json
https://shieldcn.dev/{provider}/{...params}/shields.json

Markdown 用法示例：

[![npm version](https://shieldcn.dev/npm/react.svg)](https://www.npmjs.com/package/react)

自适应明暗主题可配合 GitHub <picture> 标签，分别指定 mode=dark 与 mode=light 的 URL。

如需从零构建或整体重设计 README，可使用 README Studio（https://shieldcn.dev/studio），其提供分块可视化编辑并导出 GitHub 风格 Markdown，支持导出为自适应 <picture> 元素。

适用场景

适合开源项目、库、CLI 工具、文档站点等在 README 顶部展示高信号徽章（建议 3-6 个）、项目页头横幅、下载或贡献趋势图表，以及社区赞助者与贡献者展示。

限制

  • 星标历史图表已停用，无法使用。
  • 功能、收费、价格与平台支持等信息以官方文档为准，资料未提供的内容暂未提供。
  • 徽章数据依赖对应外部服务与 API 的可用性。