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.23-beta (@master
/@main
branches) which includes unreleased features. See documentation for v3.22 (@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 knowlegde
- ๐ณ Using command line with docker (~2 min)
- โ๏ธ Suited for one-time rendering
- ๐ง Local setup for development (~20 min)
Additional resources for setup:
๐ผ๏ธ Templates
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
Plugins provide additional content and lets you customize rendered metrics.
๐ฆ Maintained by core team
- Core plugins
- Github plugins
- ๐ Achievements
achievements
- ๐ฐ Recent activity
activity
- โ Code snippet of the day
code
- ๐
Repository contributors
contributors
- ๐ฌ Discussions
discussions
- ๐๏ธ Follow-up of issues and pull requests
followup
- ๐ซ Gists
gists
- ๐ก Coding habits
habits
- ๐ Introduction
introduction
- ๐
Isometric commit calendar
isocalendar
- ๐ท๏ธ Most used languages
languages
- ๐ Repository licenses
licenses
- ๐จโ๐ป Lines of code changed
lines
- ๐ฉ Notable contributions
notable
- ๐งโ๐คโ๐ง People plugin
people
- ๐๏ธ Active projects
projects
- ๐ญ Comment reactions
reactions
- ๐ Repositories
repositories
- ๐ GitHub Skyline 3D calendar
skyline
- ๐ GitHub Sponsors
sponsors
- โจ Stargazers over last weeks
stargazers
- ๐ซ Starlists
starlists
- ๐ Recently starred repositories
stars
- ๐ญ GitHub Community Support
support
- ๐ Starred topics
topics
- ๐งฎ Repositories traffic
traffic
- ๐ Achievements
- Social plugins
๐ฒ Maintained by community
- ๐ฅ Fortune
fortune
by @lowlighter - ๐ Nightscout
nightscout
by @legoandmars - ๐ฉ PoopMap plugin
poopmap
by @matievisthekat - ๐ธ Website screenshot
screenshot
by @lowlighter - ๐น Stock prices
stock
by @lowlighter
๐ช 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