Generate metrics that can be embedded everywhere, including your GitHub profile readme! For users, organizations, and even repositories!
โ ๏ธ This is the documentation of v3.18-beta (@master
/@main
branches) which includes unreleased features. See documentation for v3.17 (@latest
branch) 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)
- ๐ณ Using command line with docker (~5 min) (documentation not available yet)
- โ๏ธ Suited for one-time rendering
- ๐๏ธ Deploying your own web instance (~20 min)
- โ Mostly intended for development, or to create another shared instance
Additional resources for setup:
- ๐ฆ Configuring metrics for organizations
- ๐งฐ Template/Plugin compatibility matrix (documentation not available yet)
Templates lets you change general appearance of rendered metrics.
- ๐ Classic template
- ๐ Repository template
- ๐ Terminal template
- ๐ Markdown template
- ๐ Community templates
Plugins provide additional content and lets you customize your rendered metrics.
๐ฆ Maintained by core team
- Core
- Github
- ๐ Achievements
- ๐ฐ Recent activity
- โ Code snippet of the day
- ๐ Repository contributors
- ๐ฌ Discussions
- ๐๏ธ Follow-up of issues and pull requests
- ๐ซ Gists
- ๐ก Coding habits
- ๐ Introduction
- ๐ Isometric commit calendar
- ๐ท๏ธ Most used languages
- ๐ Repository licenses
- ๐จโ๐ป Lines of code changed
- ๐ฉ Notable contributions
- ๐งโ๐คโ๐ง People plugin
- ๐๏ธ Active projects
- ๐ญ Comment reactions
- ๐ Repositories
- ๐ GitHub Skyline 3D calendar
- ๐ GitHub Sponsors
- โจ Stargazers over last weeks
- ๐ซ Starlists
- ๐ Recently starred repositories
- ๐ญ GitHub Community Support
- ๐ Starred topics
- ๐งฎ Repositories traffic
- Social
- ๐ Nightscout by @legoandmars
- ๐ฉ PoopMap plugin by @matievisthekat
- ๐ธ Website screenshot by @lowlighter
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