前言
这个项目可以在你的README中获取动态生成的 GitHub 统计信息,生成有你的github数据(包括总提交数Commits、项目被收藏数Stars、总PR数、贡献次数Contributed),编程语言使用情况,和Pinned
推荐置顶项目仓库卡片。这个README是在以用户名命名的仓库中,例如’coderxm’,这是一个特殊的仓库,github会告诉你,而不是coderxm.github.io
命名的仓库,这个仓库一般用来建立个人博客,而且会得到一个和仓库名一样的个人域名,使用GItPage就能获得。而coderxm
这个仓库是用来介绍自己的 profile,一般只有README.md一个文件,打开github个人主页的时候,就能看到这个profile
,但是利用这个项目可以得到方便的扩展和美化,项目是利用javascript
写的,部署和配置都很简单。有如下配置:
项目地址:https://github.com/anuraghazra/github-readme-stats
GitHub 统计卡片
将这行代码复制到你的 markdown 文件中,就是如此简单!
更改 ?username=
的值为你的 GitHub 用户名。
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
隐藏指定统计
想要隐藏指定统计信息,你可以调用参数 ?hide=
,其值用 ,
分隔。
选项:
&hide=stars,commits,prs,issues,contribs
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)
将私人项目贡献添加到总提交计数中
你可以使用参数 ?count_private=true
把私人贡献计数添加到总提交计数中。
注:如果你是自己部署本项目,私人贡献将会默认被计数,如果不是自己部署,你需要分享你的私人贡献计数。
选项:
&count_private=true
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)
显示图标
如果想要显示图标,你可以调用 show_icons=true
参数,像这样:
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
主题
你可以通过现有的主题进行卡片个性化,省去手动自定义的麻烦。
通过调用 ?theme=THEME_NAME
参数,像这样:
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)
主题样式
有dark, radical, merko, gruvbox, tokyonight, onedark, cobalt等几个主题,一般用dark
、algolia
,默认主题也行。详细见项目地址!
自定义卡片样式
你可以通过使用 URL 参数的方式,为你的 Stats Card
或 Repo Card
自定义样式。
常用选项:
title_color
- 卡片标题颜色 (十六进制色码)text_color
- 内容文本颜色 (十六进制色码)icon_color
- 图标颜色(如果可用)(十六进制色码)bg_color
- 卡片背景颜色 (十六进制色码) 或者 以 angle,start,end 的形式渐变hide_border
- 隐藏卡的边框 (布尔值)theme
- 主题名称,从所有可用主题中选择cache_seconds
- 手动设置缓存头 (最小值: 1800,最大值: 86400)locale
- 在卡片中设置语言 (例如 cn, de, es, 等等)
bg_color 渐变
你可以在 bg_color 选项中提供多个逗号分隔的值来呈现渐变,渐变的格式是 :-
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
缓存的注意事项: 如果 fork 数和 star 数 少于 1k , Repo 卡片默认缓存是 4 小时 (14400 秒) ,否则是 2 小时(7200)。另请注意缓存被限制为最短 2 小时,最长 24 小时。
统计卡片专属选项:
hide
- 隐藏特定统计信息 (以逗号分隔)hide_title
- (boolean)hide_rank
- (boolean)show_icons
- (boolean)include_all_commits
- 统计总提交次数而不是仅统计今年的提交次数 (boolean)count_private
- 统计私人提交 (boolean)line_height
- 设置文本之间的行高 (number)
Repo 卡片专属选项:
show_owner
- 显示 Repo 的所有者名字 (boolean)
语言卡片专属选项:
hide
- 从卡片中隐藏指定语言 (Comma seperated values)hide_title
- (boolean)layout
- 在两个可用布局default
&compact
间切换card_width
- 手动设置卡片的宽度 (number)
GitHub 更多置顶
GitHub 更多置顶允许你在使用 GitHub readme profile 时,在个人资料中置顶多于6个repo 。你不再受限于置顶最多 6 个存储库了。复制粘贴这段代码到你的 README 文件中,并更改链接:
端点: api/pin?username=anuraghazra&repo=github-readme-stats
[![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats)
热门语言卡片
热门语言卡片显示了 GitHub 用户常用的编程语言。将此代码复制粘贴到您的 README.md
文件中,并修改链接。
端点: api/top-langs?username=anuraghazra
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
隐藏指定语言
可以使用 ?hide=language1,language2
参数来隐藏指定的语言。
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats)
紧凑的语言卡片布局
你可以使用 &layout=compact
参数来改变卡片的样式。
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
快速提示 (对齐 Repo 卡片)
你通常无法将图片靠边显示。可以使用以下方法:
<a href="https://github.com/anuraghazra/github-readme-stats">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
部署
因为 GitHub 的API 每个小时只允许5千次请求,源项目的 https://github-readme-stats.vercel.app/api
,各人项目的API可能会不一样,可以自己制作Vercel服务API。虽然项目的配置是使用markdown
语法,但markdown不拒绝html标签,标签的话大家都容易看懂,也比较整齐。所以我的README.md是直接使用标签配置,一点不比md麻烦。具体的README.md配置如下,注意修改?usename
等相应参数:
<p align="center">
<a href="https://github.com/coderxm"> <!--statics主页地址,可修改-->
<img src="https://github-readme-stats-eight-theta.vercel.app/api?username=coderxm&show_icons=true&theme=algolia&include_all_commits=true&count_private=true&hide=issues"/> <!--可修改-->
</a>
</p>
<p align="center">
<a href="https://github.com/coderxm"> <!--热门语言,可修改-->
<img src="https://github-readme-stats-eight-theta.vercel.app/api/top-langs/?username=coderxm&layout=compact&langs_count=5&theme=algolia"/> <!--可修改-->
</a>
<a href="https://https://github.com/coderxm/CNblogs-Theme-NewSakura"> <!--pinned推荐项目,可修改-->
<img src="https://github-readme-stats.anuraghazra1.vercel.app/api/pin/?username=coderxm&repo=CNblogs-Theme-NewSakura&theme=algolia"/>
</a> <!--可修改-->
</p>
项目地址:https://github.com/anuraghazra/github-readme-stats