shieldcn-badges 用于为 README 和文档添加 shadcn/ui 风格的视觉元素,包括徽章、徽章组、图表、页眉、赞助者网格与贡献者图像。基础地址为 https://shieldcn.dev。
安装:使用 Skills CLI 从仓库安装,命令为 npx skills add jal-co/shieldcn。可选变体:全局安装 npx skills add jal-co/shieldcn --global;为指定代理安装 npx skills add jal-co/shieldcn --agent AGENT_NAME;临时使用 npx skills use jal-co/shieldcn@shieldcn-badges。验证安装用 npx skills list。
主要能力与用法:通过 URL 形式调用,如 https://shieldcn.dev/{provider}/{...params}.svg 生成 SVG 徽章,.png 生成 PNG,.json 返回原始数据,/shields.json 返回 Shields.io 兼容 JSON。支持 GitHub、npm、PyPI、Docker、社交平台、技能等多类 provider。徽章可加查询参数控制 variant、size、mode、theme、font、split、logo、颜色、gradient、animate 等样式。还提供 /chart/ 图表(含 npm 下载、GitHub issues、commits、JSON 内联或远程数据)、/header/ 页眉(surface、gradient、dots、grid、graph、glow、transparent 等预设)、/sponsors/{login}.svg 与 /contributors/{owner}/{repo}.svg。徽章组通过 /group/{badge1}+{badge2}.svg 合并显示。README Studio(https://shieldcn.dev/studio)提供 Figma 风格编辑器。
限制与说明:星标历史图表已停用,因 GitHub 限制 stargazers API,/chart/github/stars/... 会返回透明图;建议改用 issues、commits 或 npm 下载图表。样式上建议顶部徽章保持 3 至 6 个高信号徽章,优先 SVG,链接徽章需用 <a> 包裹,明暗适配用 <picture> 标记。不要在徽章 URL 中硬编码令牌,最终 README 不应留下占位符。完整文档见 https://shieldcn.dev/docs,API 参考见 https://shieldcn.dev/docs/api-reference。