Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
โ ๏ธ This is the documentation of v3.35-beta (@master/@mainbranches) which includes unreleased features planned for next release. See documentation for current released version v3.34 (@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 - ๐ 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
- ๐ธ Anilist watch list and reading list
anilist - ๐ณ๏ธ Leetcode
leetcode - ๐ผ Music activity and suggestions
music - โฑ๏ธ Google PageSpeed
pagespeed - โ๏ธ Recent posts
posts - ๐ผ Rss feed
rss - ๐จ๏ธ Stack Overflow
stackoverflow - ๐น๏ธ Steam
steam - ๐ค Latest tweets
tweetsโ ๏ธ deprecated - โฐ WakaTime
wakatime
- ๐ธ Anilist watch list and reading list
๐ฒ Maintained by community
- Community plugins
- ๐ง 16personalities
16personalitiesby @lowlighter - โ๏ธ Chess
chessby @lowlighter - ๐ช Crypto
cryptoby @dajneem23 - ๐ฅ Fortune
fortuneby @lowlighter - ๐ Nightscout
nightscoutby @legoandmars - ๐ฉ PoopMap plugin
poopmapby @matievisthekat - ๐ธ Website screenshot
screenshotby @lowlighter - ๐ฆ Splatoon
splatoonby @lowlighter - ๐น Stock prices
stockby @lowlighter
- ๐ง 16personalities
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


