README 未说明
metrics
lowlighterMIT更新放缓用 30 多个插件和 300 多项配置把 GitHub 账号的统计数据生成信息图,输出 SVG、Markdown、PDF 或 JSON,适合做个人主页的统计卡片。
📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON!
把 GitHub 账号数据渲染成可嵌入个人主页的 SVG、Markdown、PDF 或 JSON 信息图
用 30 多个插件和 300 多项配置把 GitHub 账号的统计数据生成信息图,输出 SVG、Markdown、PDF 或 JSON,适合做个人主页的统计卡片。
核心能力
- 内置 47 个插件、335 个选项自由组合
- 支持用户、组织与仓库三类对象
- 输出 SVG、Markdown、PDF、JSON 多种格式
- 可分析仓库克隆结果生成语言深度统计
- 提供等距提交日历、星标地图等可视化
容易踩的坑
- v3.34Version 3.34最新正式版2023-09-13 · 2023-09-13 02:39 UTC
📦 New features
- 👨💻 Lines of code changed
- Add
plugin_lines_delayoption to mitigate empty results on first query #1530- (Use this option to automatically perform a second request if you encounter zeroed-diffs values)
- Add
🧰 Fixes and documentation
chore: upgrade dependencies docs(steam): correct
plugin_steam_userexample (#1413, @CCXXXI) fix(community/template): quickstart fix(plugins/achievements): update total data acquisition method (#1487, @TonyCrane) fix(plugins/achievements): find pre-2007 activity (#1493, @LucasLarson) fix(plugins/achievements): fix progress of rank A (#1430, @TonyCrane) fix(app/utils): don't die on undefined file type buffer fix(app/utils): pie graph when less than 3 values fix(plugin/achievements): use graphql first for initial setup and fix regex🪦 Deprecations
🐤 Latest tweetstweets has been deprecated as Twitter removed the ability to fetch tweets from their free API as part of their new pricing policy. This plugin will no longer maintained.
💕 Sponsors
project maintained by @lowlighter
- 👨💻 Lines of code changed
- v3.33Version 3.332023-03-28 · 2023-03-28 07:50 UTC
查看更新说明
📦 New features
- 🕹️ Steam✨ new!
- Use
plugin_steam,plugin_steam_tokenandplugin_steam_userto display data about your Steam account and games ! (#1400) - Use
plugin_steam_sectionsto select which section should be displayed between yourplayerprofile,most-playedgames andrecently-playedgames - Use
plugin_steam_games_ignored,plugin_steam_games_limit,plugin_steam_recent_games_limitandplugin_steam_playtime_thresholdto control which games should be displayed - Use
plugin_steam_achievements_limitto control how many achievements should be displayed per game entry - Example: Recently played games
- Example: Profile and detailed game history
- Use
- 🗳️ Leetcode
- Use
plugin_leetcode_ignored_skillsto filter out skills or entire skills categories
- Use
- ✨ Stargazers
- Use
plugin_stargazers_daysto select the displayed time range rather than being limited to 14 days- Set
plugin_stargazers_days: 0to cover entire account or repository history
- Set
- Changed charts renderer from chartist to D3
- 🪦 Deprecated
plugin_stargazers_charts_type: chartistbyplugin_stargazers_charts_type: graph
- 🪦 Deprecated
- Use
- 💡 Coding habits and activity
🎲 Community plugins
- 🧠 16personalities✨ new!
- Use
plugin_16personalitiesandplugin_16personalities_urlto display a 16personalities profile (#1402) - Use
plugin_16personalities_sectionsto select which section should be displayed between yourpersonality,profileandtraitsreport - Use
plugin_16personalities_scoresto control whether to display score for each trait
- Use
- 🦑 Splatoon
- Upgrade s3si to v2
- Add icons from weapons, specials and stages from Fresh season
- 💹 Stock prices
🧰 Fixes and documentation
fix(app/metrics/utils): support base64 svg chore(deps): bump minimatch from 6.0.4 to 6.1.6 (#1389, @RJid) fix(ci): missing cache path and code formatter fix(plugins/traffic): display scope errors chore(deps): migrate from chartist to d3
🎉 Celebrating 10000 stars!
Thanks again for all of your feedbacks, support and contributions, and I hope you'll continue using Metrics in the future 😎 !
💕 Sponsors
project maintained by @lowlighter
- 🕹️ Steam✨ new!
- v3.32Version 3.322023-01-18 · 2023-01-18 10:28 UTC
查看更新说明
📦 New features
- 💝 GitHub sponsorships✨ new!
- Use
plugin_sponsorships,plugin_sponsorships_sectionsandplugin_sponsorships_sizeto display the amount you funded into open source software through GitHub sponsors ! (#1358) - Also display people and organization you're sponsoring or sponsored in the past !
- Use
- 🦑 Miscelleanous
- Add support for
--winterdebug flag to force winter mode on calendars (#1341)
- Add support for
🧰 Fixes and documentation
fix(plugins/stargazers): bad scale on worldmap when not enough values docs: add an example for preventing GitHub from auto linking to the image (#1339, @xxchan) fix(deps): remove dependency on d3-node since it is unmaintained (#1329) fix(deps): switch from twemoji-parser to @twemoji/parser fork since main repo is unmaintained (#1355) fix(plugins/lines): add support for organization history (#1356)
💕 Sponsors
project maintained by @lowlighter
- 💝 GitHub sponsorships✨ new!
- v3.31Version 3.312022-12-22 · 2022-12-22 05:03 UTC
查看更新说明
📦 New features
- 🦑 Miscelleanous
- Add new
debug_flagsdebug flags for puppeteer (#1317)
- Add new
- 🌐 Web instances
- If
insightsis used with missing extras features permissions, warnings will be displayed on resulting page
- If
🎲 Community plugins
- 📸 Website screenshot
- Add
plugin_screenshot_modeto choose betweenimageortextoutput (#1324)
- Add
🧰 Fixes and documentation
fix(app/metrics): SVGs broken on markdown templates (#1315) fix(plugins/music): spotify playlist mode due to UI changes fix(plugins/community/stock): undefined quoteType
💕 Sponsors
project maintained by @lowlighter
- 🦑 Miscelleanous
- v3.30Version 3.302022-12-13 · 2022-12-13 07:34 UTC
查看更新说明
📦 New features
- 🦑 Miscelleanous
- The action will throw an error when trying to use GitHub fine-grained personal access tokens as
tokenas it's not possible to use them to authenticate to GitHub GraphQL API yet- If fine-grained PATs can be used for authenticating to GraphQL API in the future, support for them will be considered
- The action will throw an error when trying to use GitHub fine-grained personal access tokens as
🎲 Community plugins
- 🦑 Splatoon ✨ new!
- Configure
plugin_splatoon_tokento display your Splatnet 3 data ! (#1287, #1303) - Enable
plugin_splatoon_statinkand setplugin_splatoon_statink_tokenfor stat.ink integration - Display your
playernameplate, lastversusmatches and lastsalmon-runshifts usingplugin_splatoon_sections!- Use
plugin_splatoon_versus_limitorplugin_splatoon_salmon_limitto configure the number of matches displayed
- Use
- Configure
- ♟️ Chess
- fix: black pawn represented as emoji instead of unicode
- 📸 Website screenshot
- Add
plugin_screenshot_viewportto configure screenshot viewport (#1288) - Add
plugin_screenshot_waitto delay screenshot (#1288) - fix: wait for idle network and dom loaded
- Add
🧰 Fixes and documentation
docs: improve community plugins docs: improve references fix(app/action): mishandled
config_output(#1293, #1295) fix(app/web): unsupported plugins display notice💕 Sponsors
project maintained by @lowlighter
- 🦑 Miscelleanous
用户点评
登录用户的真实使用记录,可按版本和硬件筛选还没有人点评。第一个说出真实体验的人最有价值。
📊 Metrics
Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
📚 Documentation
⚠️ This is the documentation of v3.35-beta (
@master/@mainbranches) which includes unreleased features planned for next release. See documentation for current released version v3.34 (@latestbranch) 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:
- 🏦 Configure metrics for organizations
- 🏠 Run metrics on self-hosted runners
- 🧰 Template/Plugin compatibility matrix
🖼️ Templates
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
Plugins provide additional content and lets you customize rendered metrics.
📦 Maintained by core team
- Core plugins
- 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
- 🏆 Achievements
- Social plugins
🎲 Maintained by community
- Community plugins
- 🧠 16personalities
16personalitiesby @lowlighter - ♟️ Chess
chessby @lowlighter - 🪙 Crypto
cryptoby @dajneem23 - 🥠 Fortune
fortuneby @lowlighter - 💉 Nightscout
nightscoutby @legoandmars - 💩 PoopMap plugin
poopmapby @matievisthekat - 📸 Website screenshot
screenshotby @lowlighter - 🦑 Splatoon
splatoonby @lowlighter - 💹 Stock prices
stockby @lowlighter
- 🧠 16personalities
💪 Contributing
If you are interested in contributing, the following resources may interest you:
- 💪 Contribution guide
- 🧬 Architecture
- 📜 License
- :octocat: GitHub resources
Use 💬 discussions for feedback, new features suggestions, bugs reports or to request help for installation.
📜 License
MIT License
Copyright (c) 2020-present lowlighter