mirror of
https://github.com/anuraghazra/github-readme-stats.git
synced 2024-12-21 06:11:29 +08:00
9e1fc0b7da
* update default values in readme * docs: improve formatting * docs: improve readme punctation Co-authored-by: rickstaa <rick.staa@outlook.com>
459 lines
20 KiB
Markdown
459 lines
20 KiB
Markdown
<p align="center">
|
||
<img width="100px" src="https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align="center" alt="GitHub Readme Stats" />
|
||
<h2 align="center">GitHub Readme Stats</h2>
|
||
<p align="center">Get dynamically generated GitHub stats on your READMEs!</p>
|
||
</p>
|
||
<p align="center">
|
||
<a href="https://github.com/anuraghazra/github-readme-stats/actions">
|
||
<img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />
|
||
</a>
|
||
<a href="https://github.com/anuraghazra/github-readme-stats/graphs/contributors">
|
||
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/anuraghazra/github-readme-stats" />
|
||
</a>
|
||
<a href="https://codecov.io/gh/anuraghazra/github-readme-stats">
|
||
<img src="https://codecov.io/gh/anuraghazra/github-readme-stats/branch/master/graph/badge.svg" />
|
||
</a>
|
||
<a href="https://github.com/anuraghazra/github-readme-stats/issues">
|
||
<img alt="Issues" src="https://img.shields.io/github/issues/anuraghazra/github-readme-stats?color=0088ff" />
|
||
</a>
|
||
<a href="https://github.com/anuraghazra/github-readme-stats/pulls">
|
||
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/anuraghazra/github-readme-stats?color=0088ff" />
|
||
</a>
|
||
<br />
|
||
<br />
|
||
<a href="https://a.paddle.com/v2/click/16413/119403?link=1227">
|
||
<img src="https://img.shields.io/badge/Supported%20by-VSCode%20Power%20User%20%E2%86%92-gray.svg?colorA=655BE1&colorB=4F44D6&style=for-the-badge"/>
|
||
</a>
|
||
<a href="https://a.paddle.com/v2/click/16413/119403?link=2345">
|
||
<img src="https://img.shields.io/badge/Supported%20by-Node%20Cli.com%20%E2%86%92-gray.svg?colorA=61c265&colorB=4CAF50&style=for-the-badge"/>
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="#demo">View Demo</a>
|
||
·
|
||
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Report Bug</a>
|
||
·
|
||
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Request Feature</a>
|
||
·
|
||
<a href="https://github.com/anuraghazra/github-readme-stats/discussions">Ask Question</a>
|
||
</p>
|
||
<p align="center">
|
||
<a href="/docs/readme_fr.md">Français </a>
|
||
·
|
||
<a href="/docs/readme_cn.md">简体中文</a>
|
||
·
|
||
<a href="/docs/readme_es.md">Español</a>
|
||
·
|
||
<a href="/docs/readme_de.md">Deutsch</a>
|
||
·
|
||
<a href="/docs/readme_ja.md">日本語</a>
|
||
·
|
||
<a href="/docs/readme_pt-BR.md">Português Brasileiro</a>
|
||
·
|
||
<a href="/docs/readme_it.md">Italiano</a>
|
||
·
|
||
<a href="/docs/readme_kr.md">한국어</a>
|
||
.
|
||
<a href="/docs/readme_nl.md">Nederlands</a>
|
||
.
|
||
<a href="/docs/readme_np.md">नेपाली</a>
|
||
.
|
||
<a href="/docs/readme_tr.md">Türkçe</a>
|
||
</p>
|
||
</p>
|
||
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!
|
||
|
||
<p>
|
||
<a href="https://indiafightscorona.giveindia.org">
|
||
<img src="https://indiaspora.org/wp-content/uploads/2021/04/give-India-logo.png" alt="Give india logo" width="200" />
|
||
</a>
|
||
|
||
Are you considering supporting the project by donating? Please DON'T!!
|
||
|
||
Instead, Help India fight the 2nd deadly wave of COVID-19.
|
||
Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure.
|
||
|
||
Visit <https://indiafightscorona.giveindia.org> and make a small donation to help us fight COVID and overcome this crisis.
|
||
A small donation goes a long way. :heart:
|
||
|
||
</p>
|
||
|
||
# Features
|
||
|
||
- [GitHub Stats Card](#github-stats-card)
|
||
- [GitHub Extra Pins](#github-extra-pins)
|
||
- [Top Languages Card](#top-languages-card)
|
||
- [Wakatime Week Stats](#wakatime-week-stats)
|
||
- [Themes](#themes)
|
||
- [Customization](#customization)
|
||
- [Common Options](#common-options)
|
||
- [Stats Card Exclusive Options](#stats-card-exclusive-options)
|
||
- [Repo Card Exclusive Options](#repo-card-exclusive-options)
|
||
- [Language Card Exclusive Options](#language-card-exclusive-options)
|
||
- [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options)
|
||
- [Deploy Yourself](#deploy-on-your-own-vercel-instance)
|
||
|
||
# GitHub Stats Card
|
||
|
||
Copy-paste this into your markdown content, and that's it. Simple!
|
||
|
||
Change the `?username=` value to your GitHub username.
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
_Note: Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone).
|
||
The values are calculated by using the [cumulative distribution function](https://en.wikipedia.org/wiki/Cumulative_distribution_function) using commits, contributions, issues, stars, pull requests, followers, and owned repositories.
|
||
The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js)._
|
||
|
||
### Hiding individual stats
|
||
|
||
To hide any specific stats, you can pass a query parameter `&hide=` with comma-separated values.
|
||
|
||
> Options: `&hide=stars,commits,prs,issues,contribs`
|
||
|
||
```md
|
||
|
||
```
|
||
|
||
### Adding private contributions count to total commits count
|
||
|
||
You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`.
|
||
|
||
_Note: If you are deploying this project yourself, the private contributions will be counted by default. Otherwise, you need to choose to share your private contribution counts._
|
||
|
||
> Options: `&count_private=true`
|
||
|
||
```md
|
||
|
||
```
|
||
|
||
### Showing icons
|
||
|
||
To enable icons, you can pass `show_icons=true` in the query param, like so:
|
||
|
||
```md
|
||
|
||
```
|
||
|
||
### Themes
|
||
|
||
With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization).
|
||
|
||
Use `&theme=THEME_NAME` parameter like so :-
|
||
|
||
```md
|
||
|
||
```
|
||
|
||
#### All inbuilt themes:-
|
||
|
||
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
|
||
|
||
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stats Themes" width="600px"/>
|
||
|
||
You can look at a preview for [all available themes](./themes/README.md) or checkout the [theme config file](./themes/index.js) & **you can also contribute new themes** if you like :D
|
||
|
||
### Customization
|
||
|
||
You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL params.
|
||
|
||
#### Common Options:
|
||
|
||
- `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 when `hide_border` is enabled).
|
||
- `bg_color` - Card's background color _(hex color)_ **or** a gradient in the form of _angle,start,end_. Default: `fffefe`
|
||
- `hide_border` - Hides the card's border _(boolean)_. Default: `false`
|
||
- `theme` - name of the theme, choose from [all available themes](./themes/README.md). Default: `default` theme.
|
||
- `cache_seconds` - set the cache header manually _(min: 7200, max: 86400)_. Default: `14400 seconds (4 hours)`.
|
||
- `locale` - set the language in the card _(e.g. cn, de, es, etc.)_. Default: `en`.
|
||
- `border_radius` - Corner rounding on the card. Default: `4.5`.
|
||
|
||
> Note: The minimum of cache_seconds is currently 4 hours as a temporary fix for PATs exhaustion.
|
||
|
||
##### Gradient in bg_color
|
||
|
||
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
|
||
|
||
> Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
|
||
|
||
#### Stats Card Exclusive Options:
|
||
|
||
- `hide` - Hides the [specified items](#hiding-individual-stats) from stats _(Comma-separated values)_. Default: `[] (blank array)`.
|
||
- `hide_title` - _(boolean)_. Default: `false`.
|
||
- `card_width` - Set the card's width manually _(number)_. Default: `500px (approx.)`.
|
||
- `hide_rank` - _(boolean)_ hides the rank and automatically resizes the card width. Default: `false`.
|
||
- `show_icons` - _(boolean)_. Default: `false`.
|
||
- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_. Default: `false`.
|
||
- `count_private` - Count private commits _(boolean)_. Default: `false`.
|
||
- `line_height` - Sets the line-height between text _(number)_. Default: `25`.
|
||
- `exclude_repo` - Exclude 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` - Use bold text _(boolean)_. Default: `true`.
|
||
- `disable_animations` - Disables all animations in the card _(boolean)_. Default: `false`.
|
||
|
||
> Note on `hide_rank`:
|
||
> When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
|
||
|
||
#### Repo Card Exclusive Options:
|
||
|
||
- `show_owner` - Show the repo's owner name _(boolean)_. Defaults to `false`.
|
||
|
||
#### Language Card Exclusive Options:
|
||
|
||
- `hide` - Hide the languages specified from the card _(Comma-separated values)_
|
||
- `hide_title` - _(boolean)_. Defaults to `false`.
|
||
- `layout` - Switch between two available layouts `default` & `compact`
|
||
- `card_width` - Set the card's width manually _(number)_
|
||
- `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_
|
||
- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_
|
||
- `custom_title` - Sets a custom title for the card
|
||
|
||
> :warning: **Important:**
|
||
> Language names should be uri-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
|
||
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
|
||
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
|
||
|
||
#### Wakatime Card Exclusive Options:
|
||
|
||
- `hide` - Hide the languages specified from the card _(Comma-separated values)_
|
||
- `hide_title` - _(boolean)_. Defaults to `false`.
|
||
- `line_height` - Sets the line-height between text _(number)_. Default Value: `25`.
|
||
- `hide_progress` - Hides the progress bar and percentage _(boolean)_
|
||
- `custom_title` - Sets a custom title for the card
|
||
- `layout` - Switch between two available layouts `default` & `compact`
|
||
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages
|
||
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi)
|
||
- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options.
|
||
|
||
* * *
|
||
|
||
# GitHub Extra Pins
|
||
|
||
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.
|
||
|
||
### Usage
|
||
|
||
Copy-paste this code into your readme and change the links.
|
||
|
||
Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
### Demo
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
Use [show_owner](#customization) variable to include the repo's owner username
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
# Top Languages Card
|
||
|
||
The top languages card shows a GitHub user's most frequently used top language.
|
||
|
||
_NOTE: Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It's a new feature of github-readme-stats._
|
||
|
||
### Usage
|
||
|
||
Copy-paste this code into your readme and change the links.
|
||
|
||
Endpoint: `api/top-langs?username=anuraghazra`
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
### Exclude individual repositories
|
||
|
||
You can use `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
### Hide individual languages
|
||
|
||
You can use `&hide=language1,language2` parameter to hide individual languages.
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
### Show more languages
|
||
|
||
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 10 (inclusive), and the default is 5.
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
### Compact Language Card Layout
|
||
|
||
You can use the `&layout=compact` option to change the card design.
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
### Demo
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
- Compact layout
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
# Wakatime Week Stats
|
||
|
||
Change the `?username=` value to your [Wakatime](https://wakatime.com) username.
|
||
|
||
```md
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
```
|
||
|
||
> Note: Please be aware that we currently only show data from Wakatime profiles that are public.
|
||
|
||
### Demo
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
- Compact layout
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
* * *
|
||
|
||
### All Demos
|
||
|
||
- Default
|
||
|
||
|
||
|
||
- Hiding specific stats
|
||
|
||
|
||
|
||
- Showing icons
|
||
|
||
|
||
|
||
- Customize Border Color
|
||
|
||
|
||
|
||
- Include All Commits
|
||
|
||
|
||
|
||
- Themes
|
||
|
||
Choose from any of the [default themes](#themes)
|
||
|
||
|
||
|
||
- Gradient
|
||
|
||
|
||
|
||
- Customizing stats card
|
||
|
||
|
||
|
||
- Setting card locale
|
||
|
||
|
||
|
||
- Customizing repo card
|
||
|
||
|
||
|
||
- Top languages
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
- Wakatime card
|
||
|
||
[](https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
* * *
|
||
|
||
### Quick Tip (Align The Repo Cards)
|
||
|
||
You usually won't be able to layout the images side by side. To do that you can use this approach:
|
||
|
||
```html
|
||
<a href="https://github.com/anuraghazra/github-readme-stats">
|
||
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
|
||
</a>
|
||
<a href="https://github.com/anuraghazra/convoychat">
|
||
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
|
||
</a>
|
||
```
|
||
|
||
## Deploy on your own Vercel instance
|
||
|
||
#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
|
||
|
||
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
|
||
|
||
NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we should be able to handle more than 5k requests and have no issues with downtime :D
|
||
|
||
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
|
||
|
||
<details>
|
||
<summary><b> Guide on setting up Vercel 🔨 </b></summary>
|
||
|
||
1. Go to [vercel.com](https://vercel.com/)
|
||
2. Click on `Log in`
|
||
|
||
3. Sign in with GitHub by pressing `Continue with GitHub`
|
||
|
||
4. Sign in to GitHub and allow access to all repositories, if prompted
|
||
5. Fork this repo
|
||
6. After forking the repo, open the [`vercel.json`](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json#L5) file and change the `maxDuration` field to `10`
|
||
7. Go back to your [Vercel dashboard](https://vercel.com/dashboard)
|
||
8. Select `Import Project`
|
||
|
||
9. Select `Import Git Repository`. Select root and keep everything as is.
|
||
|
||
10. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` permissions (this allows access to see private repo stats)
|
||
11. Add the PAT as an environment variable named `PAT_1` (as shown).
|
||
|
||
12. Click deploy, and you're good to go. See your domains to use the API!
|
||
|
||
</details>
|
||
|
||
## :sparkling_heart: Support the project
|
||
|
||
I open-source almost everything I can, and I 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 github-readme-stats on your readme, linking back to it :D
|
||
- Starring and sharing the project :rocket:
|
||
- [](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
||
|
||
Thanks! :heart:
|
||
|
||
* * *
|
||
|
||
[](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss)
|
||
|
||
Contributions are welcome! <3
|
||
|
||
Made with :heart: and JavaScript.
|