README 徽章生成器

Markdown
结果

输入标签、消息和颜色,这个生成器就会创建一个静态 shields.io 徽章:也就是你在 README 标题下方看到的那种扁平小圆角标记(build | passinglicense | MITversion | 1.4.0)。它会显示实时预览,并同时提供 Markdown 和 HTML 代码供你粘贴。Shields.io 是开源项目事实上的徽章服务;其网址格式简单,但难以记忆,因此一个小小的图形界面能在你搭建新仓库时节省几分钟。

如何创建徽章

  1. 1

    填写标签和消息

    标签是左半部分(灰色),消息是右半部分。填写你希望徽章显示的内容:`build` / `passing`、`coverage` / `98%`、`license` / `MIT`。

  2. 2

    选择颜色

    可以是命名颜色(brightgreen、blue、red、orange),也可以是十六进制代码,如 `#ff0000`。它会填充徽章的右半部分。

  3. 3

    设置样式

    选择一种样式(`flat`、`flat-square`、`for-the-badge`、`plastic`、`social`),并可选地通过 simple-icons 的标识符添加一个徽标(github、npm、docker)。

  4. 4

    复制 Markdown 或 HTML

    将代码粘贴到你的 README 中。填写可选的链接网址即可让徽章可点击。Shields.io 会按需渲染 SVG。

常用徽章配方

本工具生成静态的 badge/label-message-color 形式。若需展示实时数据的徽章(构建状态、版本、下载量),请从下方复制一个 shields.io 网址模板,直接粘贴到你的 README 中。

用途 shields.io 网址模板
npm 版本 https://img.shields.io/npm/v/{package}
npm 下载量 https://img.shields.io/npm/dm/{package}
GitHub 星标数 https://img.shields.io/github/stars/{owner}/{repo}
GitHub 最近提交 https://img.shields.io/github/last-commit/{owner}/{repo}
GitHub 工作流状态 https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
许可证 https://img.shields.io/github/license/{owner}/{repo}
PyPI 版本 https://img.shields.io/pypi/v/{package}
Docker 拉取量 https://img.shields.io/docker/pulls/{org}/{image}
Codecov 覆盖率 https://img.shields.io/codecov/c/github/{owner}/{repo}
静态标签 https://img.shields.io/badge/{label}-{message}-{color}

徽章样式对比

  • flat,经典的圆角矩形。默认样式。
  • flat-square,直角边缘,略显现代。
  • for-the-badge,全大写的块状字母,最大程度吸引注意。
  • plastic,渐变和内阴影,复古风格。
  • social,圆角和柔和配色,与 GitHub 自带的星标/复刻按钮风格一致。

何时使用徽章

  • 构建 + 覆盖率,告诉访客这个项目确实在维护。
  • 版本 + 下载量,告诉他们它正在被使用。
  • 许可证,面向考虑贡献或使用者的法律信号。
  • 文档链接,外部文档站点或 rustdoc.rs。
  • 聊天 / 支持,Discord、Matrix 或 GitHub Discussions 的链接。

何时不该使用徽章

  • 永不更新的虚荣指标。 为一个 0 星标的仓库显示“星标”徽章,会让项目显得毫无生气。
  • 每一个可能的指标。 五个徽章能讲述一个故事;十五个则什么都说明不了。
  • 重复信息。 许可证和“MIT”出现两次,或版本既作为徽章、又出现在正文第一行。
  • 为你并未使用的服务添加徽章。 如果没有配置覆盖率报告,就不要添加 Codecov;一个坏掉的徽章比没有徽章更糟。

缓存与可靠性

Shields.io 会积极缓存请求。更新缓慢的徽章通常只需刷新缓存(追加 ?v=2)或等待几分钟。如果 shields.io 宕机,GitHub 会显示没有图形的“shields”文字;值得注意,但它会很快恢复。

常见问题

不需要。Shields.io 免费,靠捐赠运营。请求量非常大的用户会被建议自行托管或支持该项目。

可以。Shields 是开源的,你可以在自己的域名下运行它。不过大多数项目并不需要这么做:免费服务足够可靠。

缓存。追加 ?cacheSeconds=60?v=anything 以强制刷新。传播可能需要几分钟。

可以,追加 ?logo=github(或任意 simple-icons 标识符)。使用 ?logoColor=white 调整图标颜色。

不会。一切都在浏览器中完成,网址在客户端生成以便复制。

相关工具

此工具还提供其他语言版本