ContextQMD
Back to Metrics

๐Ÿ“Š Metrics [](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_source=badge-github-metrics)

README.md

3.3434.1 KB
Original Source

๐Ÿ“Š Metrics

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

<table> <tr> <th align="center">For user accounts</th> <th align="center">For organization accounts</th> </tr> <tr> <td align="center"> </img> </td> <td align="center"> </img> </td> </tr> <tr> <th colspan="2" align="center"> <h3><a href="/README.md#-plugins">๐Ÿงฉ Customizable with 47 plugins and 335 options!</a></h3> </th> </tr> <tr> <th><a href="source/plugins/isocalendar/README.md">๐Ÿ“… Isometric commit calendar</a></th> <th><a href="source/plugins/languages/README.md">๐Ÿˆท๏ธ Languages activity</a></th> </tr> <tr> <td align="center"> <details open><summary>Full year calendar</summary></img></details> <details><summary>Half year calendar</summary></img></details> 
  </td>
    <td  align="center">
    <details open><summary>Indepth analysis (clone and analyze repositories)</summary></img></details>
    <details open><summary>Recently used (analyze recent activity events)</summary></img></details>
    <details><summary>Default algorithm</summary></img></details>
    <details><summary>Default algorithm (with details)</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/stargazers/README.md">โœจ Stargazers</a></th> <th><a href="source/plugins/lines/README.md">๐Ÿ‘จโ€๐Ÿ’ป Lines of code changed</a></th> </tr> <tr> <td align="center"> <details open><summary>Classic charts</summary></img></details> <details><summary>Graph charts</summary></img></details> <details open><summary>Worldmap</summary></img></details> 
  </td>
    <td  align="center">
    <details open><summary>Repositories and diff history</summary></img></details>
    <details><summary>Compact display in base plugin</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/topics/README.md">๐Ÿ“Œ Starred topics</a></th> <th><a href="source/plugins/stars/README.md">๐ŸŒŸ Recently starred repositories</a></th> </tr> <tr> <td align="center"> <details open><summary>With icons</summary></img></details> <details open><summary>With labels</summary></img></details> 
  </td>
    <td  align="center">
    </img>
    
  </td>
</tr> <tr> <th><a href="source/plugins/licenses/README.md">๐Ÿ“œ Repository licenses</a></th> <th><a href="source/plugins/habits/README.md">๐Ÿ’ก Coding habits and activity</a></th> </tr> <tr> <td align="center"> <details open><summary>Permissions, limitations and conditions</summary></img></details> <details open><summary>Licenses overview</summary></img></details> 
  </td>
    <td  align="center">
    <details open><summary>Recent activity charts</summary></img></details>
    <details open><summary>Mildly interesting facts</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/contributors/README.md">๐Ÿ… Repository contributors</a></th> <th><a href="source/plugins/followup/README.md">๐ŸŽŸ๏ธ Follow-up of issues and pull requests</a></th> </tr> <tr> <td align="center"> <details open><summary>By contribution types</summary></img></details> <details><summary>By number of contributions</summary></img></details> 
  </td>
    <td  align="center">
    <details open><summary>Indepth analysis</summary></img></details>
    <details><summary>Created on a user's repositories</summary></img></details>
    <details><summary>Created by a user</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/reactions/README.md">๐ŸŽญ Comment reactions</a></th> <th><a href="source/plugins/people/README.md">๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ People</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    <details open><summary>Related to a user</summary></img></details>
    <details><summary>Related to a repository</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/sponsorships/README.md">๐Ÿ’ GitHub Sponsorships</a></th> <th><a href="source/plugins/sponsors/README.md">๐Ÿ’• GitHub Sponsors</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    <details open><summary>GitHub sponsors card</summary></img></details>
    <details><summary>GitHub sponsors full introduction</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/repositories/README.md">๐Ÿ““ Featured repositories</a></th> <th><a href="source/plugins/discussions/README.md">๐Ÿ’ฌ Discussions</a></th> </tr> <tr> <td align="center"> <details open><summary>Featured</summary></img></details> <details><summary>Pinned</summary></img></details> 
  </td>
    <td  align="center">
    </img>
    
  </td>
