Skip to content

stats-organization/github-stats-extended

 
 
GitHub Stats Extended Logo

GitHub Stats Extended

Dynamically generate GitHub stats for your READMEs.

This project is the extended, actively maintained successor of github-readme-stats. It generates various stats cards, e.g. about your GitHub contributions, your top languages, etc. You can customize the cards via multiple parameters.

Table of Contents

Quick Start

  • Copy and paste this into your markdown:
    [![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra)](https://github.com/stats-organization/github-stats-extended)
  • Change the ?username= value to your GitHub username.
  • Done!

As more comfortable alternative, use the GitHub-Stats-Extended Wizard to create your custom stats card. Copy the generated markdown code and paste it into your GitHub profile README. Done!

Migration from github-readme-stats

To migrate from github-readme-stats you only need to change the domain from github-readme-stats.vercel.app to github-stats-extended.vercel.app:

- https://github-readme-stats.vercel.app/api?username=octocat&theme=radical
+ https://github-stats-extended.vercel.app/api?username=octocat&theme=radical

GitHub-Stats-Extended aims to be fully compatible with github-readme-stats. For more details see Compatibility Notes.

Card Types

  • Show your GitHub statistics:

    Anurag's GitHub stats

  • ...your top languages...:

    Top Langs

  • ...and development time:

    Alan's WakaTime stats

  • Pin more than 6 repos in your GitHub profile:

    Readme Card

  • Pin Gists in your GitHub profile:

    Gist Card

  • Customize all the cards:

    Anurag's GitHub stats

Advanced Customization

The GitHub-Stats-Extended Wizard offers some essential customization options. For more advanced customization check out the advanced documentation.

Run It Yourself

If you want to run GitHub-Stats-Extended on your own, there are two main deployment options: you can use github-readme-stats-action to generate cards in your own GitHub Actions workflow. Or you can self-host GitHub-Stats-Extended on Vercel.

See Run It Yourself for detailed instructions.

Acknowledgements

This project is based on github-readme-stats. On top of that project's functionality GitHub-Stats-Extended adds several new features and improvements. See Fork Information for a list of changes. The frontend added to GitHub-Stats-Extended is based on GitHub Trends. Big thanks to @anuraghazra, @avgupta456, @rickstaa, @qwerty541 and everyone else who worked on these projects! ❤️

Contributing

Contributions are welcome!

About

Dynamically generate GitHub stats for your READMEs.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors

Languages

  • JavaScript 80.7%
  • TypeScript 19.0%
  • Other 0.3%