diff --git a/.github/readme/partials/documentation/compatibility.md b/.github/readme/partials/documentation/compatibility.md index 06f50aa9..d1833e9c 100644 --- a/.github/readme/partials/documentation/compatibility.md +++ b/.github/readme/partials/documentation/compatibility.md @@ -5,18 +5,18 @@ Template/Plugin đŸ—ƒī¸ 📅 - đŸˆˇī¸ + đŸˆˇī¸ 📌 🌟 📜 - 💡 + 💡 🏅 đŸŽŸī¸ 🎭 - 🧑‍🤝‍🧑 + 🧑‍🤝‍🧑 ✨ - đŸ—‚ī¸ - ♐ + đŸ—‚ī¸ + ♐ 📰 🏆 🎩 @@ -24,21 +24,21 @@ 💭 👨‍đŸ’ģ 🧮 - 📓 + 📓 đŸŽĢ 🙋 💕 - đŸ’Ģ - 📆 - 🌇 - âąī¸ - đŸ—¨ī¸ + đŸ’Ģ + 📆 + 🌇 + âąī¸ + đŸ—¨ī¸ 🌸 🐤 âœ’ī¸ - đŸŽŧ + đŸŽŧ đŸ—ŧ - ⏰ + ⏰ 📗 Classic template @@ -203,18 +203,18 @@ Mode/Plugin đŸ—ƒī¸ 📅 - đŸˆˇī¸ + đŸˆˇī¸ 📌 🌟 📜 - 💡 + 💡 🏅 đŸŽŸī¸ 🎭 - 🧑‍🤝‍🧑 + 🧑‍🤝‍🧑 ✨ - đŸ—‚ī¸ - ♐ + đŸ—‚ī¸ + ♐ 📰 🏆 🎩 @@ -222,21 +222,21 @@ 💭 👨‍đŸ’ģ 🧮 - 📓 + 📓 đŸŽĢ 🙋 💕 - đŸ’Ģ - 📆 - 🌇 - âąī¸ - đŸ—¨ī¸ + đŸ’Ģ + 📆 + 🌇 + âąī¸ + đŸ—¨ī¸ 🌸 🐤 âœ’ī¸ - đŸŽŧ + đŸŽŧ đŸ—ŧ - ⏰ + ⏰ 👤 User diff --git a/README.md b/README.md index 2c212cc1..89af2b98 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile 📅 Isometric commit calendar - đŸˆˇī¸ Most used languages + đŸˆˇī¸ Languages activity @@ -57,7 +57,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile 📜 Repository licenses - 💡 Coding habits + 💡 Coding habits and activity @@ -90,7 +90,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile 🎭 Comment reactions - 🧑‍🤝‍🧑 People plugin + 🧑‍🤝‍🧑 People @@ -105,7 +105,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile ✨ Stargazers over last weeks - đŸ—‚ī¸ Active projects + đŸ—‚ī¸ GitHub projects @@ -119,7 +119,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - ♐ Code snippet of the day + ♐ Random code snippet 📰 Recent activity @@ -177,7 +177,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - 📓 Repositories + 📓 Featured repositories đŸŽĢ Gists @@ -208,8 +208,8 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - đŸ’Ģ Starlists - 📆 Calendar + đŸ’Ģ Star lists + 📆 Commit calendar @@ -224,8 +224,8 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - 🌇 GitHub Skyline 3D calendar - âąī¸ Website performances + 🌇 GitHub Skyline + âąī¸ Google PageSpeed @@ -240,7 +240,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - đŸ—¨ī¸ StackOverflow plugin + đŸ—¨ī¸ Stack Overflow 🌸 Anilist watch list and reading list @@ -272,7 +272,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - đŸŽŧ Music plugin + đŸŽŧ Music activity and suggestions đŸ—ŧ Rss feed @@ -287,7 +287,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - ⏰ WakaTime plugin + ⏰ WakaTime @@ -419,40 +419,40 @@ Plugins provide additional content and lets you customize rendered metrics. * **Github plugins** * [🏆 Achievements `achievements`](/source/plugins/achievements/README.md) * [📰 Recent activity `activity`](/source/plugins/activity/README.md) - * [📆 Calendar `calendar`](/source/plugins/calendar/README.md) - * [♐ Code snippet of the day `code`](/source/plugins/code/README.md) + * [📆 Commit calendar `calendar`](/source/plugins/calendar/README.md) + * [♐ Random code snippet `code`](/source/plugins/code/README.md) * [🏅 Repository contributors `contributors`](/source/plugins/contributors/README.md) * [đŸ’Ŧ Discussions `discussions`](/source/plugins/discussions/README.md) * [đŸŽŸī¸ Follow-up of issues and pull requests `followup`](/source/plugins/followup/README.md) * [đŸŽĢ Gists `gists`](/source/plugins/gists/README.md) - * [💡 Coding habits `habits`](/source/plugins/habits/README.md) + * [💡 Coding habits and activity `habits`](/source/plugins/habits/README.md) * [🙋 Introduction `introduction`](/source/plugins/introduction/README.md) * [📅 Isometric commit calendar `isocalendar`](/source/plugins/isocalendar/README.md) - * [đŸˆˇī¸ Most used languages `languages`](/source/plugins/languages/README.md) + * [đŸˆˇī¸ Languages activity `languages`](/source/plugins/languages/README.md) * [📜 Repository licenses `licenses`](/source/plugins/licenses/README.md) * [👨‍đŸ’ģ Lines of code changed `lines`](/source/plugins/lines/README.md) * [🎩 Notable contributions `notable`](/source/plugins/notable/README.md) - * [🧑‍🤝‍🧑 People plugin `people`](/source/plugins/people/README.md) - * [đŸ—‚ī¸ Active projects `projects`](/source/plugins/projects/README.md) + * [🧑‍🤝‍🧑 People `people`](/source/plugins/people/README.md) + * [đŸ—‚ī¸ GitHub projects `projects`](/source/plugins/projects/README.md) * [🎭 Comment reactions `reactions`](/source/plugins/reactions/README.md) - * [📓 Repositories `repositories`](/source/plugins/repositories/README.md) - * [🌇 GitHub Skyline 3D calendar `skyline`](/source/plugins/skyline/README.md) + * [📓 Featured repositories `repositories`](/source/plugins/repositories/README.md) + * [🌇 GitHub Skyline `skyline`](/source/plugins/skyline/README.md) * [💕 GitHub Sponsors `sponsors`](/source/plugins/sponsors/README.md) * [✨ Stargazers over last weeks `stargazers`](/source/plugins/stargazers/README.md) - * [đŸ’Ģ Starlists `starlists`](/source/plugins/starlists/README.md) + * [đŸ’Ģ Star lists `starlists`](/source/plugins/starlists/README.md) * [🌟 Recently starred repositories `stars`](/source/plugins/stars/README.md) * [💭 GitHub Community Support `support`](/source/plugins/support/README.md) * [📌 Starred topics `topics`](/source/plugins/topics/README.md) * [🧮 Repositories traffic `traffic`](/source/plugins/traffic/README.md) * **Social plugins** * [🌸 Anilist watch list and reading list `anilist`](/source/plugins/anilist/README.md) - * [đŸŽŧ Music plugin `music`](/source/plugins/music/README.md) - * [âąī¸ Website performances `pagespeed`](/source/plugins/pagespeed/README.md) + * [đŸŽŧ Music activity and suggestions `music`](/source/plugins/music/README.md) + * [âąī¸ Google PageSpeed `pagespeed`](/source/plugins/pagespeed/README.md) * [âœ’ī¸ Recent posts `posts`](/source/plugins/posts/README.md) * [đŸ—ŧ Rss feed `rss`](/source/plugins/rss/README.md) - * [đŸ—¨ī¸ StackOverflow plugin `stackoverflow`](/source/plugins/stackoverflow/README.md) + * [đŸ—¨ī¸ Stack Overflow `stackoverflow`](/source/plugins/stackoverflow/README.md) * [🐤 Latest tweets `tweets`](/source/plugins/tweets/README.md) - * [⏰ WakaTime plugin `wakatime`](/source/plugins/wakatime/README.md) + * [⏰ WakaTime `wakatime`](/source/plugins/wakatime/README.md) **🎲 Maintained by community** * **[Community plugins](/source/plugins/community/README.md)** diff --git a/action.yml b/action.yml index 103682af..6a491b4a 100644 --- a/action.yml +++ b/action.yml @@ -15,15 +15,15 @@ inputs: default: base_hireable: - description: Display `Available for hire!` in header section + description: Show `Available for hire!` in header section default: repositories: - description: Repositories to fetch + description: Fetched repositories default: repositories_batch: - description: Repositories to fetch at a time + description: Fetched repositories per query default: repositories_forks: @@ -255,7 +255,7 @@ inputs: default: # ==================================================================================== - # đŸˆˇī¸ Most used languages + # đŸˆˇī¸ Languages activity plugin_languages: description: Enable languages plugin @@ -278,9 +278,7 @@ inputs: default: plugin_languages_other: - description: >- - Group unknown, ignored and over-limit languages into a single "Other" - category + description: Group unknown, ignored and over-limit languages into "Other" category default: plugin_languages_colors: @@ -300,7 +298,7 @@ inputs: default: plugin_languages_indepth: - description: Indepth mode (âš ī¸ read documentation first) + description: Indepth mode default: plugin_languages_analysis_timeout: @@ -331,11 +329,11 @@ inputs: default: plugin_topics_mode: - description: "Display mode:" + description: Display mode default: plugin_topics_sort: - description: "Sorting method:" + description: Sorting method default: plugin_topics_limit: @@ -365,15 +363,15 @@ inputs: default: plugin_licenses_ratio: - description: Display used licenses ratio + description: Used licenses ratio default: plugin_licenses_legal: - description: Display permissions, limitations and conditions about licenses + description: Permissions, limitations and conditions about used licenses default: # ==================================================================================== - # 💡 Coding habits + # 💡 Coding habits and activity plugin_habits: description: Enable habits plugin @@ -388,11 +386,11 @@ inputs: default: plugin_habits_facts: - description: Toggle midly interesting facts display + description: Midly interesting facts default: plugin_habits_charts: - description: Toggle charts display + description: Charts default: plugin_habits_charts_type: @@ -404,7 +402,7 @@ inputs: default: plugin_habits_languages_limit: - description: Limits the number of languages to be displayed + description: Display limit (languages) default: # ==================================================================================== @@ -415,11 +413,11 @@ inputs: default: plugin_contributors_base: - description: Base reference (commit, tag, branch, etc.) + description: Base reference default: plugin_contributors_head: - description: Head reference (commit, tag, branch, etc.) + description: Head reference default: plugin_contributors_ignored: @@ -427,7 +425,7 @@ inputs: default: plugin_contributors_contributions: - description: Toggle number of contributions display + description: Contributions count default: plugin_contributors_sections: @@ -435,7 +433,7 @@ inputs: default: plugin_contributors_categories: - description: Configure contribution categories + description: Contribution categories default: # ==================================================================================== @@ -454,7 +452,7 @@ inputs: default: plugin_followup_archived: - description: Include Issues and Pull requests on the archived repositories. + description: Include archived repositories default: # ==================================================================================== @@ -497,7 +495,7 @@ inputs: default: # ==================================================================================== - # 🧑‍🤝‍🧑 People plugin + # 🧑‍🤝‍🧑 People plugin_people: description: Enable people plugin @@ -508,11 +506,11 @@ inputs: default: plugin_people_identicons: - description: Toggle identicons display + description: Force identicons pictures default: plugin_people_identicons_hide: - description: Hide identicons display + description: Hide identicons pictures default: plugin_people_size: @@ -520,7 +518,7 @@ inputs: default: plugin_people_types: - description: Displayed sections (order is respected) + description: Displayed sections default: plugin_people_thanks: @@ -532,7 +530,7 @@ inputs: default: plugin_people_shuffle: - description: Shuffle data for varied output + description: Shuffle data default: # ==================================================================================== @@ -547,7 +545,7 @@ inputs: default: # ==================================================================================== - # đŸ—‚ī¸ Active projects + # đŸ—‚ī¸ GitHub projects plugin_projects: description: Enable projects plugin @@ -558,22 +556,22 @@ inputs: default: plugin_projects_repositories: - description: List of repositories projects + description: Featured repositories projects default: plugin_projects_descriptions: - description: Toggle projects descriptions display + description: Projects descriptions default: # ==================================================================================== - # ♐ Code snippet of the day + # ♐ Random code snippet plugin_code: description: Enable code plugin default: plugin_code_lines: - description: Display limit for code snippets + description: Display limit (lines per code snippets) default: plugin_code_load: @@ -593,7 +591,7 @@ inputs: default: plugin_code_languages: - description: Restrict display to specific languages + description: Showcased languages default: # ==================================================================================== @@ -620,7 +618,7 @@ inputs: default: plugin_activity_timestamps: - description: Display events timestamps + description: Events timestamps default: plugin_activity_skipped: @@ -643,11 +641,11 @@ inputs: default: plugin_achievements_threshold: - description: Display rank threshold + description: Rank threshold filter default: plugin_achievements_secrets: - description: Display secrets achievements + description: Secrets achievements default: plugin_achievements_display: @@ -659,11 +657,11 @@ inputs: default: plugin_achievements_ignored: - description: Hide specified achievements + description: Ignored achievements default: plugin_achievements_only: - description: Restrict display to specified achievements + description: Showcased achievements default: # ==================================================================================== @@ -682,11 +680,11 @@ inputs: default: plugin_notable_from: - description: Filter by repository owner account type + description: Repository owner account type filter default: plugin_notable_repositories: - description: Toggle repository name display + description: Repository name default: plugin_notable_indepth: @@ -705,7 +703,7 @@ inputs: default: plugin_discussions_categories: - description: Toggle discussion categories display + description: Discussion categories default: plugin_discussions_categories_limit: @@ -742,18 +740,18 @@ inputs: default: # ==================================================================================== - # 📓 Repositories + # 📓 Featured repositories plugin_repositories: description: Enable repositories plugin default: plugin_repositories_featured: - description: List of featured repositories + description: Featured repositories default: plugin_repositories_pinned: - description: Display pinned repositories + description: Pinned repositories default: # ==================================================================================== @@ -767,11 +765,11 @@ inputs: # 🙋 Introduction plugin_introduction: - description: Display account or repository introduction + description: Enable introduction plugin default: plugin_introduction_title: - description: Display introduction section title + description: Section title default: # ==================================================================================== @@ -786,7 +784,7 @@ inputs: default: plugin_sponsors_past: - description: Display past sponsorships + description: Past sponsorships default: plugin_sponsors_size: @@ -794,7 +792,7 @@ inputs: default: # ==================================================================================== - # đŸ’Ģ Starlists + # đŸ’Ģ Star lists plugin_starlists: description: Enable starlists plugin @@ -809,15 +807,15 @@ inputs: default: plugin_starlists_languages: - description: Toggle star list languages statistics + description: Star lists languages statistics default: plugin_starlists_limit_languages: - description: Disply limit (languages per star list) + description: Display limit (languages per star list) default: plugin_starlists_shuffle_repositories: - description: Shuffle data for varied outputs + description: Shuffle data default: plugin_starlists_ignored: @@ -825,11 +823,11 @@ inputs: default: plugin_starlists_only: - description: Restrict display to specified star lists + description: Showcased star lists default: # ==================================================================================== - # 📆 Calendar + # 📆 Commit calendar plugin_calendar: description: Enable calendar plugin @@ -840,7 +838,7 @@ inputs: default: # ==================================================================================== - # 🌇 GitHub Skyline 3D calendar + # 🌇 GitHub Skyline plugin_skyline: description: Enable skyline plugin @@ -863,12 +861,16 @@ inputs: default: # ==================================================================================== - # âąī¸ Website performances + # âąī¸ Google PageSpeed plugin_pagespeed: description: Enable pagespeed plugin default: + plugin_pagespeed_token: + description: PageSpeed token + default: + plugin_pagespeed_url: description: Audited website default: @@ -878,19 +880,15 @@ inputs: default: plugin_pagespeed_screenshot: - description: Display a website screenshot - default: - - plugin_pagespeed_token: - description: PageSpeed token + description: Website screenshot default: plugin_pagespeed_pwa: - description: Display PWA Status + description: PWA Status default: # ==================================================================================== - # đŸ—¨ī¸ StackOverflow plugin + # đŸ—¨ī¸ Stack Overflow plugin_stackoverflow: description: Enable stackoverflow plugin @@ -905,15 +903,15 @@ inputs: default: plugin_stackoverflow_limit: - description: Display limit (per section) + description: Display limit (entries per section) default: plugin_stackoverflow_lines: - description: Display limit for questions and answers + description: Display limit (lines per questions and answers) default: plugin_stackoverflow_lines_snippet: - description: Display limit for code snippets + description: Display limit (lines per code snippets) default: # ==================================================================================== @@ -923,8 +921,12 @@ inputs: description: Enable aniList plugin default: + plugin_anilist_user: + description: AniList login + default: + plugin_anilist_medias: - description: Display medias types + description: Medias types default: plugin_anilist_sections: @@ -940,11 +942,7 @@ inputs: default: plugin_anilist_shuffle: - description: Shuffle data for varied outputs - default: - - plugin_anilist_user: - description: AniList login + description: Shuffle data default: # ==================================================================================== @@ -958,18 +956,18 @@ inputs: description: Twitter API token default: + plugin_tweets_user: + description: Twitter username + default: + plugin_tweets_attachments: - description: Display tweets attachments (images, video previews, etc.) + description: Tweets attachments default: plugin_tweets_limit: description: Display limit default: - plugin_tweets_user: - description: Twitter username - default: - # ==================================================================================== # âœ’ī¸ Recent posts @@ -981,24 +979,24 @@ inputs: description: External source default: + plugin_posts_user: + description: External source username + default: + plugin_posts_descriptions: - description: Toggle posts descriptions display + description: Posts descriptions default: plugin_posts_covers: - description: Toggle posts cover images display + description: Posts cover images default: plugin_posts_limit: description: Display limit default: - plugin_posts_user: - description: External source username - default: - # ==================================================================================== - # đŸŽŧ Music plugin + # đŸŽŧ Music activity and suggestions plugin_music: description: Enable music plugin @@ -1012,6 +1010,10 @@ inputs: description: Music provider token default: + plugin_music_user: + description: Music provider username + default: + plugin_music_mode: description: Display mode default: @@ -1025,21 +1027,17 @@ inputs: default: plugin_music_played_at: - description: Recently played - Toggle last played timestamp display + description: Recently played - Last played timestamp default: plugin_music_time_range: - description: Top tracks - Time range for `top` mode + description: Top tracks - Time range default: plugin_music_top_type: description: Top tracks - Display type default: - plugin_music_user: - description: Music provider username - default: - # ==================================================================================== # đŸ—ŧ Rss feed @@ -1056,7 +1054,7 @@ inputs: default: # ==================================================================================== - # ⏰ WakaTime plugin + # ⏰ WakaTime plugin_wakatime: description: Enable wakatime plugin @@ -1066,28 +1064,28 @@ inputs: description: WakaTime API token default: - plugin_wakatime_days: - description: Time range - default: - - plugin_wakatime_sections: - description: Displayed sections - default: - - plugin_wakatime_limit: - description: Display limit (per graph) - default: - plugin_wakatime_url: - description: WakaTime url + description: WakaTime URL default: plugin_wakatime_user: description: WakaTime username default: + plugin_wakatime_sections: + description: Displayed sections + default: + + plugin_wakatime_days: + description: Time range + default: + + plugin_wakatime_limit: + description: Display limit (entries per graph) + default: + plugin_wakatime_languages_other: - description: Include other languages + description: Other languages default: plugin_wakatime_languages_ignored: @@ -1163,7 +1161,7 @@ inputs: default: plugin_screenshot_url: - description: Website url + description: Website URL default: plugin_screenshot_selector: @@ -1171,7 +1169,7 @@ inputs: default: plugin_screenshot_background: - description: Display background + description: Background default: # ==================================================================================== @@ -1190,7 +1188,7 @@ inputs: default: plugin_stock_duration: - description: Time range (relative to current date) + description: Time range default: plugin_stock_interval: diff --git a/settings.example.json b/settings.example.json index c6bb0f2b..227e3cd2 100644 --- a/settings.example.json +++ b/settings.example.json @@ -101,7 +101,7 @@ "enabled": false, "//": "Enable gists plugin" }, "introduction":{ - "enabled": false, "//": "Display account or repository introduction" + "enabled": false, "//": "Enable introduction plugin" }, "sponsors":{ "enabled": false, "//": "Enable sponsors plugin" @@ -116,7 +116,7 @@ "enabled": false, "//": "Enable skyline plugin" }, "pagespeed":{ - "token": null, "//":"PageSpeed token\n\nAlthough not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See [PageSpeed documentation](https://developers.google.com/speed/docs/insights/v5/get-started) for more informations.\n", + "token": null, "//": "PageSpeed token", "enabled": false, "//": "Enable pagespeed plugin" }, "stackoverflow":{ @@ -126,21 +126,21 @@ "enabled": false, "//": "Enable aniList plugin" }, "tweets":{ - "token": null, "//":"Twitter API token", + "token": null, "//": "Twitter API token", "enabled": false, "//": "Enable tweets plugin" }, "posts":{ "enabled": false, "//": "Enable posts plugin" }, "music":{ - "token": null, "//":"Music provider token\n\nBelow is the expected token format for each provider:\n- `apple`: *(not supported)*\n- `spotify`: \"client_id, client_secret, refresh_token\"\n- `lastfm`: \"api_key\"\n- `youtube`: \"cookie\"\n", + "token": null, "//": "Music provider token", "enabled": false, "//": "Enable music plugin" }, "rss":{ "enabled": false, "//": "Enable rss plugin" }, "wakatime":{ - "token": null, "//":"WakaTime API token", + "token": null, "//": "WakaTime API token", "enabled": false, "//": "Enable wakatime plugin" }, "fortune":{ @@ -150,14 +150,14 @@ "enabled": false, "//": "Enable nightscout plugin" }, "poopmap":{ - "token": null, "//":"PoopMap API token", + "token": null, "//": "PoopMap API token", "enabled": false, "//": "Enable poopmap plugin" }, "screenshot":{ "enabled": false, "//": "Enable screenshot plugin" }, "stock":{ - "token": null, "//":"Yahoo Finance token", + "token": null, "//": "Yahoo Finance token", "enabled": false, "//": "Enable stock plugin" }, "//": "" diff --git a/source/plugins/README.md b/source/plugins/README.md index 0e08231c..6d19ebf5 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -10,40 +10,40 @@ Plugins provide additional content and lets you customize rendered metrics. * **Github plugins** * [🏆 Achievements `achievements`](/source/plugins/achievements/README.md) * [📰 Recent activity `activity`](/source/plugins/activity/README.md) - * [📆 Calendar `calendar`](/source/plugins/calendar/README.md) - * [♐ Code snippet of the day `code`](/source/plugins/code/README.md) + * [📆 Commit calendar `calendar`](/source/plugins/calendar/README.md) + * [♐ Random code snippet `code`](/source/plugins/code/README.md) * [🏅 Repository contributors `contributors`](/source/plugins/contributors/README.md) * [đŸ’Ŧ Discussions `discussions`](/source/plugins/discussions/README.md) * [đŸŽŸī¸ Follow-up of issues and pull requests `followup`](/source/plugins/followup/README.md) * [đŸŽĢ Gists `gists`](/source/plugins/gists/README.md) - * [💡 Coding habits `habits`](/source/plugins/habits/README.md) + * [💡 Coding habits and activity `habits`](/source/plugins/habits/README.md) * [🙋 Introduction `introduction`](/source/plugins/introduction/README.md) * [📅 Isometric commit calendar `isocalendar`](/source/plugins/isocalendar/README.md) - * [đŸˆˇī¸ Most used languages `languages`](/source/plugins/languages/README.md) + * [đŸˆˇī¸ Languages activity `languages`](/source/plugins/languages/README.md) * [📜 Repository licenses `licenses`](/source/plugins/licenses/README.md) * [👨‍đŸ’ģ Lines of code changed `lines`](/source/plugins/lines/README.md) * [🎩 Notable contributions `notable`](/source/plugins/notable/README.md) - * [🧑‍🤝‍🧑 People plugin `people`](/source/plugins/people/README.md) - * [đŸ—‚ī¸ Active projects `projects`](/source/plugins/projects/README.md) + * [🧑‍🤝‍🧑 People `people`](/source/plugins/people/README.md) + * [đŸ—‚ī¸ GitHub projects `projects`](/source/plugins/projects/README.md) * [🎭 Comment reactions `reactions`](/source/plugins/reactions/README.md) - * [📓 Repositories `repositories`](/source/plugins/repositories/README.md) - * [🌇 GitHub Skyline 3D calendar `skyline`](/source/plugins/skyline/README.md) + * [📓 Featured repositories `repositories`](/source/plugins/repositories/README.md) + * [🌇 GitHub Skyline `skyline`](/source/plugins/skyline/README.md) * [💕 GitHub Sponsors `sponsors`](/source/plugins/sponsors/README.md) * [✨ Stargazers over last weeks `stargazers`](/source/plugins/stargazers/README.md) - * [đŸ’Ģ Starlists `starlists`](/source/plugins/starlists/README.md) + * [đŸ’Ģ Star lists `starlists`](/source/plugins/starlists/README.md) * [🌟 Recently starred repositories `stars`](/source/plugins/stars/README.md) * [💭 GitHub Community Support `support`](/source/plugins/support/README.md) * [📌 Starred topics `topics`](/source/plugins/topics/README.md) * [🧮 Repositories traffic `traffic`](/source/plugins/traffic/README.md) * **Social plugins** * [🌸 Anilist watch list and reading list `anilist`](/source/plugins/anilist/README.md) - * [đŸŽŧ Music plugin `music`](/source/plugins/music/README.md) - * [âąī¸ Website performances `pagespeed`](/source/plugins/pagespeed/README.md) + * [đŸŽŧ Music activity and suggestions `music`](/source/plugins/music/README.md) + * [âąī¸ Google PageSpeed `pagespeed`](/source/plugins/pagespeed/README.md) * [âœ’ī¸ Recent posts `posts`](/source/plugins/posts/README.md) * [đŸ—ŧ Rss feed `rss`](/source/plugins/rss/README.md) - * [đŸ—¨ī¸ StackOverflow plugin `stackoverflow`](/source/plugins/stackoverflow/README.md) + * [đŸ—¨ī¸ Stack Overflow `stackoverflow`](/source/plugins/stackoverflow/README.md) * [🐤 Latest tweets `tweets`](/source/plugins/tweets/README.md) - * [⏰ WakaTime plugin `wakatime`](/source/plugins/wakatime/README.md) + * [⏰ WakaTime `wakatime`](/source/plugins/wakatime/README.md) **🎲 Maintained by community** * **[Community plugins](/source/plugins/community/README.md)** diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md index 2a3732e5..4d506673 100644 --- a/source/plugins/achievements/README.md +++ b/source/plugins/achievements/README.md @@ -2,7 +2,7 @@ - @@ -43,7 +43,7 @@ - @@ -55,7 +55,7 @@ - @@ -88,12 +88,13 @@ (0 ≤ đ‘Ĩ)
+zero behaviour: disable
default: 0
- @@ -103,9 +104,9 @@ - diff --git a/source/plugins/activity/README.md b/source/plugins/activity/README.md index 2384fd2f..05d4b5a0 100644 --- a/source/plugins/activity/README.md +++ b/source/plugins/activity/README.md @@ -2,7 +2,7 @@
← Back to plugins index

