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 39 plugins and 244 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
Classic charts Chartist charts
♐ 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
Repositories from star lists Languages from star lists
⏱️ 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 For waifus simp
🐤 Latest tweets	✒️ Recent posts
Latest tweets with attachments Latest tweets	Latest posts width description and cover image Latest posts
🗼 Rss feed	⏰ WakaTime plugin
🎲 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 EJS for even more customization!

📚 Documentation

^{⚠️ This is the documentation of v3.21-beta (@master/@main branches) which includes unreleased features. See documentation for v3.20 (@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)
• 🏗️ Deploying a web instance (~20 min)
  • ✔️ Create another shared instance
  • ➖ Requires some sysadmin knowlegde
• 🐳 Using command line with docker (~2 min)
  • ✔️ Suited for one-time rendering
• 🔧 Local setup for development (~20 min)

Additional resources for setup:

• 🏦 Configure metrics for organizations
• 🧰 Template/Plugin compatibility matrix

🖼️ Templates

Templates lets you change general appearance of rendered metrics.

• 📗 Classic template _classic
• 📘 Repository template _repository
• 📙 Terminal template _terminal
• 📒 Markdown template _markdown
• 📕 Community templates _community

🧩 Plugins

Plugins provide additional content and lets you customize rendered metrics.

📦 Maintained by core team

• Core plugins
  • 🗃️ Base content _base
  • 🧱 Core _core
• Github plugins
  • 🏆 Achievements _achievements
  • 📰 Recent activity _activity
  • ♐ Code snippet of the day _code
  • 🏅 Repository contributors _contributors
  • 💬 Discussions _discussions
  • 🎟️ Follow-up of issues and pull requests _followup
  • 🎫 Gists _gists
  • 💡 Coding habits _habits
  • 🙋 Introduction _introduction
  • 📅 Isometric commit calendar _isocalendar
  • 🈷️ Most used languages _languages
  • 📜 Repository licenses _licenses
  • 👨‍💻 Lines of code changed _lines
  • 🎩 Notable contributions _notable
  • 🧑‍🤝‍🧑 People plugin _people
  • 🗂️ Active projects _projects
  • 🎭 Comment reactions _reactions
  • 📓 Repositories _repositories
  • 🌇 GitHub Skyline 3D calendar _skyline
  • 💕 GitHub Sponsors _sponsors
  • ✨ Stargazers over last weeks _stargazers
  • 💫 Starlists _starlists
  • 🌟 Recently starred repositories _stars
  • 💭 GitHub Community Support _support
  • 📌 Starred topics _topics
  • 🧮 Repositories traffic _traffic
• Social plugins
  • 🌸 Anilist watch list and reading list _anilist
  • 🎼 Music plugin _music
  • ⏱️ Website performances _pagespeed
  • ✒️ Recent posts _posts
  • 🗼 Rss feed _rss
  • 🗨️ StackOverflow plugin _{stackoverflow}
  • 🐤 Latest tweets _tweets
  • ⏰ WakaTime plugin _wakatime

🎲 Maintained by community

• 🥠 Fortune _fortune by @lowlighter
• 💉 Nightscout _nightscout by @legoandmars
• 💩 PoopMap plugin _poopmap by @matievisthekat
• 📸 Website screenshot _screenshot by @lowlighter
• 💹 Stock prices _stock 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