Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
⚠️ This is the documentation of v3.25-beta (@master
/@main
branches) which includes unreleased features planned for next release. See documentation for current released version v3.24 (@latest
branch) 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
- 📆 Calendar
calendar
- ♐ 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
- 🏆 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