๐ Metrics ![](https://camo.githubusercontent.com/151e98cd28ddcb757417e99a965e4734ae23007fc7308671ba8e8b794c547f94/68747470733a2f2f6170692e70726f6475637468756e742e636f6d2f776964676574732f656d6265642d696d6167652f76312f66656174757265642e7376673f706f73745f69643d323830313434267468656d653d6461726b)
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.33-beta (@master
/@main
branches) which includes unreleased features planned for next release. See documentation for current released version v3.32 (@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 templaterepository
๐ Terminal templateterminal
๐ Markdown templatemarkdown
๐ Community templatescommunity
๐งฉ Plugins
Plugins provide additional content and lets you customize rendered metrics.
- Core plugins
- GitHub plugins
- ๐ Achievements
achievements
๐ฐ Recent activityactivity
- ๐ Commit calendar
calendar
- โ Random code snippet
code
๐ Repository contributorscontributors
๐ฌ Discussionsdiscussions
๐๏ธ Follow-up of issues and pull requestsfollowup
- ๐ซ Gists
gists
- ๐ก Coding habits and activity
habits
๐ Introductionintroduction
- ๐
Isometric commit calendar
isocalendar
๐ท๏ธ Languages activitylanguages
๐ Repository licenseslicenses
- ๐จโ๐ป Lines of code changed
lines
๐ฉ Notable contributionsnotable
๐งโ๐คโ๐ง Peoplepeople
๐๏ธ GitHub projectsprojects
๐ญ Comment reactionsreactions
๐ Featured repositoriesrepositories
- ๐ GitHub Skyline
skyline
๐ GitHub Sponsorssponsors
๐ GitHub Sponsorshipssponsorships
โจ Stargazersstargazers
๐ซ Star listsstarlists
๐ Recently starred repositoriesstars
๐ญ GitHub Community Supportsupport
โ ๏ธ deprecated
๐ Starred topicstopics
๐งฎ Repositories traffictraffic
- ๐ Achievements
- Social plugins
๐ช Contributing
If you are interested in contributing, the following resources may interest you:
- ๐ช Contribution guide
๐งฌ Architecture๐ LicenseGitHub resources
Use ๐ฌ discussions
for feedback, new features suggestions, bugs reports or to request help for installation.
๐ License
MIT License
Copyright (c) 2020-present lowlighter