Get dynamically generated GitHub stats on your READMEs!
View Demo · Report Bug · Request Feature · FAQ · Ask Question
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어 · Nederlands · नेपाली · Türkçe
Please note that documentation translations may be outdated, try to use english documentation if possible.
Love the project? Please consider donating to help it improve!
- GitHub Stats Card
- GitHub Extra Pins
- GitHub Gist Pins
- Top Languages Card
- WakaTime Stats Card
- All Demos
- Deploy on your own
- 💖 Support the project
Important
Since the GitHub API only allows 5k requests per hour per user account, the public Vercel instance hosted on https://beautiful-github-homepage.vercel.app/api could possibly hit the rate limiter . We use caching to prevent this from happening (see https://github.com/ishandutta2007/beautiful-github-homepage#common-options). You can turn off these rate limit protections by deploying your own Vercel instance.
Important
We're a small team, and to prioritize, we rely on upvotes 👍. We use Top issues dashboard for tracking community demand . Do not hesitate to upvote the issues and pull requests you are interested in. We will work on the most upvoted first.
Copy-paste this into your markdown content, and that is it. Simple!
Change the ?username= value to your GitHub username.
[](https://github.com/ishandutta2007/beautiful-github-homepage)Warning
By default, the stats card only shows statistics like stars, commits and pull requests from public repositories. To show private statistics on the stats card, you should deploy your own instance using your own GitHub API token.
Note
Available ranks are S (top 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). This ranking scheme is based on the Japanese academic grading system. The global percentile is calculated as a weighted sum of percentiles for each statistic (number of commits, pull requests, reviews, issues, stars and followers), based on the cumulative distribution function of the exponential and the log-normal distributions. The implementation can be investigated at src/calculateRank.js. The circle around the rank shows 100 minus the global percentile.
You can pass a query parameter &hide= to hide any specific stats with comma-separated values.
Options:
&hide=stars,commits,prs,issues,contribs
You can pass a query parameter &show= to show any specific additional stats with comma-separated values.
Options:
&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage
[](https://github.com/ishandutta2007/beautiful-github-homepage)To enable icons, you can pass &show_icons=true in the query param, like so:
[](https://github.com/ishandutta2007/beautiful-github-homepage)With inbuilt themes, you can customize the look of the card without doing any manual customization.
Use &theme=THEME_NAME parameter like so :
[](https://github.com/ishandutta2007/beautiful-github-homepage)Beautiful Github Homepage comes with several built-in themes (e.g. dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula).
You can look at a preview for all available themes or checkout the theme config file. Please note that we paused addition of new themes to decrease maintenance efforts, all pull requests related to new themes will be closed.
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)Since GitHub will re-upload the cards and serve them from their CDN, we can not infer the browser/GitHub theme on the server side. There are, however, four methods you can use to create dynamics themes on the client side.
We have included a transparent theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the &theme=transparent parameter like so:
[](https://github.com/ishandutta2007/beautiful-github-homepage)👀 Show example
You can use the bg_color parameter to make any of the available themes transparent. This is done by setting the bg_color to a color with a transparent alpha channel (i.e. bg_color=00000000):
👀 Show example
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use GitHub's theme context tags to switch the theme based on the user GitHub theme automatically. This is done by appending #gh-dark-mode-only or #gh-light-mode-only to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme:
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)👀 Show example
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use GitHub's new media feature in HTML to specify whether to display images for light or dark themes. This is done using the HTML <picture> element in combination with the prefers-color-scheme media feature.
<picture>
<source
srcset="https://beautiful-github-homepage.vercel.app/api?username=ishandutta2007&show_icons=true&theme=dark"
media="(prefers-color-scheme: dark)"
/>
<source
srcset="https://beautiful-github-homepage.vercel.app/api?username=ishandutta2007&show_icons=true"
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
/>
<img src="https://beautiful-github-homepage.vercel.app/api?username=ishandutta2007&show_icons=true" />
</picture>👀 Show example
You can customize the appearance of all your cards however you wish with URL parameters.
title_color- Card's title color (hex color). Default:2f80ed.text_color- Body text color (hex color). Default:434d58.icon_color- Icons color if available (hex color). Default:4c71f2.border_color- Card's border color (hex color). Default:e4e2e2(Does not apply whenhide_borderis enabled).bg_color- Card's background color (hex color) or a gradient in the form of angle,start,end. Default:fffefehide_border- Hides the card's border (boolean). Default:falsetheme- Name of the theme, choose from all available themes. Default:defaulttheme.cache_seconds- Sets the cache header manually (min: 21600, max: 86400). Default:21600 seconds (6 hours).locale- Sets the language in the card, you can check full list of available locales here. Default:en.border_radius- Corner rounding on the card. Default:4.5.
Warning
We use caching to decrease the load on our servers . Our cards have a default cache of 6 hours (21600 seconds). Also, note that the cache is clamped to a minimum of 6 hours and a maximum of 24 hours. If you want the data on your statistics card to be updated more often you can deploy your own instance and set environment variable CACHE_SECONDS to a value of your choosing.
You can provide multiple comma-separated values in the bg_color option to render a gradient with the following format:
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Here is a list of all available locales:
|
|
|
If we don't support your language, please consider contributing! You can find more information about how to do it in our contributing guidelines.
hide- Hides the specified items from stats (Comma-separated values). Default:[] (blank array).hide_title- (boolean). Default:false.card_width- Sets the card's width manually (number). Default:500px (approx.).hide_rank- (boolean) hides the rank and automatically resizes the card width. Default:false.rank_icon- Shows alternative rank icon (i.e.github,percentileordefault). Default:default.show_icons- (boolean). Default:false.include_all_commits- Counts total commits instead of just the current year commits (boolean). Default:false.line_height- Sets the line height between text (number). Default:25.exclude_repo- Excludes stars from specified repositories (Comma-separated values). Default:[] (blank array).custom_title- Sets a custom title for the card. Default:<username> GitHub Stats.text_bold- Uses bold text (boolean). Default:true.disable_animations- Disables all animations in the card (boolean). Default:false.ring_color- Color of the rank circle (hex color). Defaults to the theme ring color if it exists and otherwise the title color.number_format- Switches between two available formats for displaying the card valuesshort(i.e.6.6k) andlong(i.e.6626). Default:short.show- Shows additional items on stats card (i.e.reviews,discussions_started,discussions_answered,prs_mergedorprs_merged_percentage) (Comma-separated values). Default:[] (blank array).
Note
When hide_rank=true, the minimum card width is 270 px + the title length and padding.
show_owner- Shows the repo's owner name (boolean). Default:false.
show_owner- Shows the gist's owner name (boolean). Default:false.
hide- Hides the languages specified from the card (Comma-separated values). Default:[] (blank array).hide_title- (boolean). Default:false.layout- Switches between five available layoutsnormal&compact&donut&donut-vertical&pie. Default:normal.card_width- Sets the card's width manually (number). Default300.langs_count- Shows more languages on the card, between 1-20 (number). Default:5fornormalanddonut,6for other layouts.exclude_repo- Excludes specified repositories (Comma-separated values). Default:[] (blank array).custom_title- Sets a custom title for the card (string). DefaultMost Used Languages.disable_animations- Disables all animations in the card (boolean). Default:false.hide_progress- Uses the compact layout option, hides percentages, and removes the bars. Default:false.size_weight- Configures language stats algorithm (number) (see Language stats algorithm), defaults to 1.count_weight- Configures language stats algorithm (number) (see Language stats algorithm), defaults to 0.
Warning
Language names should be URI-escaped, as specified in Percent Encoding
(i.e: c++ should become c%2B%2B, jupyter notebook should become jupyter%20notebook, etc.) You can use
urlencoder.org to help you do this automatically.
hide- Hides the languages specified from the card (Comma-separated values). Default:[] (blank array).hide_title- (boolean). Defaultfalse.line_height- Sets the line height between text (number). Default25.hide_progress- Hides the progress bar and percentage (boolean). Defaultfalse.custom_title- Sets a custom title for the card (string). DefaultWakaTime Stats.layout- Switches between two available layoutsdefault&compact. Defaultdefault.langs_count- Limits the number of languages on the card, defaults to all reported languages (number).api_domain- Sets a custom API domain for the card, e.g. to use services like Hakatime or Wakapi (string). DefaultWaka API.
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
Yay! You are no longer limited to 6 pinned repositories.
Copy-paste this code into your readme and change the links.
Endpoint: api/pin?username=ishandutta2007&repo=beautiful-github-homepage
[](https://github.com/ishandutta2007/beautiful-github-homepage)Use show_owner query option to include the repo's owner username
[](https://github.com/ishandutta2007/beautiful-github-homepage)GitHub gist pins allow you to pin gists in your GitHub profile using a GitHub readme profile.
Copy-paste this code into your readme and change the links.
Endpoint: api/gist?id=bbfce31e0217a3689c8d961a356cb10d
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)Use show_owner query option to include the gist's owner username
[](https://github.com/ishandutta2007/beautiful-github-homepage)The top languages card shows a GitHub user's most frequently used languages.
Warning
By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should deploy your own instance using your own GitHub API token.
Note
Top Languages does not indicate the user's skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of beautiful-github-homepage.
Warning
This card shows languages usage only inside your own non-forked repositories, not depending from who is the author of the commits. It does not include your contributions into another users/organizations repositories. Currently there are no way to get this data from GitHub API. If you want this behavior to be improved you can support this feature request created by @rickstaa inside GitHub Community.
Warning
Currently this card shows data only about first 100 repositories. This is because GitHub API limitations which cause downtimes of public instance . In future this behavior will be improved by releasing GitHub action or providing environment variable for user's own instances.
Copy-paste this code into your readme and change the links.
Endpoint: api/top-langs?username=ishandutta2007
[](https://github.com/ishandutta2007/beautiful-github-homepage)We use the following algorithm to calculate the languages percentages on the language card:
ranking_index = (byte_count ^ size_weight) * (repo_count ^ count_weight)By default, only the byte count is used for determining the languages percentages shown on the language card (i.e. size_weight=1 and count_weight=0). You can, however, use the &size_weight= and &count_weight= options to weight the language usage calculation. The values must be positive real numbers. More details about the algorithm can be found here.
&size_weight=1&count_weight=0- (default) Orders by byte count.&size_weight=0.5&count_weight=0.5- (recommended) Uses both byte and repo count for ranking&size_weight=0&count_weight=1- Orders by repo count
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use the &exclude_repo=repo1,repo2 parameter to exclude individual repositories.
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use &hide=language1,language2 parameter to hide individual languages.
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use the &langs_count= option to increase or decrease the number of languages shown on the card. Valid values are integers between 1 and 20 (inclusive). By default it was set to 5 for normal & donut and 6 for other layouts.
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use the &layout=compact option to change the card design.
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use the &layout=donut option to change the card design.
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use the &layout=donut-vertical option to change the card design.
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use the &layout=pie option to change the card design.
[](https://github.com/ishandutta2007/beautiful-github-homepage)You can use the &hide_progress=true option to hide the percentages and the progress bars (layout will be automatically set to compact).
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)- Compact layout
[](https://github.com/ishandutta2007/beautiful-github-homepage)- Donut Chart layout
[](https://github.com/ishandutta2007/beautiful-github-homepage)]- Donut Vertical Chart layout
[](https://github.com/ishandutta2007/beautiful-github-homepage)- Pie Chart layout
[](https://github.com/ishandutta2007/beautiful-github-homepage)- Hidden progress bars
[](https://github.com/ishandutta2007/beautiful-github-homepage)Warning
Please be aware that we currently only show data from WakaTime profiles that are public. You therefore have to make sure that BOTH Display code time publicly and Display languages, editors, os, categories publicly are enabled.
Change the ?username= value to your WakaTime username.
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
Choose from any of the default themes
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)
[](https://github.com/ishandutta2007/beautiful-github-homepage)[](https://github.com/ishandutta2007/beautiful-github-homepage)By default, GitHub does not lay out the cards side by side. To do that, you can use this approach:
<a href="https://github.com/ishandutta2007/beautiful-github-homepage">
<img height=200 align="center" src="https://beautiful-github-homepage.vercel.app/api?username=ishandutta2007" />
</a>
<a href="https://github.com/ishandutta2007/beautiful-github-homepage">
<img height=200 align="center" src="https://beautiful-github-homepage.vercel.app/api/top-langs?username=ishandutta2007&layout=compact&langs_count=8&card_width=320" />
</a><a href="https://github.com/ishandutta2007/beautiful-github-homepage">
<img align="center" src="https://beautiful-github-homepage.vercel.app/api/pin/?username=ishandutta2007&repo=beautiful-github-homepage" />
</a>
<a href="https://github.com/ishandutta2007/beautiful-github-homepage">
<img align="center" src="https://beautiful-github-homepage.vercel.app/api/pin/?username=ishandutta2007&repo=convoychat" />
</a>👀 Show example
Since the GitHub API only allows 5k requests per hour, my https://beautiful-github-homepage.vercel.app/api could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not have to worry about anything. Click on the deploy button to get started!
Note
Since #58, we should be able to handle more than 5k requests and have fewer issues with downtime 😁.
Note
If you are on the Pro (i.e. paid) Vercel plan, the maxDuration value found in the vercel.json can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than 30 seconds to prevent high memory usage.
🛠️ Step-by-step guide on setting up your own Vercel instance
- Go to vercel.com.
- Click on
Log in. - Sign in with GitHub by pressing
Continue with GitHub. - Sign in to GitHub and allow access to all repositories if prompted.
- Fork this repo.
- Go back to your Vercel dashboard.
- To import a project, click the
Add New...button and select theProjectoption. - Click the
Continue with GitHubbutton, search for the required Git Repository and import it by clicking theImportbutton. Alternatively, you can import a Third-Party Git Repository using theImport Third-Party Git Repository ->link at the bottom of the page. - Create a personal access token (PAT) here and enable the
repoanduserpermissions (this allows access to see private repo and user stats). - Add the PAT as an environment variable named
PAT_1(as shown). - Click deploy, and you're good to go. See your domains to use the API!
Warning
This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. #2341). The support for this method, therefore, is limited.
🛠️ Step-by-step guide for deploying on other platforms
- Fork or clone this repo as per your needs
- Add
expressto the dependencies section ofpackage.jsonhttps://github.com/ishandutta2007/beautiful-github-homepage/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L54-L61 - Run
npm iif needed (initial setup) - Run
node express.jsto start the server, or set the entry point toexpress.jsinpackage.jsonif you're deploying on a managed service https://github.com/ishandutta2007/beautiful-github-homepage/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L11 - You're done 🎉
Beautiful Github Homepage contains several Vercel environment variables that can be used to remove the rate limit protections:
CACHE_SECONDS: This environment variable takes precedence over our cache minimum and maximum values and can circumvent these values for self Hosted Vercel instances.
See the Vercel documentation on adding these environment variables to your Vercel instance.
You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHub's Sync Fork button. You can also use the pull package created by @wei to automate this process.
I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:
- Giving proper credit when you use beautiful-github-homepage on your readme, linking back to it :D
- Starring and sharing the project 🚀
- You can Sponsor or make one-time donations via
or if you can't do either as a bare minimum star this repo and follow me as a means to thank me.
Thanks! ❤️
Contributions are welcome! <3