</tr> <tr> <th><a href="source/plugins/starlists/README.md">๐Ÿ’ซ Star lists</a></th> <th><a href="source/plugins/calendar/README.md">๐Ÿ“† Commit calendar</a></th> </tr> <tr> <td align="center"> <details open><summary>Repositories from star lists</summary></img></details> <details open><summary>Languages from star lists</summary></img></details> 
  </td>
    <td  align="center">
    <details><summary>Current year</summary></img></details>
    <details open><summary>Full history</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/achievements/README.md">๐Ÿ† Achievements</a></th> <th><a href="source/plugins/notable/README.md">๐ŸŽฉ Notable contributions</a></th> </tr> <tr> <td align="center"> <details open><summary>Compact display</summary></img></details> <details><summary>Detailed display</summary></img></details> 
  </td>
    <td  align="center">
    <details open><summary>Indepth analysis</summary></img></details>
    <details><summary>Contributions in organizations only</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/activity/README.md">๐Ÿ“ฐ Recent activity</a></th> <th><a href="source/plugins/traffic/README.md">๐Ÿงฎ Repositories traffic</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    </img>
    
  </td>
</tr> <tr> <th><a href="source/plugins/code/README.md">โ™ Random code snippet</a></th> <th><a href="source/plugins/gists/README.md">๐ŸŽซ Gists</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    </img>
    
  </td>
</tr> <tr> <th><a href="source/plugins/projects/README.md">๐Ÿ—‚๏ธ GitHub projects</a></th> <th><a href="source/plugins/introduction/README.md">๐Ÿ™‹ Introduction</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    <details open><summary>For a user or an organization</summary></img></details>
    <details><summary>For a repository</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/skyline/README.md">๐ŸŒ‡ GitHub Skyline</a></th> <th><a href="source/plugins/pagespeed/README.md">โฑ๏ธ Google PageSpeed</a></th> </tr> <tr> <td align="center"> <details open><summary>GitHub Skyline</summary></img></details> <details><summary>GitHub City</summary></img></details> 
  </td>
    <td  align="center">
    <details open><summary>PageSpeed scores</summary></img></details>
    <details><summary>PageSpeed scores with detailed report</summary></img></details>
    <details><summary>PageSpeed scores with a website screenshot</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/stackoverflow/README.md">๐Ÿ—จ๏ธ Stack Overflow</a></th> <th><a href="source/plugins/anilist/README.md">๐ŸŒธ Anilist watch list and reading list</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    <details open><summary>For anime watchers</summary></img></details>
    <details><summary>For manga readers</summary></img></details>
    <details open><summary>For waifus simp</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/music/README.md">๐ŸŽผ Music activity and suggestions</a></th> <th><a href="source/plugins/posts/README.md">โœ’๏ธ Recent posts</a></th> </tr> <tr> <td align="center"> <details open><summary>Random tracks from a playlist</summary></img></details> <details open><summary>Recently listened</summary></img></details> 
  </td>
    <td  align="center">
    <details open><summary>Latest posts width description and cover image</summary></img></details>
    <details><summary>Latest posts</summary></img></details>
    
  </td>
</tr> <tr> <th><a href="source/plugins/rss/README.md">๐Ÿ—ผ Rss feed</a></th> <th><a href="source/plugins/wakatime/README.md">โฐ WakaTime</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    </img>
    
  </td>
</tr> <tr> <th><a href="source/plugins/leetcode/README.md">๐Ÿ—ณ๏ธ Leetcode</a></th> <th><a href="source/plugins/steam/README.md">๐Ÿ•น๏ธ Steam</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    <details open><summary>Recently played games</summary></img></details>
    <details><summary>Profile and detailed game history</summary></img></details>
    
  </td>
</tr> <tr> <th colspan="2" align="center"> <a href="/source/plugins/community/README.md">๐ŸŽฒ See also community plugins</a> </th> </tr> <tr> <th><a href="source/plugins/community/16personalities/README.md">๐Ÿง  16personalities</a> <sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup> <details><summary>Render example</summary> </img> 
  </details>
