26

Dynamically generated stats for your GitHub readme

 3 years ago
source link: https://github.com/anuraghazra/github-readme-stats
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

GitHub Readme Stats

Get dynamically generated GitHub stats on your readmes!

· Report Bug · Request Feature

Features

GitHub Stats Card

Copy paste this into your markdown content, and that's it. Simple!

Change the ?username= value to your GitHub's username.

[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

Note: Ranks are calculated based on user's stats, see src/calculateRank.js

Hiding individual stats

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"])

Showing icons

To enable icons, you can pass show_icons=true in the query param, like so:

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)

Other options:

&hide_border=true
&line_height=30
&hide_rank=true

Customization

You can customize the appearance of your Stats Card or Repo 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
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&title_color=fff&icon_color=79ff97&text_color=9f9f9f&bg_color=151515)

Demo

  • Default
  • Hiding specific stats
  • Showing icons
  • Customizing stats card
  • Customizing repo card

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

[![ReadMe Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats)

Demo

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:

<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!

Guide on setting up Vercel
  1. Go to vercel.com
  2. Click on Log in
    Nn2IjiJ.png!web
  3. Sign in with GitHub by pressing Continue with GitHub
    MVVFnqu.jpg!web
  4. Sign into GitHub and allow access to all repositories, if prompted
  5. Fork this repo
  6. Go back to your Vercel dashboard
  7. Select Import Project
    6jUjUrA.png!web
  8. Select Import Git Repository
    QfiuIzR.png!web
  9. 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 create here (leave everything as is, just name it something, it can be anything you want)
    Bn267vA.png!web
  10. Click deploy, and you're good to go. See your domains to use the API!

Contributions are welcomed! <3

Made with :heart: and JavaScript.


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK