denvercoder1/github-readme-streak-stats

🔥 Stay motivated and show off your contribution streak! 🌟 Display your total contributions, current streak, and longest streak on your GitHub profile README

Github Readme Streak Stats

Display your total contributions, current streak,
and longest streak on your GitHub profile README

⚡ Quick setup

1. Copy-paste the markdown below into your GitHub profile README
2. Replace the value after ?user= with your GitHub username

[![GitHub Streak](https://streak-stats.demolab.com/?user=DenverCoder1)](https://git.io/streak-stats)

3. 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.

⚙ 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
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:

[![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 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.

en - English	am - አማርኛ	ar - العربية	ca - català	ceb - Binisaya
da - dansk	de - Deutsch	el - Ελληνικά	es - español	fil - Filipino
fr - français	he - עברית	hi - हिन्दी	hu - magyar	id - Indonesia
it - italiano	ja - 日本語	jv - Jawa	kn - ಕನ್ನಡ	ko - 한국어
mr - मराठी	ms - Melayu	my - မြန်မာ	ne - नेपाली	nl - Nederlands
no - norsk	ps - پښتو	pt_BR - português (Brasil)	ru - русский	sa - संस्कृत भाषा
sd_PK - سنڌي (پاڪستان)	sr - српски	su - Basa Sunda	th - ไทย	tr - Türkçe
uk - українська	ur_PK - اردو (پاکستان)	vi - Tiếng Việt	yo - Èdè Yorùbá	zh_Hans - 中文（简体）
zh_Hant - 中文（繁體）	bg - български	bn - বাংলা	fa - فارسی	ht - Haitian Creole
hy - հայերեն	pl - polski	rw - Kinyarwanda	sv - svenska	sw - Kiswahili
ta - தமிழ்

If you would like to help translate the Streak Stats cards, please see Issue #236 for more information.

📅 Date Formats

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" "2024-04-14" => "14 April"
j/n/Y	"2020-04-14" => "14/4/2020" "2024-04-14" => "14/4/2024"
[Y.]n.j	"2020-04-14" => "2020.4.14" "2024-04-14" => "4.14"
M j[, Y]	"2020-04-14" => "Apr 14, 2020" "2024-04-14" => "Apr 14"

Example

[![GitHub Streak](https://streak-stats.demolab.com/?user=denvercoder1&currStreakNum=2FD3EB&fire=pink&sideLabels=F00&date_format=[Y.]n.j)](https://git.io/streak-stats)

ℹ️ How these stats are calculated

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.

Note You may need to wait up to 24 hours for new contributions to show up (Learn how contributions are counted)

📤 Deploying it on your own

It is preferable to host the files on your own server and it takes less than 2 minutes to set up.

Doing this can lead to better uptime and more control over customization (you can modify the code for your usage).

You can deploy the PHP files on any website server with PHP installed including Heroku and Vercel.

The Inkscape dependency is required for PNG rendering, as well as Segoe UI font for the intended rendering. If using Heroku, the buildpacks will install these for you automatically.

Vercel is the recommended option for hosting the files since it is free and easy to set up. Watch the video below or expand the instructions to learn how to deploy to Vercel.

Note PNG mode is not supported since Inkscape will not be installed but the default SVG mode will work.

📺 Click here for a video tutorial on how to self-host on Vercel

Instructions for deploying to Vercel

Step-by-step instructions for deploying to Vercel

Option 1: Deploy to Vercel quickly with the Deploy button (recommended)

1. Click the Deploy button below

2. Create your repository by filling in a Repository Name and clicking "Create"
3. Visit this link to create a new Personal Access Token (no scopes required)
4. Scroll to the bottom and click "Generate token"
5. Add the token as a Config Var with the key TOKEN:

6. Click "Deploy" at the end of the form
7. Once the app is deployed, click the screenshot of your app or continue to the dashboard to find your domain to use in place of streak-stats.demolab.com

Option 2: Deploy to Vercel manually

1. Sign in to Vercel or create a new account at https://vercel.com
2. Use the following command to clone the repository: git clone https://github.com/DenverCoder1/github-readme-streak-stats.git. If you plan to make changes, you can also fork the repository and clone your fork instead. If you do not have Git installed, you can download it from https://git-scm.com/downloads.
3. Navigate to the cloned repository's directory using the command cd github-readme-streak-stats
4. Switch to the "vercel" branch using the command git checkout vercel
5. Make sure you have the Vercel CLI (Command Line Interface) installed on your system. If not, you can download it from https://vercel.com/download.
6. Run the command vercel and follow the prompts to link your Vercel account and choose a project name
7. After successful deployment, your app will be available at <project-name>.vercel.app
8. Open this link to create a new Personal Access Token on GitHub. You don't need to select any scopes for the token.
9. Scroll to the bottom of the page and click on "Generate token"
10. Visit the Vercel dashboard at https://vercel.com/dashboard and select your project. Then, click on "Settings" and choose "Environment Variables".
11. Add a new environment variable with the key TOKEN and the value as the token you generated in step 9, then save your changes
12. To apply the new environment variable, you need to redeploy the app. Run vercel --prod to deploy the app to production.

Note To set up automatic Vercel deployments from GitHub, make sure to turn off "Include source files outside of the Root Directory" in the General settings and use vercel as the production branch in the Git settings.

Heroku is another great option for hosting the files. All features are supported on Heroku and it is where the default domain is hosted. Heroku is not free, however, and you will need to pay between $5 and $7 per month to keep the app running. Expand the instructions below to learn how to deploy to Heroku.

Instructions for deploying to Heroku

Step-by-step instructions for deploying to Heroku

1. Sign in to Heroku or create a new account at https://heroku.com
2. Visit this link to create a new Personal Access Token (no scopes required)
3. Scroll to the bottom and click "Generate token"
4. Click the Deploy button below

5. Add the token as a Config Var with the key TOKEN:

6. Click "Deploy App" at the end of the form
7. Once the app is deployed, you can use <your-app-name>.herokuapp.com in place of streak-stats.demolab.com

You can transfer the files to any webserver using FTP or other means, then refer to CONTRIBUTING.md for installation steps.

🤗 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

Refer to CONTRIBUTING.md for more details on contributing, installing requirements, and running the application.

🙋‍♂️ Support

💙 If you like this project, give it a ⭐ and share it with friends!

☕ Buy me a coffee

---

Made with ❤️ and PHP

github-readme-streak-stats's Issues

Bug total contribution

this mine
https://github-readme-streak-stats.herokuapp.com/?user=adityadees

my profile
https://github.com/adityadees

2 Total Contributions
Dec 31, 1969 - Present

0 Current Streak

1 Longest Streak
Dec 31, 1969

Didn't update the stats automatically

I am getting weird behavior after I deployed in my own Heroku. The stats are not getting updated automatically. When I update my README.md file then the stats got updates

New theme "ayu-light"

Describe your theme in detail
Ayu is a simple sublime theme with bright colors and comes in three versions — dark, mirage and light for all day long comfortable work. Refer to: ayu

Include a screenshot / image

Color palette

"background" => "#FAFAFAFF",
"border" => "#F0F0F0FF",
"stroke" => "#BAE67EFF",
"ring" => "#FF9940FF",
"currStreakNum" => "#F07171FF",
"fire" => "#FF9940FF",
"sideNums" => "#55B4D4FF",
"currStreakLabel" => "#F07171FF",
"sideLabels" => "#55B4D4FF",
"dates" => "#575F66FF",

Are you going to add the theme?

• Check for yes

Holi Theme

Describe your theme in detail
Holi theme is a clean visual studio code dark theme inspired by the festival of colors, Holi.

Include a screenshot / image

Color palette

"background" => "#030314FF",
"border" => "#85A4C0FF",
"stroke" => "#2A4555FF",
"ring" => "#D6E7FFFF",
"currStreakNum" => "#5FABEEFF",
"fire" => "#D6E7FFFF",
"sideNums" => "#5FABEEFF",
"currStreakLabel" => "#D6E7FFFF",
"sideLabels" => "#D6E7FFFF",
"dates" => "#85A4C0FF",

Are you going to add the theme?

• Check for yes

Looking forward!

🎨 Add more themes

If you have a creative theme you've designed that you think others may like to use, feel free to add it to the code!

Requesting a theme

1. Open an issue describing your new theme in detail and optionally show an image.
2. Say in the issue if you would like someone else to add the theme.

Designing a theme

1. Pick colors using the "advanced options" on the Demo Site.
2. Once you have chosen colors for all of the color properties, you will be able to add a theme.

Adding a theme

1. Open an issue about your theme and optionally show an image
2. Say in the issue that you will be adding it yourself
3. Fork the repository and clone your fork to your computer
4. Create a new branch (you can name it with the name of your theme)
5. Edit themes.php to have your new theme colors by adding an array entry to the end. You can copy an existing entry for the correct formatting
6. Test your theme by running composer start and going to http://localhost:8000/?user=<USERNAME>&theme=<THEME> (you will need PHP installed to do this)
7. Add an entry to docs/themes.md with a static PNG image of your theme. (You can copy the image from the demo site when running locally - http://localhost:8000/demo/?theme=<THEME>)
8. Commit and push your changes to your fork
9. Open a pull request for merging your branch into this repo's main branch
10. Link the issue you created by typing Closes #0 where #0 is the number of the issue you created. You can also do this through the "Linked issues" on the right-side panel after opening the Pull Request

Make sure to keep the spacing and formatting consistent.

Your theme will become available when your Pull Request is approved.

If you have any questions, feel free to ask!

Add animations to the SVGs

Currently, the graphics appear suddenly as they are loaded. There is no fade-in animation or motion.

It may be cool to have some sort of CSS animation as the image loads on the page (similar to how it is done with GitHub Readme Stats. See this example.)

Streak not counting correctly

Describe the bug
Streak not counting correctly

Screenshots

Desktop (please complete the following information):

• OS: macOS
• Browser: Chrome
• Version: 91.0.4472.114

Additional context
Sometimes I commit to a repo locally, but push to few days after. I wonder if that's gonna affect the stats counting.

Add an issue template for theme suggestions

Currently there are only templates for Bug Report, Feature Request, and Questions.

If someone has a suggestion for a new theme, they can create an issue including the colors and a preview of what it should look like.

The user who submitted the request or another user can then add the theme to the list with a pull request.

More details: #32 (comment)

Add unit tests to test features during development

Using PHPUnit to set up unit tests.

I will set it up initially, but input is welcome for improving or adding test cases.

Ring is not centered in Firefox browser

Firefox

What it should look like (Chrome)

Output errors as JSON when type is set to `json`

Currently there is an option to set the output type to JSON to get stats in JSON format.

Example: https://github-readme-streak-stats.herokuapp.com/?user=DenverCoder1&type=json

If there is an error (eg. invalid username, etc.), currently the error card in SVG gets displayed.

It may be best if instead of returning the SVG it echos the response in JSON format, for example:

{
    "error": "User could not be found."
}

Note: It may be advisable to wait for #140 to be merged before starting in order to avoid merge conflicts.

Add favicon

Is your feature request related to a problem? Please describe.

No

Describe the solution you'd like

Add a favicon to the demo site

Change color picker in demo site to support opacity

Currently the color picker is the default HTML color picker which, as of now, does not support setting the opacity (alpha channel).

Since transparent cards and semi-transparent cards are possibilities people may want to use, the demo site should support picking colors with transparency.

Streak Reset for no reason

Describe the bug
I'm contributing and coding everyday, but today it reset all of a sudden for no reason.

Expected behavior
It was supposed to continue

Screenshots
My contribution graph:

My stats card:

Desktop (please complete the following information):

• OS: Linux (Ubuntu)
• Browser: Firefox
• Version: latest

Additional context
Add any other context about the problem here.

Add details for deploying to Heroku

There are currently no clear instructions for deploying to Heroku besides the button being there.

Details including deployment and adding config vars to settings should be explained.

Hide border Option

Having a hide_border option for cards would be pretty nice. Now with dark mode, card borders are pretty intrusive- and overall ugly. Below is an example alongside Github Readme Stats, which does have this option, just for a comparison.
Thanks! 👍

Make homepage redirect to demo site

When a user visits the "homepage" of Streak Stats (https://github-readme-streak-stats.herokuapp.com/), they simply see a card saying the user cannot be found:

It would probably be more helpful to redirect them to a page with more information such as the Demo Site which explains the purpose of the tool and has links to the GitHub repo.

Dominant baseline does not render correctly everywhere

Describe the bug

The text will occasionally appear higher than it is supposed to in some renderers due to dominant-baseline=middle not going into effect.

Most browsers are fine, but in case the svg needs to be rendered by another program or in a less capable image viewer, this issue can be resolved.

dominant-baseline=middle can be replaced with dy='0.25em'

Screenshots

Input validation on the Demo Site

The new Demo Site allows for previewing cards more easily.

The Demo Site should be able to validate that the username field is filled out when the user clicks submit or tries to copy to clipboard.

If the user has not filled in a username, a warning should appear next to the input box telling them that it is required.

📝 Fix broken links in README.md

The link to run the project locally & the link to run the demo site locally are not correct. Both are missing the src directory.

How to Fix :

- http://localhost:8000/?user=DenverCoder1
+ http://localhost:8000/src/?user=DenverCoder1

- http://localhost:8000/demo/
+ http://localhost:8000/src/demo/

Screenshot :

Remove table of contents

It is built in to Github

Add Cookie Banner to the Demo Website

Due the dark mode is set via Cookie parameter I think it would be recommended to add a cookie banner to the website

My Streak Got Stuck At 100 Days

Describe the bug
My Streak Got Stuck At 100 Days (Till 31st July)

To Reproduce
Visit my Github profile.
Expected behaviour
Should Show Actual Numbers

Support for multiple date formats

Currently, all dates are displayed with month, day, and when applicable, year. For example, "Feb 16" or "Dec 31, 2020".

It may be possible to allow the user to optionally choose their preferred date format through a URL parameter. For example, if the user prefers the day before the month, they can display dates that way.

New changes to GitHub's contribution graphs giving inconsistent results

Describe the bug
Occasionally the data retrieved from the contribution graphs will be missing contributions although other times it is not. Having the contribution end date always be 31st of December seems to fix this issue and the data is no longer missing.

Expected behavior
No missing data, for example, 2 contributions on 9th of January.

What actually happens
9th of January occasionally shows 0 contributions.

Screenshots

Advanced customizations on the demo site

The new Demo Site allows for previewing cards more easily.

The main settings already have input boxes, but there is currently no way to choose colors for specific parts using the advanced Theme Customizations.

The demo site may have a toggle to display advanced options where you can select colors in boxes to apply to specific parameters.

Add Neon-Dark & Neon-Palenight Themes

Add two new themes for the github-readme-streak-stats

Hi, I designed two new version of theme for the github-readme-streak-stats. One is neon-dark and another one is neon-palenight.

---

Neon Dark ( neon-dark )

Theme Colors :

"neon-dark" => [
    "background" => "#020200"
    "border" => "#a8a8a8"
    "stroke" => "#a8a8a8"
    "ring" => "#e41d44"
    "fire" => "#e41d44"
    "currStreakNum" => "#f9dd3c"
    "currStreakLabel" => "#f9dd3c"
    "sideNums" => "#5cadc0"
    "sideLabels" => "#5cadc0"
    "dates" => "#ed7b25"
]

---

Neon Palenight ( neon-palenight )

Theme Colors :

"neon-palenight" => [
    "background" => "#212237"
    "border" => "#a8a8a8"
    "stroke" => "#a8a8a8"
    "ring" => "#e41d44"
    "fire" => "#e41d44"
    "currStreakNum" => "#f9dd3c"
    "currStreakLabel" => "#f9dd3c"
    "sideNums" => "#5cadc0"
    "sideLabels" => "#5cadc0"
    "dates" => "#ed7b25"
]

I hope you liked these two themes. Thank You 🙏

Date crossed the longest streak section

Describe the bug
Date crossed the longest streak section

Expected behavior
Efficient padding for the long date.

Screenshots

Add ability to set the output type to PNG

It may be useful to be able to directly get a PNG versions of the streak stats cards.

One way this can be done is by converting the SVG output to a PNG.

If necessary, ImageMagick or a similar library may be used to do this.

You may need the animations to be stripped out of the SVG before conversion.

You may use this script (written in Python) for inspiration. Since this project is written in PHP it would be preferable for the solution to this issue to be written in PHP.

There is currently a type option allowing output as svg or json, this can be added as a 3rd option.

Multiple output types

Instead of only SVG output, possibly there could be an option to get the streak stats data in JSON or other formats for easier use in other projects.

Add monokai-metallian theme

Streak ends if commit locally and push next day

Describe the bug
I had committed some changes locally but didn't push them. Today when I pushed those changes it's showing me my Streak ended and it was reset to 0.

Earth Theme

Include a screenshot / image

Color palette

Background #1E1615
Border #BA9D6F
Stroke #BA9D6F
Ring #C48519
Fire #C48519
CurrStreakNum #639E29
SideNums #639E29
CurrStreakLabel #C48519
SideLabels #C48519
Dates #BA9D6F

Are you going to add the theme?

• Check for yes

Add a demo site for previewing cards

Add a demo site for previewing stats cards with different parameters and generating markdown.

The page should include a base url, an input box for filling a username, and dynamically created dropdowns to customize the base theme, specific colors, or other parameters.

A preview image should be displayed on request.

Markdown for the entered parameters should be generated and easy to copy.

Additional considerations:

• Possibly use fake data in the preview to avoid using up API rate limits?

Use SVG to display errors

Currently if something goes wrong when fetching the user or another error occurs, the response is in plain text and is only visible if you open the URL in a browser.

For users who are putting the image directly into their README, if there is an error, the image will not load and it will display no warnings.

To fix this, errors should be inside images to ensure that the user is aware of the error even if they are loading the broken link as an image.

Add new theme called `dark-smoky`

Add a new themes for the github-readme-streak-stats

Hi, I designed a new theme for the github-readme-streak-stats, Which is called as dark-smoky.

---

Dark Smoky ( dark-smoky )

Theme Colors :

"neon-dark" => [
    "background" => "#0b0c10"
    "border" => "#c5c6c7"
    "stroke" => "#c5c6c7"
    "ring" => "#edf5e1"
    "fire" => "#edf5e1"
    "currStreakNum" => "#66fcf1"
    "currStreakLabel" => "#66fcf1"
    "sideNums" => "#edf5e1"
    "sideLabels" => "#edf5e1"
    "dates" => "#45a29e"
]

I hope you liked the theme. Thank You 🙏

New theme Deep-Blue

Created a new theme deep Blue

Below is the snapshot of the theme

Color palette

    Background  #165795FF
    Border      #BA9D6F
    Stroke      #38DD69FF
    Ring        #37DD57FF
    Fire        #1CD577FF
    SideNums    #120E5BF2
    SideLabels  #1ADD40FF
    Dates      #11E2E7FF
    CurrStreakNum  #639E29
    CurrStreakLabel #0FDD21FF

Hope you like it.
Thank you,

current streak and total contribution count doesn't update automatically.

Describe the bug
A clear and concise description of what the bug is.

• the changes in my repo and contributions doesn't automatically reflect on the streak counter. however, opening the link in a separate tab manually shows the correct data.
  To Reproduce

Expected behavior
A clear and concise description of what you expected to happen.

• it is expected to get updated when some changes are made and committed to the repositories of the corresponding user.

Desktop (please complete the following information):

• OS: windows
• Browser: chrome
• Version: 10

Smartphone (please complete the following information):

• Device: moto g4 plus, asus zenfone max m2
• OS: android 7.0, android 9
• Browser: chrome

Add a Demo Site gif to the Readme to show its usage

Add a pull request template

The project does not currently have a pull request template.

Add Dark Mode to Demo Site

The new Demo Site allows for previewing cards more easily.

Some users use GitHub on Dark Mode which has a different appearance so users may want to see what their card will look like in dark mode.

The background behind the image should match the color of GitHub's dark mode on the readme page (#0D1117).

Custom themes

It would be nice if we could just customize our own themes like at github.com/anuraghazra/github-readme-stats.

Originated from #13

Fix color of dropdown arrows on demo site in dark mode

Describe the bug

On Dark Mode on the Demo Site, the arrows are difficult to see since they are black on a dark background.

To Reproduce

Steps to reproduce the behavior:

1. Go to https://github-readme-streak-stats.herokuapp.com/demo/
2. Click on the dark mode toggle
3. See the color of the dropdown arrows

Expected behavior

Black arrows on light mode and white arrows on dark mode

Screenshots

Desktop (please complete the following information):

• OS: Arch Linux
• Browser: Brave, Firefox
• Version: Brave 1.22.71 Chromium 89.0.4389.114

Additional context

The color of the arrow is set in the CSS, so the solution may involve changing this part:

Hide FF at end of colors on the demo site

This issue is to be done in JavaScript.

On the demo site in the advanced options, you can choose colors with a color-picker.

Since it supports transparency all colors are 8 hex digits (with the last 2 representing the transparency)

If there is full opacity, the last two characters will be FF and the FF is optional.

Feature suggestion

Make the input box automatically remove the FF from the input value whenever the color is changed and the color ends with FF.

Example

If you select the color like this:

It should get automatically changed to this when you click away:

Let me know if you get stuck or have any questions.

Improve documentation layouts

Tables may be useful for more cleanly displaying additional parameters.

An image may be useful for showing which parts of the stats card each color label refers to.

split theme color

Is your feature request related to a problem? Please describe.
N/A

Describe the solution you'd like
N/A

Describe alternatives you've considered
N/A

Additional context
Maybe if we can split this part we can get more cool color.

something like this

🐛 Toggle Theme Button on top of Heading on mobile view

Describe the bug
The toggle theme button on mobile view overlaps the heading element. Which is not good for the user experience.

To Reproduce
Steps to reproduce the behavior:

On Desktop / Laptop

1. Go to https://github-readme-streak-stats.herokuapp.com/demo
2. Right-click on the page and select inspect.
3. Then Click on the Toggle device toolbar on the top-left of DevTools.
4. Now change the viewport to mobile view.
5. See the bug - toggle theme button that overlaps the heading element.

On Smart-Phone

1. Go to https://github-readme-streak-stats.herokuapp.com/demo
2. See the bug - toggle theme button that overlaps the heading element.

Expected behavior
Option 1: Set default theme to Dark Theme. Then remove the toggle theme button on mobile view.
Option 2: Place the toggle theme button in such a place that doesn't affect other elements on the page.

Screenshots

Smartphone (please complete the following information):

• Device: Samsung Galaxy S10
• OS: Android 11.0 with One UI 3.0
• Browser: Chrome
• Version: 89.0.4389.105

Additional context
I checked in almost all smartphone simulators and phones. I found the same bug.

Add `date_format` to the demo site

This issue requires HTML. The code will go in index.php, but you do not need to know PHP for adding this.

Is your feature request related to a problem? Please describe.
The demo site does not currently have a field for customizing the date format

Describe the solution you'd like
Add a text input field for the user to enter one

Additional context
The default value is M j[, Y]

Please see Date Formats in the readme for more details about how it works.

Optional: include a tooltip or link where users can read more info on how to use the property.

Use GitHub API to fetch creation year

Fetching the year from the HTML of the user's profile page is a bit slow and unreliable.

The creation date of the user is returned as a property when making a request to https://api.github.com/users/{user}.

Using this should make the response faster and more reliable.

[Question] How does it count streak ?

Does it mean how many continuous days I log-in to my account or how many days I have contributed continuously to GitHub ?