🏆 Achievements

This plugin displays several highlights about what you achieved on GitHub.

+

This plugin displays several highlights about what an account has achieved on GitHub.

Supported features
→ Full specification

plugin_achievements_threshold

Display rank threshold

+

Rank threshold filter

Use X to display achievements not yet unlocked

plugin_achievements_secrets

Display secrets achievements

+

Secrets achievements

plugin_achievements_ignored

Hide specified achievements

-

Use names without the rank adjective (i.e. without "great", "super" or "master")

+

Ignored achievements

+

Use achievements names without their rank adjective (i.e. without "great", "super" or "master")

plugin_achievements_only

Restrict display to specified achievements

-

Use names without the rank adjective (i.e. without "great", "super" or "master")

-

This option is equivalent to plugin_achievements_ignored with all existing achievements but the ones listed in this option

+

Showcased achievements

+

Use achievements names without their rank adjective (i.e. without "great", "super" or "master")

+

This option is equivalent to plugin_achievements_ignored with all existing achievements except the ones listed in this option

- @@ -83,7 +83,7 @@ @@ -94,7 +94,7 @@ - @@ -116,7 +116,7 @@ diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index f40cfb08..ec690005 100644 --- a/source/plugins/anilist/README.md +++ b/source/plugins/anilist/README.md @@ -2,7 +2,7 @@
← Back to plugins index

