Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
| For user accounts | For organization accounts |
|---|---|
|
|
| 📅 Isometric commit calendar | 🈷️ Languages activity |
Full year calendar Half year calendar |
Indepth analysis (clone and analyze repositories) Recently used (analyze recent activity events) Default algorithm Default algorithm (with details) |
| ✨ Stargazers | 👨💻 Lines of code changed |
Classic charts Chartist charts Worldmap |
Repositories and diff history Compact display in base plugin |
| 📌 Starred topics | 🌟 Recently starred repositories |
With icons With labels |
|
| 📜 Repository licenses | 💡 Coding habits and activity |
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 a user's repositories Created by a user |
| 🎭 Comment reactions | 🧑🤝🧑 People |
|
Related to a user Related to a repository |
| 🙋 Introduction | 💕 GitHub Sponsors |
For a user or an organization For a repository |
GitHub sponsors card GitHub sponsors full introduction |
| 📓 Featured repositories | 💬 Discussions |
Featured Pinned |
|
| 💫 Star lists | 📆 Commit calendar |
Repositories from star lists Languages from star lists |
Current year Full history |
| 🏆 Achievements | 🎩 Notable contributions |
Compact display Detailed display |
Indepth analysis Contributions in organizations only |
| 📰 Recent activity | 🧮 Repositories traffic |
|
|
| ♐ Random code snippet | 🎫 Gists |
|
|
| 🗂️ GitHub projects | 🌇 GitHub Skyline |
|
GitHub Skyline GitHub City |
| ⏱️ Google PageSpeed | 🐤 Latest tweets |
PageSpeed scores PageSpeed scores with detailed report PageSpeed scores with a website screenshot |
Latest tweets with attachments Latest tweets |
| 🗨️ Stack Overflow | 🌸 Anilist watch list and reading list |
|
For anime watchers For manga readers For waifus simp |
| 🎼 Music activity and suggestions | ✒️ Recent posts |
Random tracks from a playlist Recently listened |
Latest posts width description and cover image Latest posts |
| 🗼 Rss feed | ⏰ WakaTime |
|
|
| 🎲 See also community plugins | |
| 📗 Classic template | 📘 Repository template |
|
|
|
| 📙 Terminal template | 📒 Markdown template |
|
|
| 📕 See also community templates | |
| 📊 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! |
|
⚠️ This is the documentation of v3.27-beta (@master/@mainbranches) which includes unreleased features planned for next release. See documentation for current released version v3.26 (@latestbranch) here.
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 knowledge
- 🐳 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
- 🏠 Run metrics on self-hosted runners
- 🧰 Template/Plugin compatibility matrix
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 provide additional content and lets you customize rendered metrics.
📦 Maintained by core team
- Core plugins
- Github plugins
- 🏆 Achievements
achievements - 📰 Recent activity
activity - 📆 Commit calendar
calendar - ♐ Random code snippet
code - 🏅 Repository contributors
contributors - 💬 Discussions
discussions - 🎟️ Follow-up of issues and pull requests
followup - 🎫 Gists
gists - 💡 Coding habits and activity
habits - 🙋 Introduction
introduction - 📅 Isometric commit calendar
isocalendar - 🈷️ Languages activity
languages - 📜 Repository licenses
licenses - 👨💻 Lines of code changed
lines - 🎩 Notable contributions
notable - 🧑🤝🧑 People
people - 🗂️ GitHub projects
projects - 🎭 Comment reactions
reactions - 📓 Featured repositories
repositories - 🌇 GitHub Skyline
skyline - 💕 GitHub Sponsors
sponsors - ✨ Stargazers
stargazers - 💫 Star lists
starlists - 🌟 Recently starred repositories
stars - 💭 GitHub Community Support
support⚠️ deprecated - 📌 Starred topics
topics - 🧮 Repositories traffic
traffic
- 🏆 Achievements
- Social plugins
🎲 Maintained by community
If you are interested in contributing, the following resources may interest you:
- 💪 Contribution guide
- 🧬 Architecture
- 📜 License
GitHub resources
Use 💬 discussions for feedback, new features suggestions, bugs reports or to request help for installation.
MIT License
Copyright (c) 2020-present lowlighter
