Display your total contributions, current streak,
and longest streak on your GitHub profile README
- Copy-paste the markdown below into your GitHub profile README
- Replace the value after
?user=
with your GitHub username
[![GitHub Streak](https://najmajmal-streak.vercel.app/?user=NajmAjmal)](https://github.com/NajmAjmal/github-readme-streak-stats)
- Star the repo π
Here you can customize your Streak Stats card with a live preview.
https://najmajmal-streak.vercel.app/demo/
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 |
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. |
To enable a theme, append &theme=
followed by the theme name to the end of the source URL:
[![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1&theme=dark)](https://git.io/streak-stats)
Theme | Preview |
---|---|
default |
|
dark |
|
highcontrast |
|
More themes! | π¨ See a list of all available themes |
If date_format
is not provided or is empty, the PHP Intl library is used to determine the date format based on the locale specified in the locale
query parameter.
A custom date format can be specified by passing a string to the date_format
parameter.
The required format is to use format string characters from PHP's date function with brackets around the part representing the year.
When the contribution year is equal to the current year, the characters in brackets will be omitted.
Examples:
Date Format | Result |
---|---|
d F[, Y] |
"2020-04-14" => "14 April, 2020" |
j/n/Y |
"2020-04-14" => "14/4/2020" |
[Y.]n.j |
"2020-04-14" => "2020.4.14" |
M j[, Y] |
"2020-04-14" => "Apr 14, 2020" |
[![GitHub Streak](https://najmajmal-streak.vercel.app/?user=NajmAjmal&currStreakNum=2FD3EB&fire=pink&sideLabels=F00&date_format=[Y.]n.j)]
This tool uses the contribution graphs on your GitHub profile to calculate which days you have contributed.
To include contributions in private repositories, turn on the setting for "Private contributions" from the dropdown menu above the contribution graph on your profile page.
Contributions include commits, pull requests, and issues that you create in standalone repositories.
The longest streak is the highest number of consecutive days on which you have made at least one contribution.
The current streak is the number of consecutive days ending with the current day on which you have made at least one contribution. If you have made a contribution today, it will be counted towards the current streak, however, if you have not made a contribution today, the streak will only count days before today so that your streak will not be zero.
Made by Najm Ajmal & DenverCoder1