📰 Recent activity

This plugin displays your recent activity on GitHub.

+

This plugin displays recent activity on GitHub.

Supported features
→ Full specification

plugin_activity_visibility

Events visibility

-

Lets you hide private activity when using a repo scope token

+

Can be used to toggle private activity visibility when using a token with repo scope

plugin_activity_timestamps

Display events timestamps

+

Events timestamps

plugin_activity_ignored

Ignored users

-

Useful to ignore bots activity

+

Can be used to ignore bots activity

- @@ -41,10 +41,21 @@ + + + + + + + - @@ -58,7 +69,7 @@ - @@ -108,17 +120,6 @@
default: yes
- - - - - - -
← Back to plugins index

🌸 Anilist watch list and reading list

This plugin displays your favorites animes, mangas and characters from your AniList account.

+

This plugin displays favorites animes, mangas and characters from a AniList account.

Supported features
→ Full specification
type: boolean
default: no

plugin_anilist_user

AniList login

+
â¯ī¸ Cannot be preset
+type: string +
+default: → User login

plugin_anilist_medias

Display medias types

+

Medias types

plugin_anilist_sections

Displayed sections

    -
  • favorites will display favorites plugin_anilist_medias
  • +
  • favorites will display favorites from plugin_anilist_medias
  • watching will display animes currently in watching list
  • reading will display manga currently in reading list
  • characters will display liked characters
  • @@ -100,7 +111,8 @@

