![]() |
2 months ago | |
---|---|---|
.github | 2 months ago | |
source | 2 months ago | |
tests | 2 months ago | |
.dockerignore | 3 years ago | |
.editorconfig | 2 years ago | |
.gitattributes | 6 months ago | |
.gitignore | 1 year ago | |
ARCHITECTURE.md | 3 months ago | |
CODE_OF_CONDUCT.md | 10 months ago | |
CONTRIBUTING.md | 10 months ago | |
Dockerfile | 7 months ago | |
LICENSE | 2 years ago | |
README.md | 2 months ago | |
SECURITY.md | 2 years ago | |
action.yml | 3 months ago | |
package-lock.json | 2 months ago | |
package.json | 2 months ago | |
settings.example.json | 3 months ago | |
vercel.json | 10 months ago |
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 46 plugins and 329 options! |
|
📅 Isometric commit calendar | 🈷️ Languages activity |
Full year calendarHalf year calendar |
Indepth analysis (clone and analyze repositories)Recently used (analyze recent activity events)Default algorithmDefault algorithm (with details) |
✨ Stargazers | 👨💻 Lines of code changed |
Classic chartsGraph chartsWorldmap |
Repositories and diff historyCompact display in base plugin |
📌 Starred topics | 🌟 Recently starred repositories |
With iconsWith labels |
|
📜 Repository licenses | 💡 Coding habits and activity |
Permissions, limitations and conditionsLicenses overview |
Recent activity chartsMildly interesting facts |
🏅 Repository contributors | 🎟️ Follow-up of issues and pull requests |
By contribution typesBy number of contributions |
Indepth analysisCreated on a user's repositoriesCreated by a user |
🎭 Comment reactions | 🧑🤝🧑 People |
|
Related to a userRelated to a repository |
💝 GitHub Sponsorships | 💕 GitHub Sponsors |
|
GitHub sponsors cardGitHub sponsors full introduction |
📓 Featured repositories | 💬 Discussions |
FeaturedPinned |
|
💫 Star lists | 📆 Commit calendar |
Repositories from star listsLanguages from star lists |
Current yearFull history |
🏆 Achievements | 🎩 Notable contributions |
Compact displayDetailed display |
Indepth analysisContributions in organizations only |
📰 Recent activity | 🧮 Repositories traffic |
|
|
♐ Random code snippet | 🎫 Gists |
|
|
🗂️ GitHub projects | 🙋 Introduction |
|
For a user or an organizationFor a repository |
🌇 GitHub Skyline | ⏱️ Google PageSpeed |
GitHub SkylineGitHub City |
PageSpeed scoresPageSpeed scores with detailed reportPageSpeed scores with a website screenshot |
🐤 Latest tweets | 🗨️ Stack Overflow |
Latest tweets with attachmentsLatest tweets |
|
🌸 Anilist watch list and reading list | 🎼 Music activity and suggestions |
For anime watchersFor manga readersFor waifus simp |
Random tracks from a playlistRecently listened |
✒️ Recent posts | 🗼 Rss feed |
Latest posts width description and cover imageLatest posts |
|
⏰ WakaTime | 🗳️ Leetcode |
|
|
🕹️ Steam | |
Recently played gamesProfile and detailed game history |
|
🎲 See also community plugins | |
🧠 16personalities by @lowlighter Render example |
♟️ Chess by @lowlighter Render example |
🥠 Fortune by @lowlighter Render example |
💉 Nightscout by @legoandmars Render example |
💩 PoopMap plugin by @matievisthekat Render example |
📸 Website screenshot by @lowlighter Render example |
🦑 Splatoon by @lowlighter Render example |
💹 Stock prices by @lowlighter Render example |
🖼️ 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! ![]() |
Test latest features and patches on 🧪 Metrics beta !
|
|
Power user? Fork this repository and edit HTML, CSS, JS and EJS for even more customization! |
📚 Documentation
⚠️ This is the documentation of v3.34-beta (
@master
/@main
branches) which includes unreleased features planned for next release. See documentation for current released version v3.33 (@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 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
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
- 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
- 💝 GitHub Sponsorships
sponsorships
- ✨ 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
- Community plugins
- 🧠 16personalities
16personalities
by @lowlighter - ♟️ Chess
chess
by @lowlighter - 🥠 Fortune
fortune
by @lowlighter - 💉 Nightscout
nightscout
by @legoandmars - 💩 PoopMap plugin
poopmap
by @matievisthekat - 📸 Website screenshot
screenshot
by @lowlighter - 🦑 Splatoon
splatoon
by @lowlighter - 💹 Stock prices
stock
by @lowlighter
- 🧠 16personalities
💪 Contributing
If you are interested in contributing, the following resources may interest you:
- 💪 Contribution guide
- 🧬 Architecture
- 📜 License
- :octocat: GitHub resources
Use 💬 discussions
for feedback, new features suggestions, bugs reports or to request help for installation.
📜 License
MIT License
Copyright (c) 2020-present lowlighter