README.md

📊 Metrics

Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!

For user accounts	For organization accounts
🧩 Customizable with 38 plugins and 234 options!
📅 Isometric commit calendar	🈷️ Most used languages
Full year calendar Half year calendar	Indepth analysis (clone and analyze repositories) Recently used (analyze recent activity events) Default algorithm Default algorithm (with details)
📌 Starred topics	🌟 Recently starred repositories
With icons With labels
📜 Repository licenses	💡 Coding habits
Permissions, limitations and conditions Licenses overview	Recent activity charts Midly interesting facts
🏅 Repository contributors	🎟️ Follow-up of issues and pull requests
By contribution types By number of contributions	Indepth analysis Created on an user's repositories Created by an user
🎭 Comment reactions	🧑‍🤝‍🧑 People plugin
	Related to an user Related to a repository
✨ Stargazers over last weeks	🗂️ Active projects
♐ Code snippet of the day	📰 Recent activity
🏆 Achievements	🎩 Notable contributions
Compact display Detailed display	Indepth analysis Contributions in organizations only
💬 Discussions	💭 GitHub Community Support
👨‍💻 Lines of code changed	🧮 Repositories traffic
📓 Repositories	🎫 Gists
🙋 Introduction	💕 GitHub Sponsors
For an user or an organization For a repository	GitHub sponsors card GitHub sponsors full introduction
💫 Starlists	🌇 GitHub Skyline 3D calendar
⏱️ Website performances	🎼 Music plugin
PageSpeed scores PageSpeed scores with detailed report PageSpeed scores with a website screenshot	Random tracks from a playlist Recently listened
🗨️ Stackoverflow plugin	🌸 Anilist watch list and reading list
	For anime watchers For manga readers Favorites characters
🐤 Latest tweets	✒️ Recent posts
Latest tweets Latest tweets with attachments	Latest posts Latest posts width description and cover image
🗼 Rss feed	⏰ WakaTime plugin
💹 Stock prices
🎲 See also community plugins
🖼️ And even more with 4+ templates!
📗 Classic template	📘 Repository template
📙 Terminal template	📒 Markdown template
📕 See also community templates
🦑 Try it now!
📊 Metrics embed	✨ Metrics insights
Embed metrics images on your profile or blog! Use GitHub actions for even more features!	Share your metrics with friends and on social medias! No configuration needed!
Power user? Fork this repository and edit HTML, CSS, JS and for even more customization!

📚 Documentation

^{⚠️ This is the documentation of v3.18-beta (@master/@main branches) which includes unreleased features. See documentation for v3.17 (@latest branch) here.}

🦮 Setup

There are several ways to setup metrics, each having its advantages and disadvantages:

• ⚙️ Using GitHub Action on a profile repository (~10 min)
  • ✔️ All features
  • ✔️ High availability (no downtimes)
  • ➖ Configuration can be a bit time-consuming
• 💕 Using the shared instance (~1 min)
  • ✔️ Easily configurable and previewable
  • ➖ Limited features (compute-intensive features are disabled)
• 🐳 Using command line with docker (~5 min) (documentation not available yet)
  • ✔️ Suited for one-time rendering
• 🏗️ Deploying your own web instance (~20 min)
  • ➖ Mostly intended for development, or to create another shared instance

Additional resources for setup:

• 🏦 Configuring metrics for organizations
• 🧰 Template/Plugin compatibility matrix (documentation not available yet)

🖼️ Templates

Templates lets you change general appearance of rendered metrics.

• 📗 Classic template
• 📘 Repository template
• 📙 Terminal template
• 📒 Markdown template
• 📕 Community templates

🧩 Plugins

Plugins provide additional content and lets you customize your rendered metrics.

📦 Maintained by core team

• Core
  • 🗃️ Base content
  • 🧱 Core
• Github
  • 🏆 Achievements
  • 📰 Recent activity
  • ♐ Code snippet of the day
  • 🏅 Repository contributors
  • 💬 Discussions
  • 🎟️ Follow-up of issues and pull requests
  • 🎫 Gists
  • 💡 Coding habits
  • 🙋 Introduction
  • 📅 Isometric commit calendar
  • 🈷️ Most used languages
  • 📜 Repository licenses
  • 👨‍💻 Lines of code changed
  • 🎩 Notable contributions
  • 🧑‍🤝‍🧑 People plugin
  • 🗂️ Active projects
  • 🎭 Comment reactions
  • 📓 Repositories
  • 🌇 GitHub Skyline 3D calendar
  • 💕 GitHub Sponsors
  • ✨ Stargazers over last weeks
  • 💫 Starlists
  • 🌟 Recently starred repositories
  • 💭 GitHub Community Support
  • 📌 Starred topics
  • 🧮 Repositories traffic
• Social
  • 🌸 Anilist watch list and reading list
  • 🎼 Music plugin
  • ⏱️ Website performances
  • ✒️ Recent posts
  • 🗼 Rss feed
  • 🗨️ Stackoverflow plugin
  • 💹 Stock prices
  • 🐤 Latest tweets
  • ⏰ WakaTime plugin

🎲 Maintained by community

• 💉 Nightscout by @legoandmars
• 💩 PoopMap plugin by @matievisthekat
• 📸 Website screenshot by @lowlighter

💪 Contributing

If you are interested in contributing, the following resources may interest you:

• 💪 Contribution guide
• 🧬 Architecture
• 📜 License
• GitHub resources
  • 📖 GitHub GraphQL API
  • 📖 GitHub GraphQL Explorer
  • 📖 GitHub Rest API
  • 📖 GitHub Octicons

Use 💬 discussions for feedback, new features suggestions, bugs reports or to request help for installation.

📜 License

MIT License
Copyright (c) 2020-present lowlighter