lowlighter/metrics

Summary

GitHub Metrics is a JavaScript generator that produces stats infographics for GitHub users, organizations, and repositories, rendered as SVG, Markdown, PDF, or JSON. It ships as a GitHub Action and is built around a plugin architecture, with the README documenting 47 plugins and 335 configuration options.

What it is useful for

Engineers can populate a GitHub profile README with auto-updating visuals drawn from the GitHub API, such as commit calendars, language activity, stargazer charts and world maps, lines-of-code history, repository traffic, and follow-up tracking for issues and pull requests. Plugins also reach beyond GitHub to surface data from services like WakaTime, Stack Overflow, LeetCode, Steam, Anilist, RSS feeds, and Google PageSpeed scores. Output is configurable per plugin — for example, the languages plugin offers an "indepth" mode that clones and analyzes repositories, and the stargazers plugin can render as charts, graphs, or a worldmap. Community-contributed plugins add further options including chess stats, crypto prices, stock prices, and 16personalities results, and additional templates are provided beyond the documented "Classic" one.

How engineers can use it

The standard approach is to run it as a GitHub Action that writes rendered output back to a repository, so metrics in a profile README refresh on a schedule without manual edits. Engineers pick which plugins to enable, supply tokens for the third-party services they want to query, and choose the output format. A practical starting point is to copy a template from the source/templates directory and trim it down to the plugins that matter, then opt into additional community plugins as needed. The supplied README excerpt does not include the full workflow YAML, the complete secrets reference, or the per-plugin option list, so readers should consult the project README directly for exact setup steps, required permissions, and the full configuration reference. The project is licensed under MIT and is written in JavaScript.