- Notifications
You must be signed in to change notification settings - Fork0
⚡ Dynamically generated stats for your github readmes
License
theo-coder/github-readme-stats
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Get dynamically generated GitHub stats on your readmes!
View Demo ·Report Bug ·Request Feature
Copy paste this into your markdown content, and that's it. Simple!
Change the?username= value to your GitHub's username.
[](https://github.com/anuraghazra/github-readme-stats)
Note: Ranks are calculated based on user's stats, seesrc/calculateRank.js
To hide any specific stats, you can pass a query parameter?hide= with an array of items you wanna hide.
Options:
&hide=["stars","prs","issues","contribs"]
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"])
To enable icons, you can passshow_icons=true in the query param, like so:
Other options:
&hide_border=truehide the border box if you don't like it :D&line_height=30control the line-height between text&hide_rank=truehides the ranking
You can customize the appearance of yourStats Card orRepo Card however you want with URL params.
Customization Options:
| Option | type | Stats Card (default) | Repo Card (default) |
|---|---|---|---|
| title_color | hex color | #2f80ed | #2f80ed |
| text_color | hex color | #333 | #333 |
| icon_color | hex color | #4c71f2 | #586069 |
| bg_color | hex color | rgba(255, 255, 255, 0) | rgba(255, 255, 255, 0) |
- You can also customize the cards to be compatible with dark mode
- Default
- Hiding specific stats
- Showing icons
- Customizing stats card
- Customizing repo card
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.
Copy-paste this code into your readme and change the links.
Endpoint:api/pin?username=anuraghazra&repo=github-readme-stats
[](https://github.com/anuraghazra/github-readme-stats)
You usually won't be able to layout the images side by side. To do that you can use this approach:
<ahref="https://github.com/anuraghazra/github-readme-stats"> <imgalign="left"src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" /></a><ahref="https://github.com/anuraghazra/convoychat"> <imgalign="left"src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" /></a>
Since the GitHub API only allows 5k requests per hour, it is possible that myhttps://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!
Guide on setting up Vercel
- Go tovercel.com
- Click on
Log in - Sign in with GitHub by pressing
Continue with GitHub - Sign into GitHub and allow access to all repositories, if prompted
- Fork this repo
- Go back to yourVercel dashboard
- Select
Import Project - Select
Import Git Repository - Select root and keep everything as is, just add your environment variable named GITHUB_TOKEN (as shown), which will contain a personal access token (PAT), which you can easily createhere (leave everything as is, just name it something, it can be anything you want)
- Click deploy, and you're good to go. See your domains to use the API!
Contributions are welcomed! <3
Made with ❤️ and JavaScript.
About
⚡ Dynamically generated stats for your github readmes
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Languages
- JavaScript99.5%
- Shell0.5%