什么是 Shields.io?
Shields.io 是一个开源的徽章生成服务,提供简洁、一致、易读的 SVG 和位图格式徽章,广泛应用于 GitHub 项目的 README 文件中。 这些徽章可以显示项目的构建状态、版本信息、许可证类型、下载次数、依赖状态等,帮助开发者快速传达项目的关键信息。
Shields.io 的主要功能
1. 静态徽章
静态徽章的内容是固定的,适用于展示不需要实时更新的信息。
生成静态徽章的基本格式如下:
https://img.shields.io/badge/{标签}-{内容}-{颜色}
例如:
https://img.shields.io/badge/License-MIT-green
这将生成一个显示“License: MIT”的绿色徽章。
下面是一个示例,显示了GitHub上YBlog项目的星数,其中cacheSeconds代表缓存时间:
https://img.shields.io/github/stars/PaulYu1988/YBlog?cacheSeconds=3600
2. 动态徽章
动态徽章可以根据外部数据源实时更新内容,适用于展示项目的构建状态、下载次数等动态信息。
例如,显示 GitHub 项目的 star 数量:
https://img.shields.io/github/stars/{用户名}/{仓库名}
如果需要展示自定义的动态数据,可以结合第三方 API 使用。例如,使用 Substats 提供的 API 获取关注者数量,再通过 Shields.io 显示:
https://img.shields.io/badge/dynamic/json?color=blue&label=Followers&query=$.data.totalSubs&url=https://api.example.com/substats/?source=github&queryKey=username
如何使用 Shields.io
- 访问官网:前往 Shields.io官网。
- 选择徽章类型:在首页可以看到各种预设的徽章类型,如构建状态、版本信息等。
- 自定义徽章:点击“Make your own badge”进入自定义页面,填写标签、内容、颜色等信息,生成专属徽章。
- 获取链接:生成徽章后,可以复制其 Markdown 或 HTML 格式的链接,嵌入到你的 README 文件或网页中。
使用 Shields.io 通过简单的 URL 配置,用户可以生成静态或动态的 SVG 格式徽章,提升项目的专业性和可读性。