๐ Metrics
Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
๐ Documentation
๐ฆฎ 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 templateclassic
๐ Repository templaterepository
๐ Terminal templateterminal
๐ Markdown templatemarkdown
๐ Community templatescommunity
๐งฉ Plugins
Plugins provide additional content and lets you customize rendered metrics.
- Core plugins
- GitHub plugins
๐ Achievementsachievements
๐ฐ Recent activityactivity
๐ Commit calendarcalendar
โ Random code snippetcode
๐ Repository contributorscontributors
๐ฌ Discussionsdiscussions
๐๏ธ Follow-up of issues and pull requestsfollowup
๐ซ Gistsgists
๐ก Coding habits and activityhabits
๐ Introductionintroduction
๐ Isometric commit calendarisocalendar
๐ท๏ธ Languages activitylanguages
๐ Repository licenseslicenses
๐จโ๐ป Lines of code changedlines
๐ฉ Notable contributionsnotable
๐งโ๐คโ๐ง Peoplepeople
๐๏ธ GitHub projectsprojects
๐ญ Comment reactionsreactions
๐ Featured repositoriesrepositories
๐ GitHub Skylineskyline
๐ GitHub Sponsorssponsors
โจ Stargazersstargazers
๐ซ Star listsstarlists
๐ Recently starred repositoriesstars
๐ญ GitHub Community Supportsupport
โ ๏ธ deprecated
๐ Starred topicstopics
๐งฎ Repositories traffictraffic
- Social plugins
๐ช Contributing
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.
๐ License
MIT License
Copyright (c) 2020-present lowlighter