</th>
<th><a href="source/plugins/community/chess/README.md">โ™Ÿ๏ธ Chess</a>

<sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup> <details><summary>Render example</summary> </img>

  </details>
</th>
</tr> <tr> <th><a href="source/plugins/community/crypto/README.md">๐Ÿช™ Crypto</a> <sup>by <a href="https://github.com/dajneem23">@dajneem23</a></sup> <details><summary>Render example</summary> </img> 
  </details>
</th>
<th><a href="source/plugins/community/fortune/README.md">๐Ÿฅ  Fortune</a>

<sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup> <details><summary>Render example</summary> </img>

  </details>
</th>
</tr> <tr> <th><a href="source/plugins/community/nightscout/README.md">๐Ÿ’‰ Nightscout</a> <sup>by <a href="https://github.com/legoandmars">@legoandmars</a></sup> <details><summary>Render example</summary> </img> 
  </details>
</th>
<th><a href="source/plugins/community/poopmap/README.md">๐Ÿ’ฉ PoopMap plugin</a>

<sup>by <a href="https://github.com/matievisthekat">@matievisthekat</a></sup> <details><summary>Render example</summary> </img>

  </details>
</th>
</tr> <tr> <th><a href="source/plugins/community/screenshot/README.md">๐Ÿ“ธ Website screenshot</a> <sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup> <details><summary>Render example</summary> </img> 
  </details>
</th>
<th><a href="source/plugins/community/splatoon/README.md">๐Ÿฆ‘ Splatoon</a>

<sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup> <details><summary>Render example</summary> </img>

  </details>
</th>
</tr> <tr> <th><a href="source/plugins/community/stock/README.md">๐Ÿ’น Stock prices</a> <sup>by <a href="https://github.com/lowlighter">@lowlighter</a></sup> <details><summary>Render example</summary> </img> 
  </details>
</th>
<th>
</th>
</tr> <tr> <th colspan="2" align="center"> <h3><a href="/README.md#%EF%B8%8F-templates">๐Ÿ–ผ๏ธ And even more with 4+ templates!</a></h3> </th> </tr> <tr> <th><a href="/source/templates/classic/README.md">๐Ÿ“— Classic template</a></th> <th><a href="/source/templates/repository/README.md">๐Ÿ“˜ Repository template</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    </img>
    
  </td>
</tr> <tr> <th><a href="/source/templates/terminal/README.md">๐Ÿ“™ Terminal template</a></th> <th><a href="/source/templates/markdown/README.md">๐Ÿ“’ Markdown template</a></th> </tr> <tr> <td align="center"> </img> 
  </td>
    <td  align="center">
    </img>
    
  </td>
</tr> <tr> <th colspan="2"><a href="/source/templates/community/README.md">๐Ÿ“• See also community templates</a></th> </tr> <tr> <th colspan="2"><h2>๐Ÿฆ‘ Try it now!</h2></th> </tr> <tr> <th><a href="https://metrics.lecoq.io/embed">๐Ÿ“Š Metrics embed</a></th> <th><a href="https://metrics.lecoq.io/insights">โœจ Metrics insights</a></th> </tr> <tr> <td align="center"> Embed metrics images on your profile or blog! 
  Use <a href="https://github.com/marketplace/actions/metrics-embed">GitHub actions</a> for even more features!

  
</td>
<td align="center">
  Share your metrics with friends and on social medias!

  No configuration needed!

  
</td>
</tr> <tr> <td align="center" colspan="2"> Test latest features and patches on <code><a href="https://beta-metrics.lecoq.io">๐Ÿงช Metrics beta</a></code>! </td> </tr> <tr> <td align="center" colspan="2"> <b>Power user?</b> 
  <a href="https://github.com/lowlighter/metrics/fork">Fork this repository</a> and edit HTML, CSS, JS and <a href="https://github.com/mde/ejs">EJS</a> for even more customization!
</td>
</tr> </table>

๐Ÿ“š Documentation

<sup>โš ๏ธ 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. </sup>

๐Ÿฆฎ Setup

There are several ways to setup metrics, each having its advantages and disadvantages:

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

๐Ÿ’ช 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