访问官网
Github
GitHub Readme Stats
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!
Are you considering supporting the project by donating to me? Please DO NOT!!!
India has recently suffered one of the most devastating train accidents, and your help will be immensely valuable for the people who were affected by this tragedy.
Please visit this link and make a small donation to help the people in need. A small donation goes a long way. :heart:
Features
- GitHub Stats Card
- GitHub Extra Pins
- GitHub Gist Pins
- Top Languages Card
- WakaTime Stats Card
- All Demos
- Deploy on your own
- :sparkling_heart: Support the project
Important Notices
[!IMPORTANT]
Since the GitHub API only allows 5k requests per hour per user account, the public Vercel instance hosted onhttps://github-readme-stats.vercel.app/apicould possibly hit the rate limiter (see #1471). We use caching to prevent this from happening (see https://github.com/anuraghazra/github-readme-stats#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 :+1:. We use the Top Issues dashboard for tracking community demand (see #1935). Do not hesitate to upvote the issues and pull requests you are interested in. We will work on the most upvoted first.
GitHub Stats Card
Copy and paste this into your markdown, and that's it. Simple!
Change the ?username= value to your GitHub username.
[](https://github.com/anuraghazra/github-readme-stats)
[!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.
Hiding individual stats
You can pass a query parameter &hide= to hide any specific stats with comma-separated values.
Options:
&hide=stars,commits,prs,issues,contribs
Showing additional individual stats
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
Showing icons
To enable icons, you can pass &show_icons=true in the query param, like so:
Themes
With inbuilt themes, you can customize the look of the card without doing any manual customization.
Use &theme=THEME_NAME parameter like so :
All inbuilt themes
GitHub Readme Stats 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 the addition of new themes to decrease maintenance efforts; all pull requests related to new themes will be closed.
Responsive Card Theme
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.
Use the transparent theme
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:
:eyes: Show example
Add transparent alpha channel to a themes bg_color
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):
:eyes: Show example
Use GitHub's theme context tag
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/anuraghazra/github-readme-stats#gh-dark-mode-only)
[](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
:eyes: Show example
Use GitHub's new media feature
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://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
media="(prefers-color-scheme: dark)"
/>
<source
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true"
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
/>
<img src="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true" />
</picture>
