mirror of
https://github.com/anuraghazra/github-readme-stats.git
synced 2024-12-15 06:04:17 +08:00
339 lines
13 KiB
Markdown
339 lines
13 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://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>
|
|
</p>
|
|
<p align="center">
|
|
<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_kr.md">한국어</a>
|
|
</p>
|
|
</p>
|
|
<p align="center">Loved the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!
|
|
|
|
# Features
|
|
|
|
- [GitHub Stats Card](#github-stats-card)
|
|
- [GitHub Extra Pins](#github-extra-pins)
|
|
- [Top Languages Card](#top-languages-card)
|
|
- [Themes](#themes)
|
|
- [Customization](#customization)
|
|
- [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's username.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
_Note: Ranks are calculated based on user's stats, see [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 chose 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 Stat 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 want with URL params.
|
|
|
|
#### Common Options:
|
|
|
|
- `title_color` - Card's title color _(hex color)_
|
|
- `text_color` - Body text color _(hex color)_
|
|
- `icon_color` - Icons color if available _(hex color)_
|
|
- `bg_color` - Card's background color _(hex color)_ **or** a gradient in the form of _angle,start,end_
|
|
- `theme` - name of the theme, choose from [all available themes](./themes/README.md)
|
|
- `cache_seconds` - set the cache header manually _(min: 1800, max: 86400)_
|
|
|
|
##### Gradient in bg_color
|
|
|
|
You can provide multiple comma saperated values in bg_color option to render a gradient, the format of the gradient is :-
|
|
|
|
```
|
|
&bg_color=DEG,COLOR1,COLRO2,COLOR3...COLOR10
|
|
```
|
|
|
|
> Note on cache: Repo cards have default cache of 30mins (1800 seconds) if the fork count & star count is less than 1k otherwise it's 2hours (7200). Also note that cache is clamped to minimum of 30min and maximum of 24hours
|
|
|
|
#### Stats Card Exclusive Options:
|
|
|
|
- `hide` - Hide's the specified items from stats _(Comma seperated values)_
|
|
- `hide_title` - _(boolean)_
|
|
- `hide_rank` - _(boolean)_
|
|
- `show_icons` - _(boolean)_
|
|
- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_
|
|
- `count_private` - Count private commits _(boolean)_
|
|
- `line_height` - Sets the line-height between text _(number)_
|
|
|
|
#### Repo Card Exclusive Options:
|
|
|
|
- `show_owner` - Show the owner name of the repo _(boolean)_
|
|
|
|
#### Language Card Exclusive Options:
|
|
|
|
- `hide` - Hide the languages specified from the card _(Comma seperated values)_
|
|
- `hide_title` - _(boolean)_
|
|
- `layout` - Switch between two available layouts `default` & `compact`
|
|
- `card_width` - Set the card's width manually _(number)_
|
|
|
|
> :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.)
|
|
|
|
---
|
|
|
|
# GitHub Extra Pins
|
|
|
|
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
|
|
|
|
Yey! 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
|
|
|
|
Top languages card shows github user's top langauges which has been mostly used.
|
|
|
|
_NOTE: Top languages does not indicate my skill level or something like that, it's a github metric of which languages i 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)
|
|
```
|
|
|
|
### Hide individual languages
|
|
|
|
You can use `?hide=language1,language2` parameter to hide individual languages.
|
|
|
|
```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)
|
|
|
|
---
|
|
|
|
### All Demos
|
|
|
|
- Default
|
|
|
|
|
|
|
|
- Hiding specific stats
|
|
|
|
|
|
|
|
- Showing icons
|
|
|
|
|
|
|
|
- Include All Commits
|
|
|
|
|
|
|
|
- Themes
|
|
|
|
Choose from any of the [default themes](#themes)
|
|
|
|
|
|
|
|
- Gradient
|
|
|
|
|
|
|
|
- Customizing stats card
|
|
|
|
|
|
|
|
- Customizing repo card
|
|
|
|
|
|
|
|
- Top languages
|
|
|
|
[](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:
|
|
|
|
```md
|
|
<a href="https://github.com/anuraghazra/github-readme-stats">
|
|
<img align="left" 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="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
|
|
</a>
|
|
```
|
|
|
|
## Deploy on your own Vercel instance
|
|
|
|
Since the GitHub API only allows 5k requests per hour, it is possible that my `https://github-readme-stats.vercel.app/api` could 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/)
|
|
1. Click on `Log in`
|
|
|
|
1. Sign in with GitHub by pressing `Continue with GitHub`
|
|
|
|
1. Sign into GitHub and allow access to all repositories, if prompted
|
|
1. Fork this repo
|
|
1. Go back to your [Vercel dashboard](https://vercel.com/dashboard)
|
|
1. Select `Import Project`
|
|
|
|
1. Select `Import Git Repository`
|
|
|
|
1. Select root and keep everything as is, just add your environment variable named PAT_1 (as shown), which will contain a personal access token (PAT), which you can easily create [here](https://github.com/settings/tokens/new) (leave everything as is, just name it something, it can be anything you want)
|
|
|
|
1. 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 happy with it or just want to encourage me to continue creating stuff, there are 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:
|
|
|
|
---
|
|
|
|
Contributions are welcomed! <3
|
|
|
|
Made with :heart: and JavaScript.
|