GitHub Readme Stats：给你的 README 加上动态数据卡片
文章目录
- GitHub Readme Stats：给你的 README 加上动态数据卡片
- 1、 这玩意儿是干嘛的
- 2、 能生成哪些卡片
- 3、 怎么用
- 4、 部署方式
- 5、 适合谁用
GitHub Readme Stats：给你的 README 加上动态数据卡片
GitHub Readme Stats 在 GitHub 上已经拿到 79.7K Star 了。
这个开源项目做了一件事：在你的 GitHub 个人主页 README 里，自动生成各种统计卡片。Star 数、提交次数、PR 数量、常用语言分布，全都用卡片形式展示出来，数据实时更新。
1、 这玩意儿是干嘛的
一句话：让你的 GitHub 个人主页更好看、信息更丰富。
很多人写 README 就是放几行文字介绍自己，顶多贴个头像。但如果你想展示自己的技术栈、贡献活跃度、项目情况，手动维护这些信息太麻烦了。
GitHub Readme Stats 提供了一套 API，你只需要在 README 里加一行代码，就能自动生成统计卡片。卡片样式支持自定义颜色、主题、布局，还能根据 GitHub 的深色/浅色模式自动切换。
2、 能生成哪些卡片
这个项目提供了五种卡片类型：
Stats Card：展示你的 GitHub 统计数据，包括 Star 总数、提交次数、PR 数量、Issue 数量、贡献的仓库数。还有一个基于日本学术评分体系的等级排名，从 S 级（前 1%）到 C 级。
Top Languages Card：展示你最常用的编程语言分布。支持普通布局、紧凑布局、环形图、饼图等多种样式，最多显示 20 种语言。
Extra Pins：GitHub 默认只能置顶 6 个仓库，用这个功能可以突破限制，想置顶多少就置顶多少。
Gist Pins：把你的 Gist 也置顶到个人主页上。
WakaTime Stats Card：接入 WakaTime 数据，展示你的编码时间统计。
3、 怎么用
用法很简单。以 Stats Card 为例，把下面这行代码贴到你的 README.md 里：
Top Languages Card：
Extra Pins：
每种卡片都支持大量参数定制。比如改颜色、换主题、隐藏某些统计项、调整卡片宽度。内置了十几套主题，包括 dark、radical、tokyonight、dracula 这些。
想让卡片在 GitHub 深色和浅色模式下显示不同样式，可以用 GitHub 的 theme context 标签，或者用 HTML 的 picture 元素配合 media query。
4、 部署方式
公共实例有时候会因为流量太大或 API 限流变得不稳定。官方推荐两种更可靠的方式：
GitHub Actions：在你自己的仓库里配置一个 workflow，定期生成卡片图片，完全免费，不受限流影响。
自托管：把项目部署到 Vercel 或其他平台，用自己的 GitHub API Token，数据更准确（能统计私有仓库），也更稳定。
自托管的话，环境变量可以控制缓存时间、Token 配置等。默认缓存时间是 24 小时，可以自己调整。
5、 适合谁用
想让 GitHub 个人主页更专业、更有信息量的开发者。不管你是想找工作的应届生，还是想展示开源贡献的资深工程师，这套工具都能派上用场。
做技术博客、写开源项目文档的时候，也可以用这些卡片来展示项目活跃度和社区规模。
，还是想展示开源贡献的资深工程师，这套工具都能派上用场。
做技术博客、写开源项目文档的时候，也可以用这些卡片来展示项目活跃度和社区规模。