访问官网
Github
文档
Github Readme Streak Stats
Display your total contributions, current streak,
and longest streak on your GitHub profile README
⚡ Quick setup
- Copy-paste the markdown below into your GitHub profile README
- Replace the value after
?user=with your GitHub username
[](https://git.io/streak-stats)
- Star the repo 😄
Next Steps
-
Check out the Demo Site or Options below for available customizations.
-
It is recommended to self-host the project more better reliability. See Deploying it on your own for more details.
![][hspace] [
][herokudeploy] [
][verceldeploy]
⚙ Demo Site
Here you can customize your Streak Stats card with a live preview.
https://streak-stats.demolab.com
🔧 Options
The user field is the only required option. All other fields are optional.
If the theme parameter is specified, any color customizations specified will be applied on top of the theme, overriding the theme's values.
| Parameter | Details | Example |
|---|---|---|
user | GitHub username to show stats for | DenverCoder1 |
theme | The theme to apply (Default: default) | dark, radical, etc. 🎨➜ |
hide_border | Make the border transparent (Default: false) | true or false |
border_radius | Set the roundness of the edges (Default: 4.5) | Number 0 (sharp corners) to 248 (ellipse) |
background | Background color (eg. f2f2f2, 35,d22,00f) | hex code without #, css color, or gradient in the form angle,start_color,...,end_color |
border | Border color | hex code without # or css color |
stroke | Stroke line color between sections | hex code without # or css color |
ring | Color of the ring around the current streak | hex code without # or css color |
fire | Color of the fire in the ring | hex code without # or css color |
currStreakNum | Current streak number | hex code without # or css color |
sideNums | Total and longest streak numbers | hex code without # or css color |
currStreakLabel | Current streak label | hex code without # or css color |
sideLabels | Total and longest streak labels | hex code without # or css color |
dates | Date range text color | hex code without # or css color |
excludeDaysLabel | Excluded days of the week text color | hex code without # or css color |
date_format | Date format pattern or empty for locale format | See note below on 📅 Date Formats |
locale | Locale for labels and numbers (Default: en) | ISO 639-1 code - See 🗪 Locales |
type | Output format (Default: svg) | Current options: svg, png or json |
mode | Streak mode (Default: daily) | daily (contribute daily) or weekly (contribute once per Sun-Sat week) |
exclude_days | List of days of the week to exclude from streaks | Comma-separated list of day abbreviations (Sun, Mon, Tue, Wed, Thu, Fri, Sat) e.g. Sun,Sat |
disable_animations | Disable SVG animations (Default: false) | true or false |
card_width | Width of the card in pixels (Default: 495) | Positive integer, minimum width is 100px per column |
card_height | Height of the card in pixels (Default: 195) | Positive integer, minimum height is 170px |
hide_total_contributions | Hide the total contributions (Default: false) | true or false |
hide_current_streak | Hide the current streak (Default: false) | true or false |
hide_longest_streak | Hide the longest streak (Default: false) | true or false |
starting_year | Starting year of contributions | Integer, must be 2005 or later, eg. 2017. By default, your account creation year is used. |
🖌 Themes
To enable a theme, append &theme= followed by the theme name to the end of the source URL:
[](https://git.io/streak-stats)
| Theme | Preview |
|---|---|
default |  |
dark |  |
highcontrast |  |
| More themes! | 🎨 See a list of all available themes |
If you have come up with a new theme you'd like to share with others, please see Issue #32 for more information on how to contribute.
🗪 Locales
The following are the locales that have labels translated in Streak Stats. The locale query parameter accepts any ISO language or locale code, see here for a list of valid locales. The locale provided will be used for the date format and number format even if translations are not yet available.
