|
|
|
@@ -80,9 +80,6 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
|
|
|
|
|
|
|
|
|
|
# Features
|
|
|
|
|
|
|
|
|
|
- [Getting Started](#getting-started)
|
|
|
|
|
- [GitHub Actions](#github-actions-recommended)
|
|
|
|
|
- [Community Deployment](#community-deployment)
|
|
|
|
|
- [GitHub Stats Card](#github-stats-card)
|
|
|
|
|
- [GitHub Extra Pins](#github-extra-pins)
|
|
|
|
|
- [Top Languages Card](#top-languages-card)
|
|
|
|
@@ -97,141 +94,17 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
|
|
|
|
|
- [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options)
|
|
|
|
|
- [Deploy Yourself](#deploy-on-your-own-vercel-instance)
|
|
|
|
|
- [Keep your fork up to date](#keep-your-fork-up-to-date)
|
|
|
|
|
|
|
|
|
|
# Getting Started
|
|
|
|
|
|
|
|
|
|
## GitHub Actions (Recommended)
|
|
|
|
|
# GitHub Stats Card
|
|
|
|
|
|
|
|
|
|
Using GitHub Actions over the community deployment is recommended because it provides more accurate stats and 100% uptime. Simply copy-paste the following into the `/.github/workflows/grs.yml` file in your README repo (`USERNAME/USERNAME`).
|
|
|
|
|
Copy-paste this into your markdown content, and that is it. Simple!
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
name: GitHub Readme Stats
|
|
|
|
|
on:
|
|
|
|
|
workflow_dispatch:
|
|
|
|
|
schedule:
|
|
|
|
|
- cron: 0 * * * *
|
|
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
|
grs:
|
|
|
|
|
permissions: write-all
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
name: Generate Stats
|
|
|
|
|
steps:
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v3
|
|
|
|
|
- name: Generate Stats
|
|
|
|
|
uses: Zo-Bro-23/grs-action@v1
|
|
|
|
|
id: generate
|
|
|
|
|
with:
|
|
|
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
|
options: 'username=${{ github.repository_owner }}'
|
|
|
|
|
- name: Push
|
|
|
|
|
uses: crazy-max/ghaction-github-pages@v3
|
|
|
|
|
with:
|
|
|
|
|
target_branch: grs
|
|
|
|
|
build_dir: grs
|
|
|
|
|
env:
|
|
|
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
If you want to generate multiple stats, such as top languages, wakatime, etc, you can use the following code.
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
name: GitHub Readme Stats
|
|
|
|
|
on:
|
|
|
|
|
workflow_dispatch:
|
|
|
|
|
schedule:
|
|
|
|
|
- cron: 0 * * * *
|
|
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
|
stats:
|
|
|
|
|
permissions: write-all
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
name: Stats Card
|
|
|
|
|
steps:
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v3
|
|
|
|
|
- name: Generate Stats
|
|
|
|
|
uses: Zo-Bro-23/grs-action@v1
|
|
|
|
|
id: generate
|
|
|
|
|
with:
|
|
|
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
|
options: 'username=${{ github.repository_owner }}'
|
|
|
|
|
- uses: actions/upload-artifact@master
|
|
|
|
|
with:
|
|
|
|
|
name: stats
|
|
|
|
|
path: grs
|
|
|
|
|
top-langs:
|
|
|
|
|
permissions: write-all
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
name: Top Languages Card
|
|
|
|
|
steps:
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v3
|
|
|
|
|
- name: Generate Top Languages
|
|
|
|
|
uses: Zo-Bro-23/grs-action@v1
|
|
|
|
|
id: generate
|
|
|
|
|
with:
|
|
|
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
|
options: 'username=${{ github.repository_owner }}'
|
|
|
|
|
card: 'top-langs'
|
|
|
|
|
- uses: actions/upload-artifact@master
|
|
|
|
|
with:
|
|
|
|
|
name: top-langs
|
|
|
|
|
path: grs
|
|
|
|
|
push:
|
|
|
|
|
permissions: write-all
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
name: Push
|
|
|
|
|
needs: [stats, top-langs]
|
|
|
|
|
steps:
|
|
|
|
|
- uses: actions/download-artifact@master
|
|
|
|
|
with:
|
|
|
|
|
name: stats
|
|
|
|
|
path: grs
|
|
|
|
|
- uses: actions/download-artifact@master
|
|
|
|
|
with:
|
|
|
|
|
name: top-langs
|
|
|
|
|
path: grs
|
|
|
|
|
- name: Push
|
|
|
|
|
uses: crazy-max/ghaction-github-pages@v3
|
|
|
|
|
with:
|
|
|
|
|
target_branch: grs
|
|
|
|
|
build_dir: grs
|
|
|
|
|
env:
|
|
|
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You can now include the stats in your README by using the following markdown code (replace `USERNAME` with your GitHub username).
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You can also enable GitHub Pages on the `grs` branch (root) and use that URL (replace `GH_PAGES_URL` with your GitHub Pages URL).
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The GitHub Action accepts the following inputs:
|
|
|
|
|
- `token` - `REQUIRED` - Your GitHub Personal Access Token (PAT), or any other token that GitHub accepts.
|
|
|
|
|
- `options` - `REQUIRED` - Any customization options. More below. (This is the same as the query string you would pass to the API if using the community deployment)
|
|
|
|
|
- `card` - The type of card to generate. `repo`, `top-langs`, or `wakatime` (leave empty for stats card).
|
|
|
|
|
- `path` - Output path for SVG file. Relative path; include filename with `.svg`.
|
|
|
|
|
- `fetch_multipage` - Experimental feature that gives more accurate stats if you have >100 repos.
|
|
|
|
|
|
|
|
|
|
## Community Deployment
|
|
|
|
|
Copy-paste the following markdown code. Change the `?username=` value to your GitHub username.
|
|
|
|
|
Change the `?username=` value to your GitHub username.
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Other cards can be included by using `/api/top-langs`, `/api/pin`, or `/api/wakatime`. More customization options can be added by using query parameters (`&option1=value1&option2=value2&...`).
|
|
|
|
|
|
|
|
|
|
# GitHub Stats Card
|
|
|
|
|
|
|
|
|
|
> **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).
|
|
|
|
|
|
|
|
|
@@ -242,7 +115,7 @@ You can pass a query parameter `&hide=` to hide any specific stats with comma-se
|
|
|
|
|
> Options: `&hide=stars,commits,prs,issues,contribs`
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&hide=contribs,prs
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Adding private contributions count to total commits count
|
|
|
|
@@ -255,7 +128,7 @@ You can add the count of all your private contributions to the total commits cou
|
|
|
|
|
> Options: `&count_private=true`
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&count_private=true
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Showing icons
|
|
|
|
@@ -263,7 +136,7 @@ You can add the count of all your private contributions to the total commits cou
|
|
|
|
|
To enable icons, you can pass `show_icons=true` in the query param, like so:
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&show_icons=true
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Themes
|
|
|
|
@@ -273,7 +146,7 @@ With inbuilt themes, you can customize the look of the card without doing any [m
|
|
|
|
|
Use `&theme=THEME_NAME` parameter like so :
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&show_icons=true&theme=radical
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### All inbuilt themes
|
|
|
|
@@ -296,7 +169,7 @@ Since GitHub will re-upload the cards and serve them from their [CDN](https://do
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&show_icons=true&theme=transparent
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
@@ -311,7 +184,7 @@ We have included a `transparent` theme that has a transparent background. This t
|
|
|
|
|
You can use the `bg_color` parameter to make any of [the available themes](./themes/README.md) transparent. This is done by setting the `bg_color` to a colour with a transparent alpha channel (i.e. `bg_color=00000000`):
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&show_icons=true&bg_color=00000000
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
@@ -326,8 +199,8 @@ You can use the `bg_color` parameter to make any of [the available themes](./the
|
|
|
|
|
You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) 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:
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
@@ -345,14 +218,14 @@ You can use [GitHub's new media feature](https://github.blog/changelog/2022-05-1
|
|
|
|
|
```html
|
|
|
|
|
<picture>
|
|
|
|
|
<source
|
|
|
|
|
srcset="https://DARK_SVG_URL/"
|
|
|
|
|
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
|
|
|
|
|
media="(prefers-color-scheme: dark)"
|
|
|
|
|
/>
|
|
|
|
|
<source
|
|
|
|
|
srcset="https://LIGHT_SVG_URL/"
|
|
|
|
|
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://DEFAULT_SVG_URL/" />
|
|
|
|
|
<img src="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true" />
|
|
|
|
|
</picture>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
@@ -375,7 +248,7 @@ You can use [GitHub's new media feature](https://github.blog/changelog/2022-05-1
|
|
|
|
|
|
|
|
|
|
### Customization
|
|
|
|
|
|
|
|
|
|
You can customize the appearance of your cards however you wish with these parameters.
|
|
|
|
|
You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL parameters.
|
|
|
|
|
|
|
|
|
|
#### Common Options
|
|
|
|
|
|
|
|
|
@@ -391,7 +264,7 @@ You can customize the appearance of your cards however you wish with these param
|
|
|
|
|
- `border_radius` - Corner rounding on the card. Default: `4.5`.
|
|
|
|
|
|
|
|
|
|
> **Warning**
|
|
|
|
|
> We use caching to decrease the load on our servers (see <https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425>). Our cards have a default cache of 4 hours (14400 seconds). Also, note that the cache is clamped to a minimum of 4 hours and a maximum of 24 hours. This is why we recommend using our GitHub Action :)
|
|
|
|
|
> We use caching to decrease the load on our servers (see <https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425>). Our cards have a default cache of 4 hours (14400 seconds). Also, note that the cache is clamped to a minimum of 4 hours and a maximum of 24 hours.
|
|
|
|
|
|
|
|
|
|
##### Gradient in bg_color
|
|
|
|
|
|
|
|
|
@@ -461,7 +334,13 @@ Yay! You are no longer limited to 6 pinned repositories.
|
|
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
|
|
|
|
|
Use the `api/pin` endpoint with the API or the `card: 'repo'` option with the GitHub Action.
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
@@ -476,18 +355,24 @@ Use [show_owner](#customization) variable to include the repo's owner username
|
|
|
|
|
The top languages card shows a GitHub user's most frequently used top language.
|
|
|
|
|
|
|
|
|
|
> **Note**
|
|
|
|
|
> Top Languages does not indicate skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub.
|
|
|
|
|
> 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 is a new feature of github-readme-stats.
|
|
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
|
|
|
|
|
Use the `api/top-langs` endpoint with the API or the `card: 'top-langs'` option with the GitHub Action.
|
|
|
|
|
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 the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Hide individual languages
|
|
|
|
@@ -495,7 +380,7 @@ You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repo
|
|
|
|
|
You can use `&hide=language1,language2` parameter to hide individual languages.
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&hide=javascript,html
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Show more languages
|
|
|
|
@@ -503,7 +388,7 @@ You can use `&hide=language1,language2` parameter to hide individual 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
|
|
|
|
|
?username=anuraghazra&langs_count=8
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Compact Language Card Layout
|
|
|
|
@@ -511,7 +396,7 @@ You can use the `&langs_count=` option to increase or decrease the number of lan
|
|
|
|
|
You can use the `&layout=compact` option to change the card design.
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&layout=compact
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Hide Progress Bars
|
|
|
|
@@ -519,7 +404,7 @@ You can use the `&layout=compact` option to change the card design.
|
|
|
|
|
You can use the `&hide_progress=true` option to hide the percentages and the progress bars (layout will be automatically set to `compact`).
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=anuraghazra&hide_progress=true
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Demo
|
|
|
|
@@ -536,27 +421,15 @@ You can use the `&hide_progress=true` option to hide the percentages and the pro
|
|
|
|
|
|
|
|
|
|
# Wakatime Week Stats
|
|
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
|
|
|
|
|
Use the `api/wkatime` endpoint with the API or the `card: 'wakatime'` option with the GitHub Action.
|
|
|
|
|
|
|
|
|
|
Change the `?username=` value to your [Wakatime](https://wakatime.com) username.
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=willianrod
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
> **Note**:
|
|
|
|
|
> Please be aware that we currently only show data from Wakatime profiles that are public.
|
|
|
|
|
|
|
|
|
|
### Compact Wakatime Card Layout
|
|
|
|
|
|
|
|
|
|
You can use the `&layout=compact` option to change the card design.
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
?username=willianrod&layout=compact
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Demo
|
|
|
|
|
|
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
@@ -629,14 +502,14 @@ By default, GitHub does not lay out the cards side by side. To do that, you can
|
|
|
|
|
|
|
|
|
|
```html
|
|
|
|
|
<a href="https://github.com/anuraghazra/github-readme-stats">
|
|
|
|
|
<img align="center" src="https://SVG_URL/" />
|
|
|
|
|
<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://SVG_URL/" />
|
|
|
|
|
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
|
|
|
|
|
</a>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Deploy your own Vercel instance
|
|
|
|
|
## Deploy on your own Vercel instance
|
|
|
|
|
|
|
|
|
|
#### :film_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
|
|
|
|
|
|
|
|
|
@@ -675,7 +548,7 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
|
|
|
|
|
|
|
|
|
|
### Keep your fork up to date
|
|
|
|
|
|
|
|
|
|
You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHub's [Sync Fork button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process.
|
|
|
|
|
You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHubs' [Sync Fork button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process.
|
|
|
|
|
|
|
|
|
|
## :sparkling_heart: Support the project
|
|
|
|
|
|
|
|
|
|
Zohan Subhash
Rick Staa
Cateline Mnemosyne
Oleksandr PerlovandZohan Subhash
Mohamed Hassan