📊 An infographics generator with 30+ plugins and 200+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON!

starred-repo javascript github github-action automation readme github-profile profile github-api readme-generator starred-lowlighter-repo svg-image readme-profile profile-readme profile-card metrics github-metrics automated

Go to file

github-actions[bot] a53a5853a9 chore: code formatting		3 weeks ago
.github	chore(deps): disable npm dependabot as v4 won't use npm anymore	1 month ago
source	chore: code formatting	3 weeks ago
tests	chore: rebuild files	3 weeks ago
.dockerignore	Use a docker image to support puppeteer (#7 )	3 years ago
.editorconfig	Create .editorconfig	3 years ago
.gitattributes	chore: update .gitattributes	1 year ago
.gitignore	Update .gitignore	3 weeks ago
ARCHITECTURE.md	chore(deps): migrate from chartist to d3 (closes #1142 )	9 months ago
CODE_OF_CONDUCT.md	fix(docs): lot of misspelling (#1180 ) [skip ci]	1 year ago
CONTRIBUTING.md	fix(docs): lot of misspelling (#1180 ) [skip ci]	1 year ago
Dockerfile	chore: upgrade to node 20	4 months ago
LICENSE	Update LICENSE.md	3 years ago
README.md	chore: rebuild files	3 weeks ago
SECURITY.md	chore(repo): update labels	2 years ago
action.yml	chore: rebuild files	3 weeks ago
package-lock.json	chore(deps): upgrade marked (cannot do it to 8.0.0 because of deprecated options still used)	3 months ago
package.json	chore(deps): upgrade marked (cannot do it to 8.0.0 because of deprecated options still used)	3 months ago
settings.example.json	chore: rebuild files	3 weeks ago
vercel.json	fix(ci): vercel (#1165 )	1 year ago

README.md

Unescape Escape

📊 Metrics

Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!

For user accounts	For organization accounts

🧩 Customizable with 47 plugins and 335 options!
📅 Isometric commit calendar	🈷️ Languages activity
Full year calendar Half year calendar	Indepth analysis (clone and analyze repositories) Recently used (analyze recent activity events) Default algorithm Default algorithm (with details)
✨ Stargazers	👨‍💻 Lines of code changed
Classic charts Graph charts Worldmap	Repositories and diff history Compact display in base plugin
📌 Starred topics	🌟 Recently starred repositories
With icons With labels
📜 Repository licenses	💡 Coding habits and activity
Permissions, limitations and conditions Licenses overview	Recent activity charts Mildly interesting facts
🏅 Repository contributors	🎟️ Follow-up of issues and pull requests
By contribution types By number of contributions	Indepth analysis Created on a user's repositories Created by a user
🎭 Comment reactions	🧑‍🤝‍🧑 People
	Related to a user Related to a repository
💝 GitHub Sponsorships	💕 GitHub Sponsors
	GitHub sponsors card GitHub sponsors full introduction
📓 Featured repositories	💬 Discussions
Featured Pinned
💫 Star lists	📆 Commit calendar
Repositories from star lists Languages from star lists	Current year Full history
🏆 Achievements	🎩 Notable contributions
Compact display Detailed display	Indepth analysis Contributions in organizations only
📰 Recent activity	🧮 Repositories traffic

♐ Random code snippet	🎫 Gists

🗂️ GitHub projects	🙋 Introduction
	For a user or an organization For a repository
🌇 GitHub Skyline	⏱️ Google PageSpeed
GitHub Skyline GitHub City	PageSpeed scores PageSpeed scores with detailed report PageSpeed scores with a website screenshot
🗨️ Stack Overflow	🌸 Anilist watch list and reading list
	For anime watchers For manga readers For waifus simp
🎼 Music activity and suggestions	✒️ Recent posts
Random tracks from a playlist Recently listened	Latest posts width description and cover image Latest posts
🗼 Rss feed	⏰ WakaTime

🗳️ Leetcode	🕹️ Steam
	Recently played games Profile and detailed game history
🎲 See also community plugins
🧠 16personalities ^{by @lowlighter} Render example	♟️ Chess ^{by @lowlighter} Render example
🪙 Crypto ^{by @dajneem23} Render example	🥠 Fortune ^{by @lowlighter} Render example
💉 Nightscout ^{by @legoandmars} Render example	💩 PoopMap plugin ^{by @matievisthekat} Render example
📸 Website screenshot ^{by @lowlighter} Render example	🦑 Splatoon ^{by @lowlighter} Render example
💹 Stock prices ^{by @lowlighter} Render example
🖼️ And even more with 4+ templates!
📗 Classic template	📘 Repository template

📙 Terminal template	📒 Markdown template

📕 See also community templates
🦑 Try it now!
📊 Metrics embed	✨ Metrics insights
Embed metrics images on your profile or blog! Use GitHub actions for even more features!	Share your metrics with friends and on social medias! No configuration needed!
Test latest features and patches on `🧪 Metrics beta`!
Power user? Fork this repository and edit HTML, CSS, JS and EJS for even more customization!

📚 Documentation

^{⚠️ This is the documentation of v3.35-beta (@master/@main branches) which includes unreleased features planned for next release. See documentation for current released version v3.34 (@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:

🖼️ Templates

Templates lets you change general appearance of rendered metrics.

🧩 Plugins

Plugins provide additional content and lets you customize rendered metrics.

📦 Maintained by core team

🎲 Maintained by community

Community plugins

💪 Contributing

If you are interested in contributing, the following resources may interest you:

Use 💬 discussions for feedback, new features suggestions, bugs reports or to request help for installation.

📜 License

MIT License
Copyright (c) 2020-present lowlighter

README.md Unescape Escape