560 lines
26 KiB
Markdown
560 lines
26 KiB
Markdown
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-metrics)
|
||
|
||
[](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml) [](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml)
|
||
|
||
Generate metrics that can be embedded everywhere, including your GitHub profile readme! For 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 alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.organization.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th colspan="2" align="center">
|
||
<h3><a href="/source/plugins/README.md">🧩 Customizable with 38 plugins and 234 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">🈷️ Most used languages</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<details open><summary>Full year isometric calendar</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg">
|
||
</details>
|
||
<details><summary>Half year isometric calendar</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>Indepth analysis (clone and analyze repositories)</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.indepth.svg">
|
||
</details>
|
||
<details open><summary>Recently used (analyze recent activity events)</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.recent.svg">
|
||
</details>
|
||
<details><summary>Default algorithm</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg">
|
||
</details>
|
||
<details><summary>Default algorithm (with details)</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</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 alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.icons.svg">
|
||
</details>
|
||
<details open><summary>With labels</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stars.svg">
|
||
<img width="900" height="1" alt="">
|
||
</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</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<details open><summary>Permissions, limitations and conditions</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.licenses.svg">
|
||
</details>
|
||
<details open><summary>Licenses overview</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.licenses.ratio.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>Recent activity charts</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.habits.charts.svg">
|
||
</details>
|
||
<details open><summary>Midly interesting facts</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.habits.facts.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</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 alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.categories.svg">
|
||
</details>
|
||
<details><summary>By number of contributions</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.contributions.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>Indepth analysis</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.indepth.svg">
|
||
</details>
|
||
<details><summary>Created on an user's repositories</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.svg">
|
||
</details>
|
||
<details><summary>Created by an user</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.user.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/reactions/README.md">🎭 Comment reactions</a></th>
|
||
<th><a href="source/plugins/people/README.md">🧑🤝🧑 People plugin</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.reactions.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>Related to an user</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.followers.svg">
|
||
</details>
|
||
<details><summary>Related to a repository</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.repository.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/stargazers/README.md">✨ Stargazers over last weeks</a></th>
|
||
<th><a href="source/plugins/projects/README.md">🗂️ Active projects</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stargazers.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.projects.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/code/README.md">♐ Code snippet of the day</a></th>
|
||
<th><a href="source/plugins/activity/README.md">📰 Recent activity</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.code.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.activity.svg">
|
||
<img width="900" height="1" alt="">
|
||
</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 alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.achievements.compact.svg">
|
||
</details>
|
||
<details><summary>Detailed display</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.achievements.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>Indepth analysis</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.indepth.svg">
|
||
</details>
|
||
<details><summary>Contributions in organizations only</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.notable.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/discussions/README.md">💬 Discussions</a></th>
|
||
<th><a href="source/plugins/support/README.md">💭 GitHub Community Support</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.discussions.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.support.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/lines/README.md">👨💻 Lines of code changed</a></th>
|
||
<th><a href="source/plugins/traffic/README.md">🧮 Repositories traffic</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.lines.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.traffic.svg">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/repositories/README.md">📓 Repositories</a></th>
|
||
<th><a href="source/plugins/gists/README.md">🎫 Gists</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.repositories.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.gists.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/introduction/README.md">🙋 Introduction</a></th>
|
||
<th><a href="source/plugins/sponsors/README.md">💕 GitHub Sponsors</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<details open><summary>For an user or an organization</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.svg">
|
||
</details>
|
||
<details><summary>For a repository</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.introduction.repository.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>GitHub sponsors card</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.sponsors.svg">
|
||
</details>
|
||
<details><summary>GitHub sponsors full introduction</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.sponsors.full.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/starlists/README.md">💫 Starlists</a></th>
|
||
<th><a href="source/plugins/skyline/README.md">🌇 GitHub Skyline 3D calendar</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.starlists.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.skyline.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/pagespeed/README.md">⏱️ Website performances</a></th>
|
||
<th><a href="source/plugins/music/README.md">🎼 Music plugin</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<details open><summary>PageSpeed scores</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.svg">
|
||
</details>
|
||
<details><summary>PageSpeed scores with detailed report</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.detailed.svg">
|
||
</details>
|
||
<details><summary>PageSpeed scores with a website screenshot</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.screenshot.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>Random tracks from a playlist</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.music.playlist.svg">
|
||
</details>
|
||
<details open><summary>Recently listened</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.music.recent.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/stackoverflow/README.md">🗨️ Stackoverflow plugin</a></th>
|
||
<th><a href="source/plugins/anilist/README.md">🌸 Anilist watch list and reading list</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stackoverflow.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>For anime watchers</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.svg">
|
||
</details>
|
||
<details><summary>For manga readers</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.manga.svg">
|
||
</details>
|
||
<details open><summary>Favorites characters</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.characters.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/tweets/README.md">🐤 Latest tweets</a></th>
|
||
<th><a href="source/plugins/posts/README.md">✒️ Recent posts</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<details open><summary>Latest tweets</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.svg">
|
||
</details>
|
||
<details><summary>Latest tweets with attachments</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.attachments.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<details open><summary>Latest posts</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.svg">
|
||
</details>
|
||
<details><summary>Latest posts width description and cover image</summary>
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.full.svg">
|
||
</details>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/rss/README.md">🗼 Rss feed</a></th>
|
||
<th><a href="source/plugins/wakatime/README.md">⏰ WakaTime plugin</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.rss.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.wakatime.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="source/plugins/stock/README.md">💹 Stock prices</a></th>
|
||
<th></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stock.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center"><img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<th colspan="2" align="center">
|
||
<a href="/#-plugins">🎲 See also community plugins</a>
|
||
</th>
|
||
</tr>
|
||
|
||
<tr>
|
||
<th colspan="2" align="center">
|
||
<h3><a href="/source/templates/README.md">🖼️ 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 alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg" alt=""></img>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.repository.svg" alt=""></img>
|
||
<img width="900" height="1" alt="">
|
||
</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 alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.terminal.svg" alt=""></img>
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
<td align="center">
|
||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.markdown.png" alt=""></img>
|
||
<img width="900" height="1" alt="">
|
||
</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">📊 Metrics embed</a></th>
|
||
<th><a href="https://metrics.lecoq.io/about">✨ Metrics insights</a></th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
Embed metrics images on your profile or blog!<br>
|
||
Use <a href="https://github.com/marketplace/actions/metrics-embed">GitHub actions</a> for even more features!<br>
|
||
<img src="/.github/readme/imgs/features_embed.gif" width="441">
|
||
</td>
|
||
<td align="center">
|
||
Share your metrics with friends and on social medias!<br>
|
||
No configuration needed!<br>
|
||
<img src="/.github/readme/imgs/features_insights.gif" width="441">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center" colspan="2">
|
||
<b>Power user?</b><br>
|
||
<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"> for even more customization!
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
# 📚 Documentation
|
||
|
||
|
||
> <sup>*⚠️ This is the documentation of **v3.18-beta** (`@master`/`@main` branches) which includes [unreleased features](https://github.com/lowlighter/metrics/compare/latest...master). See documentation for [**v3.17** (`@latest` branch) here](https://github.com/lowlighter/metrics/blob/latest/README.md).*</sup>
|
||
|
||
|
||
|
||
## 🦮 Setup
|
||
|
||
There are several ways to setup metrics, each having its advantages and disadvantages:
|
||
|
||
* [⚙️ Using GitHub Action on a profile repository *(~10 min)*](/.github/readme/partials/documentation/setup/action.md)
|
||
* ✔️ All features
|
||
* ✔️ High availability (no downtimes)
|
||
* ➖ Configuration can be a bit time-consuming
|
||
* [💕 Using the shared instance *(~1 min)*](/.github/readme/partials/documentation/setup/shared.md)
|
||
* ✔️ 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)*](/.github/readme/partials/documentation/setup/web.md)
|
||
* ➖ Mostly intended for development, or to create another shared instance
|
||
|
||
Additional resources for setup:
|
||
* [🏦 Configuring metrics for organizations](/.github/readme/partials/documentation/organizations.md)
|
||
* 🧰 Template/Plugin compatibility matrix *(documentation not available yet)*
|
||
## 🖼️ Templates
|
||
|
||
Templates lets you change general appearance of rendered metrics.
|
||
|
||
|
||
* [📗 Classic template](/source/templates/classic/README.md)
|
||
* [📘 Repository template](/source/templates/repository/README.md)
|
||
* [📙 Terminal template](/source/templates/terminal/README.md)
|
||
* [📒 Markdown template](/source/templates/markdown/README.md)
|
||
* [📕 Community templates](/source/templates/community/README.md)
|
||
|
||
## 🧩 Plugins
|
||
|
||
Plugins provide additional content and lets you customize your rendered metrics.
|
||
|
||
**📦 Maintained by core team**
|
||
|
||
* **Core**
|
||
* [🗃️ Base content](/source/plugins/base/README.md)
|
||
* [🧱 Core](/source/plugins/core/README.md)
|
||
* **Github**
|
||
* [🏆 Achievements](/source/plugins/achievements/README.md)
|
||
* [📰 Recent activity](/source/plugins/activity/README.md)
|
||
* [♐ Code snippet of the day](/source/plugins/code/README.md)
|
||
* [🏅 Repository contributors](/source/plugins/contributors/README.md)
|
||
* [💬 Discussions](/source/plugins/discussions/README.md)
|
||
* [🎟️ Follow-up of issues and pull requests](/source/plugins/followup/README.md)
|
||
* [🎫 Gists](/source/plugins/gists/README.md)
|
||
* [💡 Coding habits](/source/plugins/habits/README.md)
|
||
* [🙋 Introduction](/source/plugins/introduction/README.md)
|
||
* [📅 Isometric commit calendar](/source/plugins/isocalendar/README.md)
|
||
* [🈷️ Most used languages](/source/plugins/languages/README.md)
|
||
* [📜 Repository licenses](/source/plugins/licenses/README.md)
|
||
* [👨💻 Lines of code changed](/source/plugins/lines/README.md)
|
||
* [🎩 Notable contributions](/source/plugins/notable/README.md)
|
||
* [🧑🤝🧑 People plugin](/source/plugins/people/README.md)
|
||
* [🗂️ Active projects](/source/plugins/projects/README.md)
|
||
* [🎭 Comment reactions](/source/plugins/reactions/README.md)
|
||
* [📓 Repositories](/source/plugins/repositories/README.md)
|
||
* [🌇 GitHub Skyline 3D calendar](/source/plugins/skyline/README.md)
|
||
* [💕 GitHub Sponsors](/source/plugins/sponsors/README.md)
|
||
* [✨ Stargazers over last weeks](/source/plugins/stargazers/README.md)
|
||
* [💫 Starlists](/source/plugins/starlists/README.md)
|
||
* [🌟 Recently starred repositories](/source/plugins/stars/README.md)
|
||
* [💭 GitHub Community Support](/source/plugins/support/README.md)
|
||
* [📌 Starred topics](/source/plugins/topics/README.md)
|
||
* [🧮 Repositories traffic](/source/plugins/traffic/README.md)
|
||
* **Social**
|
||
* [🌸 Anilist watch list and reading list](/source/plugins/anilist/README.md)
|
||
* [🎼 Music plugin](/source/plugins/music/README.md)
|
||
* [⏱️ Website performances](/source/plugins/pagespeed/README.md)
|
||
* [✒️ Recent posts](/source/plugins/posts/README.md)
|
||
* [🗼 Rss feed](/source/plugins/rss/README.md)
|
||
* [🗨️ Stackoverflow plugin](/source/plugins/stackoverflow/README.md)
|
||
* [💹 Stock prices](/source/plugins/stock/README.md)
|
||
* [🐤 Latest tweets](/source/plugins/tweets/README.md)
|
||
* [⏰ WakaTime plugin](/source/plugins/wakatime/README.md)
|
||
**🎲 Maintained by community**
|
||
* [💉 Nightscout](/source/plugins/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars)
|
||
* [💩 PoopMap plugin](/source/plugins/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat)
|
||
* [📸 Website screenshot](/source/plugins/screenshot/README.md) by [@lowlighter](https://github.com/lowlighter)
|
||
|
||
## 💪 Contributing
|
||
|
||
If you are interested in contributing, the following resources may interest you:
|
||
|
||
* [💪 Contribution guide](/CONTRIBUTING.md)
|
||
* [🧬 Architecture](/ARCHITECTURE.md)
|
||
* [📜 License](/LICENSE)
|
||
* **:octocat: GitHub resources**
|
||
* [📖 GitHub GraphQL API](https://docs.github.com/en/graphql)
|
||
* [📖 GitHub GraphQL Explorer](https://docs.github.com/en/free-pro-team@latest/graphql/overview/explorer)
|
||
* [📖 GitHub Rest API](https://docs.github.com/en/rest)
|
||
* [📖 GitHub Octicons](https://github.com/primer/octicons)
|
||
|
||
Use [`💬 discussions`](https://github.com/lowlighter/metrics/discussions) for feedback, new features suggestions, bugs reports or to request help for installation.
|
||
|
||
|
||
## 📜 License
|
||
|
||
```
|
||
MIT License
|
||
Copyright (c) 2020-present lowlighter
|
||
```
|
||
|
||

|
||

|
||
|
||
|