这个工具有问题吗?
关于「Readme Badges Generator Online」
该工具为您的 GitHub README(或任何 Markdown 文档)构建 Markdown 徽章片段。徽章直观显示构建状态、代码覆盖率、包版本、许可证、下载量、社交存在等——使您的项目看起来精致且值得信赖。
常见的徽章类型包括针对库的 shields.io 风格徽章(npm 版本、下载量)、CI 状态(GitHub Actions、CircleCI)、代码质量(Codecov、Coveralls)、许可(MIT、Apache-2.0)和项目元数据(最后提交、贡献者)。
生成的片段是 Markdown,可粘贴到 README 顶部。大多数徽章链接到自动更新的外部服务——因此添加后,它们会持续显示实时数据,无需您编辑文件。
如何使用这个工具
如何为一个 npm 包生成 README 徽章
输入包名
「Package name」需要发布到 npm 的精确包名——`@scope/name` 这样的 scoped 包与 `name` 同理。空白会自动 trim。
点击运行
结果只有 `markdown`,包含三个 shields.io 图片:最新发布版本、周下载量、SPDX 许可证。并排呈现,无换行。
数据来源
每个徽章都是 shields.io 上的一个 URL,在渲染时请求 npm registry 端点。自动更新——发布新版本后无需重新生成徽章。
定制徽章
直接把 markdown 贴到 README 顶部。想换样式?编辑生成的 URL——shields.io 支持 `?color=blue`、`?style=flat-square`、`?logo=npm` 等参数,完整参考见 shields.io。