plugin_anilist_shuffle

Shuffle data for varied outputs

+

Shuffle data

+

Can be used to create varied outputs

plugin_anilist_user

AniList login

-
â¯ī¸ Cannot be preset
-type: string -
-default: → User login
diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index a29bcb79..98c2e26c 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -38,7 +38,7 @@

Base content

The following sections are supported:

    -
  • header, which usually contains username, two-week commits calendars and a few additional data
  • +
  • header, which usually contains username, two-weeks commits calendars and a few additional data
  • activity, which contains recent activity (commits, pull requests, issues, etc.)
  • community, which contains community stats (following, sponsors, organizations, etc.)
  • repositories, which contains repository stats (license, forks, stars, etc.)
  • @@ -69,14 +69,18 @@ This currently improves the accuracy of the following statistics:

    - 🌐 Web instances must configure settings.json
    + 🌐 Web instances must configure settings.json: +
      +
    • metrics.api.github.overuse
    • +
    • plugins.base.indepth
    • +
    type: boolean
    default: no

    base_hireable

    -

    Display Available for hire! in header section

    +

    Show Available for hire! in header section

    @@ -86,7 +90,7 @@ This currently improves the accuracy of the following statistics:

    repositories

    -

    Repositories to fetch

    +

    Fetched repositories

    A higher value result in more accurate metrics but can hit GitHub API rate-limit more easily (especially with a lot of plugins enabled)

    @@ -99,9 +103,9 @@ This currently improves the accuracy of the following statistics:

    repositories_batch

    -

    Repositories to fetch at a time

    -

    If you receive Something went wrong while executing your query (which is usually caused by API timeout), -try lowering this value.

    +

    Fetched repositories per query

    +

    If you receive Something went wrong while executing your query (which is usually caused by API timeouts), lowering this value may help. +This setting may not be supported by all plugins.

    @@ -131,8 +135,8 @@ try lowering this value.

  • organization_member: repositories from an organization where user is a member

Some plugin outputs may be affected by this setting too.

-

Set to "" to disable and fetch all repositories related to you. -Broad affiliation will result in less representative metrics.

+

Set to "" to disable and fetch all repositories related to given account. +Broad affiliations will result in less representative metrics.

@@ -156,7 +160,7 @@ Broad affiliation will result in less representative metrics.

users_ignored

Default ignored users

-

Note that email are supported only commits-related elements.

+

Note that emails are only supported in commits-related elements.

diff --git a/source/plugins/calendar/README.md b/source/plugins/calendar/README.md index 848854e8..e51f11ea 100644 --- a/source/plugins/calendar/README.md +++ b/source/plugins/calendar/README.md @@ -1,8 +1,8 @@ - - + diff --git a/source/plugins/code/README.md b/source/plugins/code/README.md index 02f3fbbd..41ce3361 100644 --- a/source/plugins/code/README.md +++ b/source/plugins/code/README.md @@ -1,8 +1,8 @@
← Back to plugins index

📆 Calendar

This plugin displays your commit calendar across several years

+

📆 Commit calendar

This plugin can display commit calendar across several years.

Supported features
→ Full specification
- - + - @@ -85,7 +88,7 @@ Use at your own risk, metrics and its authors cannot be held responsibl @@ -107,7 +110,7 @@ Use at your own risk, metrics and its authors cannot be held responsibl - diff --git a/source/plugins/community/README.md b/source/plugins/community/README.md index 145984a1..9e9fae5b 100644 --- a/source/plugins/community/README.md +++ b/source/plugins/community/README.md @@ -99,10 +99,9 @@ Plugins are auto-loaded based on their folder existence, so there's no need to r The default file looks like below: ```yaml -name: 🧩 Plugin name +name: "🧩 Plugin name" category: community -description: | - Short description +description: Short description examples: default: https://via.placeholder.com/468x60?text=No%20preview%20available authors: @@ -115,8 +114,7 @@ scopes: [] inputs: plugin_{name}: - description: | - Enable {name} plugin + description: Enable {name} plugin type: boolean default: no ``` @@ -136,16 +134,14 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea *Example: boolean type, defaults to `false`* ```yml plugin_{name}_{option}: - description: | - Boolean type + description: Boolean type type: boolean default: no ``` ```yml plugin_{name}_{option}: - description: | - String type + description: String type type: string default: .user.login ``` @@ -155,8 +151,7 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea *Example: string type, defaults to `foo` with `foo` or `bar` as allowed values* ```yml plugin_{name}_{option}: - description: | - Select type + description: Select type type: string values: - foo @@ -169,8 +164,7 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea *Example: number type, defaults to `1` and expected to be between `0` and `100`* ```yml plugin_{name}_{option}: - description: | - Number type + description: Number type type: number default: 1 min: 0 @@ -184,8 +178,7 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea *Example: array type, with comma-separated elements* ```yml plugin_{name}_{option}: - description: | - Array type + description: Array type type: array format: comma-separated values: @@ -199,8 +192,7 @@ Because of GitHub Actions original limitations, only strings, numbers and boolea *Example: json type* ```yml plugin_{name}_{option}: - description: | - JSON type + description: JSON type type: json default: | { diff --git a/source/plugins/community/nightscout/README.md b/source/plugins/community/nightscout/README.md index e846bf99..97a692cb 100644 --- a/source/plugins/community/nightscout/README.md +++ b/source/plugins/community/nightscout/README.md @@ -2,7 +2,7 @@
← Back to plugins index

♐ Code snippet of the day

This plugin displays a random code snippet from your recent activity history.

+

♐ Random code snippet

This plugin displays a random code snippet from recent activity history.

âš ī¸ When improperly configured, this plugin could display private code. If you work with sensitive data or company code, it is advised to keep this plugin disabled. @@ -47,11 +47,14 @@ Use at your own risk, metrics and its authors cannot be held responsibl

plugin_code_lines

Display limit for code snippets

+

Display limit (lines per code snippets)

type: number +(1 ≤ +đ‘Ĩ +≤ 128)
default: 12

plugin_code_visibility

Events visibility

-

Lets you hide private activity when using a repo scope token

+

Can be used to toggle private activity visibility when using a token with repo scope

plugin_code_languages

Restrict display to specific languages

+

Showcased languages

- diff --git a/source/plugins/community/screenshot/README.md b/source/plugins/community/screenshot/README.md index 77495c16..74040692 100644 --- a/source/plugins/community/screenshot/README.md +++ b/source/plugins/community/screenshot/README.md @@ -2,8 +2,8 @@
← Back to plugins index

💉 Nightscout

This plugin lets you display blood sugar values from a Nightscout site.

+

This plugin displays blood sugar values from a Nightscout site.

Authors@legoandmars
- @@ -54,7 +54,7 @@ It can either the full page or a portion restricted by a

plugin_screenshot_url

-
@@ -73,7 +73,7 @@ It can either the full page or a portion restricted by a

plugin_screenshot_background

-
diff --git a/source/plugins/community/stock/README.md b/source/plugins/community/stock/README.md index 0e378035..97763f41 100644 --- a/source/plugins/community/stock/README.md +++ b/source/plugins/community/stock/README.md @@ -37,7 +37,11 @@ - @@ -62,7 +66,7 @@ - diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index 50c59ef2..0ae38eb0 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -43,7 +43,8 @@ - @@ -52,7 +53,8 @@ - @@ -63,7 +65,7 @@ @@ -74,7 +76,7 @@ - @@ -87,7 +89,7 @@ @@ -100,13 +102,17 @@ - - @@ -432,7 +431,7 @@ Most of the time user option must also be set.

@@ -458,7 +457,7 @@ Most of the time user option must also be set.

@@ -582,7 +581,10 @@ Most of the time user option must also be set.

- @@ -622,7 +624,10 @@ Useful to avoid creating a new template just to tweak some styling

- @@ -636,7 +641,10 @@ It is run after transformations and optimizations, but just before resizing.

