Skip to content

github-readme-stats

https://github.com/anuraghazra/github-readme-stats/blob/master/readme.md

通用选项

选项描述默认值示例
usernameGitHub 用户名-username=VfanLee
theme主题(支持多种颜色样式)defaulttheme=radical
hide_border隐藏边框falsehide_border=true
border_radius卡片圆角大小(px)4.5border_radius=10
locale显示语言enlocale=zh
cache_seconds缓存时间(秒)14400(4 小时)cache_seconds=86400(1 天)

仓库统计卡片

用于展示 GitHub 用户的仓库信息。

参数描述默认值示例
show_icons显示图标(如星星、fork 等)falseshow_icons=true
count_private统计私有仓库的贡献falsecount_private=true
include_all_commits包括所有提交记录falseinclude_all_commits=true
hide隐藏特定统计项(如 issues、stars)hide=issues,prs
custom_title自定义标题GitHub Statscustom_title=My GitHub Data
show_owner显示仓库拥有者falseshow_owner=true
hide_title隐藏标题hide_title=true

语言卡片

展示用户最常用的编程语言。

参数描述默认值示例
layout布局方式(defaultcompactdefaultlayout=compact
hide隐藏特定语言hide=html,css
langs_count显示的语言数量5langs_count=10
exclude_repo排除的仓库exclude_repo=repo1,repo2
card_width卡片宽度(px)自动card_width=300
hide_title隐藏标题hide_title=true

自定义颜色

支持自定义卡片颜色,可以通过 URL 参数指定。

参数描述示例
title_color标题颜色title_color=ff0000
text_color文本颜色text_color=ffffff
icon_color图标颜色icon_color=00ff00
bg_color背景渐变色(格式:start,end)bg_color=30,e96443,904e95

统计卡片专属选项: 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 - 提供五种布局 normal & compact & donut & donut-vertical & pie 间切换 card_width - 手动设置卡片的宽度 (number)

基于 MIT 许可发布