๐ Metrics 
Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
๐ Documentation
โ ๏ธ This is the documentation of v3.30-beta (@master/@mainbranches) which includes unreleased features planned for next release. See documentation for current released version v3.29 (@latestbranch) 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 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