- diff --git a/source/plugins/discussions/README.md b/source/plugins/discussions/README.md index 6641d79c..aa34e7d3 100644 --- a/source/plugins/discussions/README.md +++ b/source/plugins/discussions/README.md @@ -2,7 +2,7 @@
← Back to plugins index

📸 Website screenshot

This plugin display a screenshot from any website. -It can either the full page or a portion restricted by a CSS selector.

+

This plugin displays a screenshot from any website.

+

It can either show the full page or a portion restricted by a CSS selector.

Authors@lowlighter

Website url

+

Website URL

Display background

+

Background

type: boolean + 🌐 Web instances must configure settings.json: +
    +
  • metrics.npm.optional.chartist
  • +
+type: boolean
default: no

plugin_stock_duration

Time range (relative to current date)

+

Time range

  • 1d: Today
  • 5d: 5 days
  • @@ -76,6 +80,7 @@
  • ytd: Year to date
  • max: All time
+

This is relative to current date

plugin_contributors_base

Base reference (commit, tag, branch, etc.)

+

Base reference

+

Can be a commit, tag, branch, etc.

plugin_contributors_head

Head reference (commit, tag, branch, etc.)

+

Head reference

+

Can be a commit, tag, branch, etc.

plugin_contributors_ignored

Ignored users

-

Useful to ignore bots activity

+

Can be used to ignore bots activity

plugin_contributors_contributions

Toggle number of contributions display

+

Contributions count

Displayed sections

  • contributors: all contributors
  • -
  • categories: contributors sorted by contributions categories
  • +
  • categories: contributors sorted by contributions categories (must be configured with plugin_contributors_categories)

plugin_contributors_categories

Configure contribution categories

-

This option required plugin_contributors_sections to have categories in it to be effective +

Contribution categories

+

This option requires plugin_contributors_sections to have categories in it to be effective. Pass a JSON object mapping category with fileglobs

🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.runner.tempdir
  • +
  • metrics.runner.git
  • +
