Repository files navigation

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! UseGitHub 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 andEJS for even more customization!

^{⚠️ This is the documentation ofv3.35-beta (@master/@main branches) which includesunreleased features planned for next release. See documentation for current released versionv3.34 (@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)
• 🏗️ 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 lets you change general appearance of rendered metrics.

• 📗 Classic template_classic
• 📘 Repository template_repository
• 📙 Terminal template_terminal
• 📒 Markdown template_markdown
• 📕 Community templates_community

Plugins provide additional content and lets you customize rendered metrics.

📦 Maintained by core team

• Core plugins
  • 🗃️ Base content_base
  • 🧱 Core_core
• GitHub plugins
  • 🏆 Achievements_achievements
  • 📰 Recent activity_activity
  • 📆 Commit calendar_calendar
  • ♐ Random code snippet_code
  • 🏅 Repository contributors_contributors
  • 💬 Discussions_discussions
  • 🎟️ Follow-up of issues and pull requests_followup
  • 🎫 Gists_gists
  • 💡 Coding habits and activity_habits
  • 🙋 Introduction_introduction
  • 📅 Isometric commit calendar_isocalendar
  • 🈷️ Languages activity_languages
  • 📜 Repository licenses_licenses
  • 👨‍💻 Lines of code changed_lines
  • 🎩 Notable contributions_notable
  • 🧑‍🤝‍🧑 People_people
  • 🗂️ GitHub projects_projects
  • 🎭 Comment reactions_reactions
  • 📓 Featured repositories_repositories
  • 🌇 GitHub Skyline_skyline
  • 💕 GitHub Sponsors_sponsors
  • 💝 GitHub Sponsorships_sponsorships
  • ✨ Stargazers_stargazers
  • 💫 Star lists_starlists
  • 🌟 Recently starred repositories_stars
  • 💭 GitHub Community Support_{support⚠️ deprecated}
  • 📌 Starred topics_topics
  • 🧮 Repositories traffic_traffic
• Social plugins
  • 🌸 Anilist watch list and reading list_anilist
  • 🗳️ Leetcode_leetcode
  • 🎼 Music activity and suggestions_music
  • ⏱️ Google PageSpeed_pagespeed
  • ✒️ Recent posts_posts
  • 🗼 Rss feed_rss
  • 🗨️ Stack Overflow_{stackoverflow}
  • 🕹️ Steam_steam
  • 🐤 Latest tweets_{tweets⚠️ deprecated}
  • ⏰ WakaTime_wakatime

🎲 Maintained by community

• Community plugins
  • 🧠 16personalities_{16personalities} by@lowlighter
  • ♟️ Chess_chess by@lowlighter
  • 🪙 Crypto_crypto by@dajneem23
  • 🥠 Fortune_fortune by@lowlighter
  • 💉 Nightscout_nightscout by@legoandmars
  • 💩 PoopMap plugin_poopmap by@matievisthekat
  • 📸 Website screenshot_screenshot by@lowlighter
  • 🦑 Splatoon_splatoon by@lowlighter
  • 💹 Stock prices_stock by@lowlighter

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

• 💪 Contribution guide
• 🧬 Architecture
• 📜 License
• GitHub resources
  • 📖 GitHub GraphQL API
  • 📖 GitHub GraphQL Explorer
  • 📖 GitHub Rest API
  • 📖 GitHub Octicons

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

MIT LicenseCopyright (c) 2020-present lowlighter