徽章生成器(Shields 风格 SVG)
预览
SVG 代码
Markdown (shields.io)
Markdown(自托管 SVG)
请下载上方的 SVG,将其提交到你的仓库(例如命名为 badge.svg),并使用此相对路径引用,以避免依赖 shields.io。
HTML
reStructuredText
AsciiDoc
shields.io 静态 URL
技术详情
徽章生成器的工作原理
徽章生成器的功能
徽章生成器可将 shields 风格的状态徽章生成为独立的 SVG 文件。输入标签和信息,选择颜色(shields 颜色名称如 brightgreen、十六进制或 rgb 值)以及五种样式之一:flat、flat-square、plastic、for-the-badge 或 social。文本宽度根据 Verdana 字体度量估算,使徽章贴合内容,所有渲染都在浏览器中完成。你可以获得 SVG 代码、下载文件、等效的 shields.io URL 以及可直接粘贴的代码片段。
常见使用场景
README 徽章用于概括构建状态、覆盖率、版本、许可证、支持的平台和赞助信息。当你需要 shields.io 未提供的自定义徽章、需要在离线或内网环境中使用的徽章,或希望把静态 SVG 提交到仓库以免第三方服务宕机时文档失效,就可以使用此工具。内置的构建通过、MIT 许可证、版本、覆盖率和 PRs welcome 预设可帮助你快速上手。
输出格式
输出包括原始 SVG、带 shields.io 图片 URL 的 Markdown、指向自托管 badge.svg 的 Markdown、HTML img 标签、reStructuredText image 指令和 AsciiDoc image 宏。shields.io 静态 URL 遵循文档规定的转义规则:一个短横线变为两个短横线,一个下划线变为两个下划线,空格变为下划线。该 URL 仅作为文本生成,不会被请求。
常见陷阱与边界情况
不是可识别名称、十六进制值或 rgb() 三元组的颜色会被忽略并使用默认值,从而防止向 SVG 注入标记。徽标必须是 base64 的 SVG 或 PNG data URI,并作为图像嵌入,绝不会作为原始标记嵌入。徽章宽度是近似值,因此非常特殊的字体或非拉丁文字的显示宽度可能略大于徽章框。GitHub 对仓库中的 SVG 采用严格的内容策略,因此在仓库之外嵌入时,请使用 raw URL 或 shields.io 版本。