type: json
default: { diff --git a/source/plugins/core/README.md b/source/plugins/core/README.md index ba1dd815..5e7c7558 100644 --- a/source/plugins/core/README.md +++ b/source/plugins/core/README.md @@ -406,10 +406,9 @@ On forks, this feature is disable to take into account any changes you made on i

token

GitHub Personal Access Token

-

No scopes are required by default, though some plugins and features may require additional scopes

-

When using a configuration which does not requires a GitHub PAT, you may pass NOT_NEEDED instead. -Note that when doing so, all defaults values using .user.* will not be applicable meaning that they need to be filled manually. -Most of the time user option must also be set.

+

No scopes are required by default, though some plugins and features may require additional scopes.

+

When using a configuration which does not requires a GitHub PAT, it is possible to pass NOT_NEEDED instead. +When doing so, any settings which defaults on user fetched values will not be templated (e.g. .user.*) and will usually need to be set manually.

repo

GitHub repository

-

This option is revevalant only for repositories templates

+

This option is only revelant for repositories templates

committer_branch

Target branch

-

Default value is set to your repository default branch

+

Defaults to current repository default branch

🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.run.setup.community.templates
  • +
type: array (comma-separated)
🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.run.user.css
  • +
type: string
🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.run.user.js
  • +
type: string
- @@ -42,7 +42,7 @@ - @@ -53,7 +53,7 @@ diff --git a/source/plugins/followup/README.md b/source/plugins/followup/README.md index 29730e56..e2521e1a 100644 --- a/source/plugins/followup/README.md +++ b/source/plugins/followup/README.md @@ -2,7 +2,7 @@
← Back to plugins index

đŸ’Ŧ Discussions

This plugin displays your GitHub discussions stats.

+

This plugin displays GitHub discussions stats.

Supported features
→ Full specification

plugin_discussions_categories

Toggle discussion categories display

+

Discussion categories

plugin_discussions_categories_limit

Display limit (categories)

-

Note that categories are sorted from highest to lowest count.

+

Note that categories are sorted from highest to lowest count

- @@ -64,14 +64,17 @@ - - diff --git a/source/plugins/habits/README.md b/source/plugins/habits/README.md index 5516abec..462f767c 100644 --- a/source/plugins/habits/README.md +++ b/source/plugins/habits/README.md @@ -1,8 +1,8 @@
← Back to plugins index

đŸŽŸī¸ Follow-up of issues and pull requests

This plugin displays the ratio of open/closed issues and the ratio of open/merged pull requests across all your repositories.

+

This plugin displays the ratio of open/closed issues and the ratio of open/merged pull requests across repositories.

Supported features
→ Full specification
🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
type: boolean
default: no

plugin_followup_archived

Include Issues and Pull requests on the archived repositories.

+

Include archived repositories

- - + @@ -70,7 +70,7 @@ - @@ -81,13 +81,18 @@ - - @@ -102,7 +107,11 @@ Recent language activity may also displayed (it requires extras features to be e - @@ -119,7 +128,7 @@ Recent language activity may also displayed (it requires extras features to be e - diff --git a/source/plugins/introduction/README.md b/source/plugins/introduction/README.md index bcfcc00c..bce51244 100644 --- a/source/plugins/introduction/README.md +++ b/source/plugins/introduction/README.md @@ -3,7 +3,7 @@ @@ -34,7 +34,7 @@ - @@ -44,7 +44,7 @@ - diff --git a/source/plugins/isocalendar/README.md b/source/plugins/isocalendar/README.md index 954f409c..2d739b51 100644 --- a/source/plugins/isocalendar/README.md +++ b/source/plugins/isocalendar/README.md @@ -2,7 +2,7 @@
← Back to plugins index

💡 Coding habits

This plugin display coding habits based on your recent activity, such as active hours and languages recently used.

+

💡 Coding habits and activity

This plugin displays coding habits based on recent activity, such as active hours and languages recently used.

Supported features
→ Full specification

plugin_habits_facts

Toggle midly interesting facts display

+

Midly interesting facts

It includes indentation type, average number of characters per line of code, and most active time and day

plugin_habits_charts

Toggle charts display

+

Charts

It includes commit activity per hour of day and commit activity per day of week Recent language activity may also displayed (it requires extras features to be enabled for web instances) for historical reasons

🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
type: boolean
default: no
type: string + 🌐 Web instances must configure settings.json: +
    +
  • metrics.npm.optional.chartist
  • +
+type: string
default: classic
allowed values:
  • classic
  • chartist

plugin_habits_languages_limit

Limits the number of languages to be displayed

+

Display limit (languages)

← Back to plugins index

🙋 Introduction

This plugin displays account bio or organization/repository description.

-

It is mostly intended for images that will be used outside of GitHub, since these informations are already displayed on GitHub.

+

Since account bio is already displayed on account profile, this plugin is mostly intended for external usage.

Supported features
→ Full specification

plugin_introduction

Display account or repository introduction

+

Enable introduction plugin

plugin_introduction_title

Display introduction section title

+

Section title

- diff --git a/source/plugins/languages/README.md b/source/plugins/languages/README.md index dfb35e9a..5e4fdf76 100644 --- a/source/plugins/languages/README.md +++ b/source/plugins/languages/README.md @@ -1,7 +1,7 @@
← Back to plugins index

📅 Isometric commit calendar

This plugin displays an isometric view of your commit calendar along with a few additional statistics like current streak and average number of commit per day.

+

This plugin displays an isometric view of a user commit calendar along with a few additional statistics like current streak and average number of commit per day.

Supported features
→ Full specification
- + @@ -90,8 +90,8 @@ - @@ -123,11 +123,11 @@ It will be automatically hidden if empty.

- - - - @@ -163,7 +170,12 @@ It will be automatically hidden if empty.

- - - - - - @@ -74,7 +80,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic - @@ -84,7 +90,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic - diff --git a/source/plugins/lines/README.md b/source/plugins/lines/README.md index ecf916b2..2725c9c0 100644 --- a/source/plugins/lines/README.md +++ b/source/plugins/lines/README.md @@ -2,7 +2,7 @@
← Back to plugins index

đŸˆˇī¸ Most used languages

đŸˆˇī¸ Languages activity

This plugin can display which languages you use across all repositories you contributed to.

plugin_languages_other

Group unknown, ignored and over-limit languages into a single "Other" category

-

If this option is enabled, "Other" category will not be subject to plugin_languages_threshold. +

Group unknown, ignored and over-limit languages into "Other" category

+

If this option is enabled, "Other" category will not be subject to plugin_languages_threshold. It will be automatically hidden if empty.

plugin_languages_sections

Displayed sections

+

Note that recently-used is only available when plugin_languages_indepth is enabled

🌐 Web instances must configure settings.json
-type: array +
type: array (comma-separated)
default: most-used
@@ -136,23 +136,30 @@ It will be automatically hidden if empty.

plugin_languages_details

Additional details

-

Note that lines is only available when plugin_languages_indepth is enabled

+

Note that lines is only available when plugin_languages_indepth is enabled

🌐 Web instances must configure settings.json
-type: array +
type: array (comma-separated)
allowed values:
  • bytes-size
  • percentage
  • lines

plugin_languages_indepth

Indepth mode (âš ī¸ read documentation first)

+

Indepth mode

+
+

âš ī¸ read documentation first

+
🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
type: boolean
default: false
🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
type: number (1 ≤ đ‘Ĩ @@ -177,7 +189,12 @@ It will be automatically hidden if empty.

🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
type: array (comma-separated)
@@ -190,7 +207,12 @@ It will be automatically hidden if empty.

🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
type: array (comma-separated)
@@ -203,7 +225,12 @@ It will be automatically hidden if empty.

🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
type: number (100 ≤ đ‘Ĩ @@ -217,7 +244,12 @@ It will be automatically hidden if empty.

🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.api.github.overuse
  • +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
type: number (0 ≤ đ‘Ĩ diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md index a3a9bc74..d44d0f5d 100644 --- a/source/plugins/licenses/README.md +++ b/source/plugins/licenses/README.md @@ -58,7 +58,13 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic
🌐 Web instances must configure settings.json
+
🌐 Web instances must configure settings.json: +
    +
  • metrics.run.tempdir
  • +
  • metrics.run.git
  • +
  • metrics.run.licensed
  • +
  • metrics.run.user.cmd
  • +
type: boolean
default: no

plugin_licenses_ratio

Display used licenses ratio

+

Used licenses ratio

plugin_licenses_legal

Display permissions, limitations and conditions about licenses

+

Permissions, limitations and conditions about used licenses

- diff --git a/source/plugins/music/README.md b/source/plugins/music/README.md index 2ef86e92..2ef1cd8e 100644 --- a/source/plugins/music/README.md +++ b/source/plugins/music/README.md @@ -1,8 +1,8 @@
← Back to plugins index

👨‍đŸ’ģ Lines of code changed

This plugin displays the number of lines of code you have added and removed across all of your repositories.

+

This plugin displays the number of lines of code added and removed across repositories.

Supported features
→ Full specification
- - + @@ -51,7 +51,7 @@
  • lastfm: Last.fm
  • youtube: YouTube Music
  • -

    This setting is optional when using plugin_music_mode: playlist (provider will be auto-detected from plugin_music_playlist URL)

    +

    This setting is optional when using plugin_music_mode: playlist (provider will be auto-detected from plugin_music_playlist URL)

    @@ -75,6 +75,17 @@ + + + + + + + @@ -84,7 +95,7 @@
  • recent: display recently listened tracks
  • top: display top listened artists/tracks
  • -

    If plugin_music_playlist is specifed, the default value is playlist, else it is recent

    +

    If plugin_music_playlist is specifed, the default value is playlist, else it is recent

    @@ -118,7 +129,7 @@ - @@ -128,7 +139,7 @@ - - - - - - - -
    ← Back to plugins index

    đŸŽŧ Music plugin

    This plugin can display top and recently listened music tracks or from a random playlist.

    +

    đŸŽŧ Music activity and suggestions

    This plugin can display top and recently listened music tracks or titles from a random playlist.

    Different music providers are supported.

    🔐 Token
    type: token

    plugin_music_user

    Music provider username

    +
    â¯ī¸ Cannot be preset
    +type: string +
    +default: → User login

    plugin_music_mode

    plugin_music_played_at

    Recently played - Toggle last played timestamp display

    +

    Recently played - Last played timestamp

    plugin_music_time_range

    Top tracks - Time range for top mode

    +

    Top tracks - Time range

    • short: 4 weeks
    • medium: 6 months
    • @@ -157,17 +168,6 @@ default: tracks
      allowed values:
      • tracks
      • artists

    plugin_music_user

    Music provider username

    -
    â¯ī¸ Cannot be preset
    -type: string -
    -default: → User login
    diff --git a/source/plugins/notable/README.md b/source/plugins/notable/README.md index d34180bb..66c3cf2b 100644 --- a/source/plugins/notable/README.md +++ b/source/plugins/notable/README.md @@ -2,7 +2,7 @@ - @@ -46,7 +46,7 @@ @@ -67,7 +67,7 @@ Some repositories may not be able to reported advanced stats and in the case the - - @@ -98,7 +98,10 @@ Some repositories may not be able to reported advanced stats and in the case the - diff --git a/source/plugins/pagespeed/README.md b/source/plugins/pagespeed/README.md index f1c2a7fc..8ed570ab 100644 --- a/source/plugins/pagespeed/README.md +++ b/source/plugins/pagespeed/README.md @@ -1,9 +1,9 @@
    ← Back to plugins index

    🎩 Notable contributions

    This plugin displays badges of repositories where you commited at least once on default branch.

    +

    This plugin displays badges for notable contributions on repositories.

    Supported features
    → Full specification

    Query filter

    Based on GitHub search syntax. Supported fields are stars, forks and watchers

    -

    If plugin_notable_indepth is enabled, commits, commits.user, commits.user% and maintainer fields are also supported. +

    If plugin_notable_indepth is enabled, commits, commits.user, commits.user% and maintainer fields are also supported. Some repositories may not be able to reported advanced stats and in the case the default behaviour will be to bypass filtering

    plugin_notable_from

    Filter by repository owner account type

    +

    Repository owner account type filter

    • all: no filtering
    • organization: only organization accounts repositories
    • @@ -83,8 +83,8 @@ Some repositories may not be able to reported advanced stats and in the case the

    plugin_notable_repositories

    Toggle repository name display

    -

    Note that Repositories hosted by user account will always be fully displayed

    +

    Repository name

    +

    Repositories hosted by user account will always have their full handle displayed

    🌐 Web instances must configure settings.json
    +
    🌐 Web instances must configure settings.json: +
      +
    • metrics.api.github.overuse
    • +
    type: boolean
    default: no
    - - + @@ -42,6 +42,19 @@ It uses type: boolean
    default: no
    +
    + + + + + + @@ -75,7 +88,7 @@ It uses

    plugin_pagespeed_screenshot

    -
    @@ -83,21 +96,10 @@ It uses type: boolean
    default: no
    - -
    - - - - - - diff --git a/source/plugins/people/README.md b/source/plugins/people/README.md index 47f8507f..25d8a714 100644 --- a/source/plugins/people/README.md +++ b/source/plugins/people/README.md @@ -1,7 +1,7 @@
    ← Back to plugins index

    âąī¸ Website performances

    This plugin adds performance statistics of a website. -It uses Google's PageSpeed API (same as web.dev), see performance scoring and score calculator for more informations about results.

    +

    âąī¸ Google PageSpeed

    This plugin displays performance statistics of a website.

    +

    It uses Google's PageSpeed API (same as web.dev), see performance scoring and score calculator for more informations about results.

    Supported features
    → Full specification

    plugin_pagespeed_token

    PageSpeed token

    +
    +

    âš ī¸ While not mandatory, it is strongly advised pass a token to avoid triggering the rate limiter. See PageSpeed documentation for more informations.

    +
    +
    🔐 Token
    +type: token +

    plugin_pagespeed_url

    Display a website screenshot

    +

    Website screenshot

    Significantly increase filesize

    plugin_pagespeed_token

    PageSpeed token

    -

    Although not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See PageSpeed documentation for more informations.

    -
    🔐 Token
    -type: token -

    plugin_pagespeed_pwa

    Display PWA Status

    +

    PWA Status

    - + @@ -56,8 +56,8 @@ - @@ -67,10 +67,9 @@ - @@ -93,7 +92,7 @@ will still be filtered out, but will have their picture replaced by an identicon - @@ -121,7 +123,7 @@ Repositories support the following values: @@ -134,7 +136,7 @@ Repositories support the following values: @@ -145,8 +147,9 @@ The option plugin_people_types must contain the sponsors - diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md index a4b6a8e5..4054213a 100644 --- a/source/plugins/posts/README.md +++ b/source/plugins/posts/README.md @@ -2,7 +2,7 @@
    ← Back to plugins index

    🧑‍🤝‍🧑 People plugin

    🧑‍🤝‍🧑 People

    This plugin can display relationships with users, such as followers, sponsors, contributors, stargazers, watchers, members, etc.

    plugin_people_identicons

    Toggle identicons display

    -

    This can be used to mask user profile pictures for privacy

    +

    Force identicons pictures

    +

    Can be used to mask profile pictures for privacy

    plugin_people_identicons_hide

    Hide identicons display

    -

    This can be used to mask user who did not setup a personal profile picture.

    -

    When used with plugin_people_identicons, users who did not setup a personal profile picture -will still be filtered out, but will have their picture replaced by an identicon instead.

    +

    Hide identicons pictures

    +

    Can be used to mask users without a personal profile picture.

    +

    When used with plugin_people_identicons, users without a personal profile picture will still be filtered out, but their picture will be replaced by an identicon instead

    plugin_people_types

    Displayed sections (order is respected)

    +

    Displayed sections

    User and organization accounts support the following values:

    • followers
    • @@ -101,14 +100,17 @@ will still be filtered out, but will have their picture replaced by an identicon
    • sponsoring/sponsored
    • sponsors
    • members (organization only)
    • -
    • thanks(to be configured with plugin_people_thanks) -Repositories support the following values:
    • +
    • thanks(to be configured with plugin_people_thanks)
    • +
    +

    Repositories support the following values:

    +
    • sponsors (same as owner sponsors)
    • contributors
    • stargazers
    • watchers
    • -
    • thanks(to be configured with plugin_people_thanks)
    • +
    • thanks(to be configured with plugin_people_thanks)
    +

    Specified order is honored

    plugin_people_thanks

    Special thanks

    -

    This list can be used to thank specific users

    +

    Can be used to thank specific users

    plugin_people_sponsors_custom

    Custom sponsors

    This list can be used to add users from unsupported GitHub sponsors sources. -The option plugin_people_types must contain the sponsors section in order for this setting to be effective

    +The option plugin_people_types must contain the sponsors section in order for this setting to be effective

    plugin_people_shuffle

    Shuffle data for varied output

    -

    This will fetch 10 times more data than plugin_people_limit to ensure output is always different

    +

    Shuffle data

    +

    Can be used to create varied outputs +This will fetch additional data (10 times plugin_people_limit) to ensure output is always different

    - @@ -54,10 +54,21 @@ + + + + + + + - @@ -67,7 +78,7 @@ - @@ -88,17 +99,6 @@
    default: 4
    - - - - - - -
    ← Back to plugins index

    âœ’ī¸ Recent posts

    This plugin displays recent articles from a specified external source.

    +

    This plugin displays recent articles from a specified and supported external source.

    Supported features
    → Full specification
    type: string
    allowed values:
    • dev.to
    • hashnode

    plugin_posts_user

    External source username

    +
    â¯ī¸ Cannot be preset
    +type: string +
    +default: → User login

    plugin_posts_descriptions

    Toggle posts descriptions display

    +

    Posts descriptions

    plugin_posts_covers

    Toggle posts cover images display

    +

    Posts cover images

    plugin_posts_user

    External source username

    -
    â¯ī¸ Cannot be preset
    -type: string -
    -default: → User login
    diff --git a/source/plugins/projects/README.md b/source/plugins/projects/README.md index 11739810..484611f8 100644 --- a/source/plugins/projects/README.md +++ b/source/plugins/projects/README.md @@ -1,8 +1,11 @@ - - + @@ -43,7 +46,7 @@ @@ -56,7 +59,7 @@ - @@ -68,7 +71,7 @@ - diff --git a/source/plugins/reactions/README.md b/source/plugins/reactions/README.md index 62d54ff4..20e57220 100644 --- a/source/plugins/reactions/README.md +++ b/source/plugins/reactions/README.md @@ -2,7 +2,7 @@
    ← Back to plugins index

    đŸ—‚ī¸ Active projects

    This plugin displays progress of your profile and repository projects.

    +

    đŸ—‚ī¸ GitHub projects

    This plugin displays progress of profile and repository projects.

    +
    +

    â„šī¸ This plugin currently only supports GitHub projects boards and not GitHub projects (beta)

    +
    Supported features
    → Full specification

    plugin_projects_limit

    Display limit

    -

    Note that plugin_projects_repositories is not affected by this option

    +

    Projects defined by plugin_projects_repositories are not affected by this option

    plugin_projects_repositories

    List of repositories projects

    +

    Featured repositories projects

    Use the following syntax for each project :user/:repo/projects/:project_id

    plugin_projects_descriptions

    Toggle projects descriptions display

    +

    Projects descriptions

    - @@ -134,7 +134,7 @@ diff --git a/source/plugins/repositories/README.md b/source/plugins/repositories/README.md index 215c1da7..1a3dc741 100644 --- a/source/plugins/repositories/README.md +++ b/source/plugins/repositories/README.md @@ -1,11 +1,11 @@
    ← Back to plugins index

    🎭 Comment reactions

    This plugin displays overall reactions on your recent issues, comments and discussions.

    +

    This plugin displays overall user reactions on recent issues, comments and discussions.

    Supported features
    → Full specification

    plugin_reactions_ignored

    Ignored users

    -

    Useful to ignore bots activity

    +

    Can be used to ignore bots activity

    - + @@ -47,8 +47,8 @@ - @@ -59,7 +59,7 @@ - diff --git a/source/plugins/skyline/README.md b/source/plugins/skyline/README.md index e094618c..38793bea 100644 --- a/source/plugins/skyline/README.md +++ b/source/plugins/skyline/README.md @@ -1,8 +1,8 @@
    ← Back to plugins index

    📓 Repositories

    📓 Featured repositories

    This plugin displays a list of chosen featured repositories.

    -

    It is mostly intended for images that will be used outside of GitHub, since it is already possible to pin repositories on GitHub.

    +

    Since it is possible to pin repositories on GitHub, this plugin is mostly intended for external usage.

    -

    âš ī¸ People will not be able to click on it due to limitations of using SVG inside <img> tags.

    +

    âš ī¸ Due to limitations of using SVG images inside <img> tags, clicking on a repository card will not redirect to repository page.

    plugin_repositories_featured

    List of featured repositories

    -

    If no owner is specified, it will implicitly use the current account login

    +

    Featured repositories

    +

    Current user will be used when no owner is specified

    plugin_repositories_pinned

    Display pinned repositories

    +

    Pinned repositories

    - - + - @@ -87,7 +91,7 @@ A higher number of frames will increase file size.

    diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md index e58ca70b..8bc26cec 100644 --- a/source/plugins/sponsors/README.md +++ b/source/plugins/sponsors/README.md @@ -60,10 +60,10 @@ - diff --git a/source/plugins/stackoverflow/README.md b/source/plugins/stackoverflow/README.md index 65878e58..77ee128a 100644 --- a/source/plugins/stackoverflow/README.md +++ b/source/plugins/stackoverflow/README.md @@ -1,8 +1,8 @@
    ← Back to plugins index

    🌇 GitHub Skyline 3D calendar

    This plugins lets you display your 3D commits calendar from skyline.github.com.

    +

    🌇 GitHub Skyline

    This plugin displays the 3D commits calendar from skyline.github.com.

    âš ī¸ This plugin significantly increase file size, consider using it as standalone.

    @@ -39,7 +39,11 @@
    type: boolean + 🌐 Web instances must configure settings.json: +
      +
    • metrics.npm.optional.gifencoder
    • +
    +type: boolean
    default: no

    plugin_skyline_compatibility

    Compatibility mode

    -

    This uses CSS animations rather than embedded GIF to support a widerr range of browser, like Firefox and Safari. +

    This uses CSS animations rather than embedded GIF to support a wider range of browsers, like Firefox and Safari. Using this mode significantly increase file size as each frame is encoded separately

    plugin_sponsors_past

    Display past sponsorships

    -

    This feature requires a token from target account, as past sponsorships are gathered from sponsors activity and is private data.

    +

    Past sponsorships

    +

    A token from target user must be specified to use this feature, as past sponsorships are gathered from sponsors activity which is private data.

    -

    âš ī¸ Past sponsorships does not respect sponsors privacy because of current GitHub API limitations. This may be fixed in future releases.

    +

    âš ī¸ Past sponsorships does not respect sponsors privacy because of current GitHub API limitations. This may be fixed in a future release.

    - - + @@ -71,7 +71,7 @@ - @@ -84,8 +84,8 @@ - @@ -98,7 +98,7 @@ - diff --git a/source/plugins/stargazers/README.md b/source/plugins/stargazers/README.md index 7609d078..a0566088 100644 --- a/source/plugins/stargazers/README.md +++ b/source/plugins/stargazers/README.md @@ -2,7 +2,7 @@
    ← Back to plugins index

    đŸ—¨ī¸ StackOverflow plugin

    This plugin displays stats, questions and answer from stackoverflow.

    +

    đŸ—¨ī¸ Stack Overflow

    This plugin displays stats, questions and answer from Stack Overflow.

    Supported features
    → Full specification

    plugin_stackoverflow_limit

    Display limit (per section)

    +

    Display limit (entries per section)

    plugin_stackoverflow_lines

    Display limit for questions and answers

    -

    Code snippets count as a single line and must be configured with plugin_stackoverflow_lines_snippet instead

    +

    Display limit (lines per questions and answers)

    +

    Code snippets count as a single line and must be configured with plugin_stackoverflow_lines_snippet instead

    plugin_stackoverflow_lines_snippet

    Display limit for code snippets

    +

    Display limit (lines per code snippets)

    - @@ -51,7 +51,11 @@ - diff --git a/source/plugins/starlists/README.md b/source/plugins/starlists/README.md index 3c2349a0..21a8c121 100644 --- a/source/plugins/starlists/README.md +++ b/source/plugins/starlists/README.md @@ -1,8 +1,8 @@
    ← Back to plugins index

    ✨ Stargazers over last weeks

    This plugin displays your stargazers evolution across all of your repositories over the last two weeks.

    +

    This plugin displays stargazers evolution across affiliated repositories over the last two weeks.

    Supported features
    → Full specification
    type: string + 🌐 Web instances must configure settings.json: +
      +
    • metrics.npm.optional.chartist
    • +
    +type: string
    default: classic
    allowed values:
    • classic
    • chartist
    - - + @@ -69,7 +69,7 @@ - @@ -79,7 +79,7 @@ - @@ -92,7 +92,8 @@ - @@ -103,7 +104,7 @@ @@ -113,9 +114,9 @@ - diff --git a/source/plugins/stars/README.md b/source/plugins/stars/README.md index 60a25e52..c5f85dcb 100644 --- a/source/plugins/stars/README.md +++ b/source/plugins/stars/README.md @@ -2,7 +2,7 @@
    ← Back to plugins index

    đŸ’Ģ Starlists

    This plugin displays your star lists.

    +

    đŸ’Ģ Star lists

    This plugin displays star lists.

    Supported features
    → Full specification

    plugin_starlists_languages

    Toggle star list languages statistics

    +

    Star lists languages statistics

    plugin_starlists_limit_languages

    Disply limit (languages per star list)

    +

    Display limit (languages per star list)

    plugin_starlists_shuffle_repositories

    Shuffle data for varied outputs

    +

    Shuffle data

    +

    Can be used to create varied outputs

    plugin_starlists_ignored

    Skipped star lists

    -

    This is case and emojis insensitive

    +

    Case and emojis insensitive

    plugin_starlists_only

    Restrict display to specified star lists

    -

    This is case and emojis insensitive. -This option is equivalent to plugin_starlists_ignored with all star lists but the ones listed in this option

    +

    Showcased star lists

    +

    Case and emojis insensitive.

    +

    Equivalent to plugin_starlists_ignored with all star lists except the ones listed in this option

    - diff --git a/source/plugins/support/README.md b/source/plugins/support/README.md index f3291b7a..f8a5ab5c 100644 --- a/source/plugins/support/README.md +++ b/source/plugins/support/README.md @@ -2,7 +2,7 @@
    ← Back to plugins index

    🌟 Recently starred repositories

    This plugin displays your recently starred repositories.

    +

    This plugin displays recently starred repositories.

    Supported features
    → Full specification
    - diff --git a/source/plugins/topics/README.md b/source/plugins/topics/README.md index d144411b..9398f19a 100644 --- a/source/plugins/topics/README.md +++ b/source/plugins/topics/README.md @@ -2,8 +2,8 @@
    ← Back to plugins index

    💭 GitHub Community Support

    This plugin displays your statistics from GitHub Support Community (an account must be created on it beforehand).

    +

    This plugin displays statistics from a GitHub Support Community account.

    Supported features
    → Full specification
    - @@ -44,10 +44,10 @@ Check out GitHub topics to search intere - - @@ -79,7 +79,6 @@ Check out GitHub topics to search intere diff --git a/source/plugins/traffic/README.md b/source/plugins/traffic/README.md index bf02467f..a7e2c462 100644 --- a/source/plugins/traffic/README.md +++ b/source/plugins/traffic/README.md @@ -2,7 +2,7 @@
    ← Back to plugins index

    📌 Starred topics

    This plugin displays starred topics. -Check out GitHub topics to search interesting topics.

    +

    This plugin displays starred topics.

    +

    Check out GitHub topics to search interesting topics.

    Supported features
    → Full specification

    plugin_topics_mode

    Display mode:

    +

    Display mode

    • labels: display labels
    • -
    • icons: display icons (topics without icons will be ignored)
    • +
    • icons: display icons (topics without icons will not be displayed)
    • starred: alias for labels
    • mastered: alias for icons
    @@ -61,12 +61,12 @@ Check out GitHub topics to search intere

    plugin_topics_sort

    Sorting method:

    +

    Sorting method

    • stars: sort by most stars
    • activity: sort by recent activity
    • -
    • starred: sort by the date you starred them
    • -
    • random: sort topics randomly
    • +
    • starred: sort by starred date
    • +
    • random: sort randomly

    plugin_topics_limit

    Display limit

    -

    When using plugin_topics_mode: labels, an ellipsis will be displayed

    - diff --git a/source/plugins/tweets/README.md b/source/plugins/tweets/README.md index 9aee0758..67f4fceb 100644 --- a/source/plugins/tweets/README.md +++ b/source/plugins/tweets/README.md @@ -2,7 +2,7 @@
    ← Back to plugins index

    🧮 Repositories traffic

    This plugin displays the number of page views across your repositories.

    +

    This plugin displays the number of page views across affiliated repositories.

    Supported features
    → Full specification
    - @@ -50,10 +50,22 @@ + + + + + + + - @@ -74,17 +86,6 @@
    default: 2
    - - - - - - -
    ← Back to plugins index

    🐤 Latest tweets

    This plugin displays the latest tweets from your Twitter account.

    +

    This plugin displays the latest tweets from a Twitter account.

    Supported features
    → Full specification
    🔐 Token
    type: token

    plugin_tweets_user

    Twitter username

    +
    â¯ī¸ Cannot be preset
    +type: string +
    +default: → User attached twitter

    plugin_tweets_attachments

    Display tweets attachments (images, video previews, etc.)

    +

    Tweets attachments

    +

    Can be used to display linked images, video thumbnails, etc.

    plugin_tweets_user

    Twitter username

    -
    â¯ī¸ Cannot be preset
    -type: string -
    -default: → User attached twitter
    diff --git a/source/plugins/wakatime/README.md b/source/plugins/wakatime/README.md index c2ffe391..5555a4b7 100644 --- a/source/plugins/wakatime/README.md +++ b/source/plugins/wakatime/README.md @@ -1,8 +1,9 @@ - - + @@ -49,57 +50,11 @@ - - - - - - - - - - - - - - - - - - - - - - @@ -117,10 +72,56 @@ type:string
    default: current
    + + + + + + + + + + + + + + + + + + + + + - @@ -141,7 +142,7 @@ diff --git a/source/templates/classic/README.md b/source/templates/classic/README.md index 904f010e..8cc57925 100644 --- a/source/templates/classic/README.md +++ b/source/templates/classic/README.md @@ -7,7 +7,7 @@ This is also the default template.

    - + diff --git a/source/templates/repository/README.md b/source/templates/repository/README.md index ef1e6f37..5dd04bdf 100644 --- a/source/templates/repository/README.md +++ b/source/templates/repository/README.md @@ -6,7 +6,7 @@ - + diff --git a/source/templates/terminal/README.md b/source/templates/terminal/README.md index e0cf2d01..f96338d0 100644 --- a/source/templates/terminal/README.md +++ b/source/templates/terminal/README.md @@ -6,7 +6,7 @@ - +
    ← Back to plugins index

    ⏰ WakaTime plugin

    This plugin displays statistics from your WakaTime account.

    +

    ⏰ WakaTime

    This plugin displays statistics from a WakaTime account.

    +

    It is also compatible with self-hosted instances from wakapi.

    Supported features
    → Full specification
    🔐 Token
    type: token

    plugin_wakatime_days

    Time range

    -
    type: string -
    -default: 7
    -allowed values:
    • 7
    • 30
    • 180
    • 365

    plugin_wakatime_sections

    Displayed sections

    -
      -
    • time: show total coding time and daily average
    • -
    • projects: show most time spent project
    • -
    • projects-graphs: show most time spent projects graphs
    • -
    • languages: show most language
    • -
    • languages-graphs: show languages graphs
    • -
    • editors: show most used code editor
    • -
    • editors-graphs: show code editors graphs
    • -
    • os: show most used operating system
    • -
    • os-graphs: show code operating systems graphs
    • -
    -
    type: array -
    -default: time, projects, projects-graphs, languages, languages-graphs, editors, os
    -allowed values:
    • time
    • projects
    • projects-graphs
    • languages
    • languages-graphs
    • editors
    • editors-graphs
    • os
    • os-graphs

    plugin_wakatime_limit

    Display limit (per graph)

    -
    type: number -(0 ≤ -đ‘Ĩ) -
    -zero behaviour: disable
    -default: 5

    plugin_wakatime_url

    WakaTime url

    -

    Also compatible with self-hosted instance (wakapi)

    +

    WakaTime URL

    +

    Can be used to specify a wakapi instance

    plugin_wakatime_sections

    Displayed sections

    +
      +
    • time: show total coding time and daily average
    • +
    • projects: show most time spent project
    • +
    • projects-graphs: show most time spent projects graphs
    • +
    • languages: show most used language
    • +
    • languages-graphs: show languages graphs
    • +
    • editors: show most used code editor
    • +
    • editors-graphs: show code editors graphs
    • +
    • os: show most used operating system
    • +
    • os-graphs: show operating systems graphs
    • +
    +
    type: array +
    +default: time, projects, projects-graphs, languages, languages-graphs, editors, os
    +allowed values:
    • time
    • projects
    • projects-graphs
    • languages
    • languages-graphs
    • editors
    • editors-graphs
    • os
    • os-graphs

    plugin_wakatime_days

    Time range

    +
    type: string +
    +default: 7
    +allowed values:
    • 7
    • 30
    • 180
    • 365

    plugin_wakatime_limit

    Display limit (entries per graph)

    +
    type: number +(0 ≤ +đ‘Ĩ) +
    +zero behaviour: disable
    +default: 5

    plugin_wakatime_languages_other

    Include other languages

    +

    Other languages

    plugin_wakatime_repositories_visibility

    Repositories visibility

    -

    Lets you hide private repositories.

    +

    Can be used to toggle private activity visibility

    Supported features
    → Full specification
    🏆 📰 🌸 📆 ♐ đŸĨ  💉 💩 📸 💹 đŸ’Ŧ đŸŽŸī¸ đŸŽĢ 💡 🙋 📅 đŸˆˇī¸ 👨‍đŸ’ģ đŸŽŧ 🎩 âąī¸ 🧑‍🤝‍🧑 âœ’ī¸ đŸ—‚ī¸ 🎭 📓 đŸ—ŧ 🌇 💕 đŸ—¨ī¸ ✨ đŸ’Ģ 🌟 💭 📌 🧮 🐤 ⏰🏆 📰 🌸 📆 ♐ đŸĨ  💉 💩 📸 💹 đŸ’Ŧ đŸŽŸī¸ đŸŽĢ 💡 🙋 📅 đŸˆˇī¸ 👨‍đŸ’ģ đŸŽŧ 🎩 âąī¸ 🧑‍🤝‍🧑 âœ’ī¸ đŸ—‚ī¸ 🎭 📓 đŸ—ŧ 🌇 💕 đŸ—¨ī¸ ✨ đŸ’Ģ 🌟 💭 📌 🧮 🐤 ⏰
    👤 Users đŸ‘Ĩ Organizations
    Supported features
    → Full specification
    📰 📸 💹 🏅 đŸŽŸī¸ 🙋 đŸˆˇī¸ 📜 👨‍đŸ’ģ âąī¸ 🧑‍🤝‍🧑 âœ’ī¸ đŸ—‚ī¸ đŸ—ŧ 💕 ✨ 🧮📰 📸 💹 🏅 đŸŽŸī¸ 🙋 đŸˆˇī¸ 📜 👨‍đŸ’ģ âąī¸ 🧑‍🤝‍🧑 âœ’ī¸ đŸ—‚ī¸ đŸ—ŧ 💕 ✨ 🧮
    📓 Repositories
    Supported features
    → Full specification
    📸 đŸŽĢ 📅 đŸˆˇī¸ 👨‍đŸ’ģ âąī¸ 🧮📸 đŸŽĢ 📅 đŸˆˇī¸ 👨‍đŸ’ģ âąī¸ 🧮
    👤 Users đŸ‘Ĩ Organizations