From a291e35774786fac31a691977a7005cb5d9787c0 Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Thu, 4 Nov 2021 19:33:29 -0400 Subject: [PATCH] docs: remove `cost`, document missing options and improve docs (#653) --- .github/quickstart/plugin/metadata.yml | 1 - .../partials/documentation/compatibility.md | 2 +- CONTRIBUTING.md | 3 +-- source/app/metrics/metadata.mjs | 5 ++++- source/plugins/achievements/README.md | 11 ++++++----- source/plugins/achievements/metadata.yml | 1 - source/plugins/activity/README.md | 10 +++++++--- source/plugins/activity/metadata.yml | 3 +-- source/plugins/anilist/README.md | 12 ++++++------ source/plugins/anilist/metadata.yml | 1 - source/plugins/base/README.md | 2 ++ source/plugins/base/metadata.yml | 3 +-- source/plugins/code/README.md | 1 + source/plugins/code/metadata.yml | 5 ++--- source/plugins/contributors/README.md | 6 ++++++ source/plugins/contributors/metadata.yml | 1 - source/plugins/core/metadata.yml | 1 - source/plugins/discussions/metadata.yml | 1 - source/plugins/followup/metadata.yml | 1 - source/plugins/gists/metadata.yml | 1 - source/plugins/habits/metadata.yml | 1 - source/plugins/introduction/metadata.yml | 1 - source/plugins/isocalendar/metadata.yml | 1 - source/plugins/languages/README.md | 8 +++++--- source/plugins/languages/metadata.yml | 3 +-- source/plugins/licenses/metadata.yml | 1 - source/plugins/lines/README.md | 1 + source/plugins/lines/metadata.yml | 3 +-- source/plugins/music/README.md | 14 ++++++-------- source/plugins/music/metadata.yml | 1 - source/plugins/nightscout/metadata.yml | 1 - source/plugins/notable/README.md | 19 +++++++++++++++---- source/plugins/notable/metadata.yml | 1 - source/plugins/pagespeed/metadata.yml | 1 - source/plugins/people/metadata.yml | 1 - source/plugins/posts/README.md | 3 +++ source/plugins/posts/metadata.yml | 1 - source/plugins/projects/metadata.yml | 1 - source/plugins/reactions/README.md | 13 ++++++++----- source/plugins/reactions/metadata.yml | 1 - source/plugins/repositories/metadata.yml | 2 -- source/plugins/rss/metadata.yml | 1 - source/plugins/screenshot/metadata.yml | 1 - source/plugins/skyline/metadata.yml | 1 - source/plugins/sponsors/metadata.yml | 1 - source/plugins/stackoverflow/README.md | 1 + source/plugins/stackoverflow/metadata.yml | 1 - source/plugins/stargazers/metadata.yml | 1 - source/plugins/stars/metadata.yml | 1 - source/plugins/stock/metadata.yml | 1 - source/plugins/support/metadata.yml | 1 - source/plugins/topics/README.md | 6 +++--- source/plugins/topics/metadata.yml | 1 - source/plugins/traffic/metadata.yml | 1 - source/plugins/tweets/metadata.yml | 1 - source/plugins/wakatime/metadata.yml | 1 - 56 files changed, 82 insertions(+), 87 deletions(-) diff --git a/.github/quickstart/plugin/metadata.yml b/.github/quickstart/plugin/metadata.yml index c3bcf608..7e1a39fe 100644 --- a/.github/quickstart/plugin/metadata.yml +++ b/.github/quickstart/plugin/metadata.yml @@ -1,5 +1,4 @@ name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>" -cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services) category: other # Set plugin category ("github", "social" or "other") supports: - user # Support users account diff --git a/.github/readme/partials/documentation/compatibility.md b/.github/readme/partials/documentation/compatibility.md index f259a4ff..10e6499c 100644 --- a/.github/readme/partials/documentation/compatibility.md +++ b/.github/readme/partials/documentation/compatibility.md @@ -10,7 +10,7 @@ <%- name %><%# -%> <% for (const [plugin] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key)))) { %> - <%= readme.compatibility[plugin] ? "✔ī¸" : "❌" %><% } %> + <%= {true:"✔ī¸", false:"❌", embed:"✓"}[readme.compatibility[plugin]] %><% } %> <% } %> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ecaa4680..9c6c2beb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -423,8 +423,7 @@ For example: Here's an example: ```yaml name: "🧩 Plugin name (with emoji icon)" -cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services) -category: github # Plugin category ("github", "social" or "other") +category: github # Plugin category ("github", "social" or "other") index: ~ # Leave as it (this is used to order plugins on metrics README.md) supports: - user # Support users account diff --git a/source/app/metrics/metadata.mjs b/source/app/metrics/metadata.mjs index 7f7ab9e5..886e07c9 100644 --- a/source/app/metrics/metadata.mjs +++ b/source/app/metrics/metadata.mjs @@ -297,7 +297,10 @@ metadata.template = async function({__templates, name, plugins, logger}) { supports:meta.supports ?? null, readme:{ demo:readme.match(/(?[\s\S]*?<[/]table>)/)?.groups?.demo?.replace(/<[/]?(?:table|tr)>/g, "")?.trim() ?? (name === "community" ? '' : ""), - compatibility:{...compatibility, base:true}, + compatibility:{ + ...Object.fromEntries(Object.entries(compatibility).filter(([_, value]) => value)), + ...Object.fromEntries(Object.entries(compatibility).filter(([_, value]) => !value).map(([key, _]) => [key, "embed"])), + }, }, check({q, account = "bypass", format = null}) { //Support check diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md index 98eb710f..5e107254 100644 --- a/source/plugins/achievements/README.md +++ b/source/plugins/achievements/README.md @@ -36,9 +36,10 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, with: # ... other options plugin_achievements: yes - plugin_achievements_threshold: B # Display achievements with rank B or higher - plugin_achievements_secrets: yes # Display unlocked secrets achievements - plugin_achievements_ignored: octonaut # Hide octonaut achievement - plugin_achievements_limit: 0 # Display all unlocked achievement matching threshold and secrets params - plugin_achievements_display: compact # Use compact display + plugin_achievements_threshold: B # Display achievements with rank B or higher + plugin_achievements_secrets: yes # Display unlocked secrets achievements + plugin_achievements_display: compact # Use compact display + plugin_achievements_limit: 0 # Display all unlocked achievements (no limit) + plugin_achievements_ignored: octonaut # Hide "octonaut" achievement + plugin_achievements_only: explorer # Display only "explorer" achievement (don't use with "ignored" option) ``` diff --git a/source/plugins/achievements/metadata.yml b/source/plugins/achievements/metadata.yml index 11c05afd..af22db5d 100644 --- a/source/plugins/achievements/metadata.yml +++ b/source/plugins/achievements/metadata.yml @@ -1,5 +1,4 @@ name: "🏆 Achievements" -cost: ~5 GraphQL request category: github index: 17 supports: diff --git a/source/plugins/activity/README.md b/source/plugins/activity/README.md index ede2547c..ea26ea8e 100644 --- a/source/plugins/activity/README.md +++ b/source/plugins/activity/README.md @@ -38,7 +38,11 @@ Use a full `repo` scope token to display **private** events. with: # ... other options plugin_activity: yes - plugin_activity_limit: 5 # Limit to 5 events - plugin_activity_days: 14 # Keep only events from last 14 days (can be set to 0 to disable limitations) - plugin_activity_filter: all # Show all events (use table above to filter events types) + plugin_activity_limit: 5 # Limit to 5 events + plugin_activity_load: 100 # Load up to 100 recent events from API (should be higher than "limit") + plugin_activity_days: 14 # Keep only events from last 14 days (set to 0 for no limit) + plugin_activity_filter: all # Show all events (use table above to filter events types) + plugin_activity_visibility: public # Only display public events + plugin_activity_timestamps: yes # Display events timestamps + plugin_activity_skipped: repo # Ignored repositories ``` diff --git a/source/plugins/activity/metadata.yml b/source/plugins/activity/metadata.yml index 4ccdde6e..b76ce3ad 100644 --- a/source/plugins/activity/metadata.yml +++ b/source/plugins/activity/metadata.yml @@ -1,5 +1,4 @@ name: "📰 Recent activity" -cost: 1 REST request per 100 events category: github index: 16 supports: @@ -86,4 +85,4 @@ inputs: type: array format: comma-separated default: "" - example: my-repo-1, my-repo-2, owner/repo-3 ... \ No newline at end of file + example: my-repo-1, my-repo-2, owner/repo-3, ... \ No newline at end of file diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index dd6cacec..389347a6 100644 --- a/source/plugins/anilist/README.md +++ b/source/plugins/anilist/README.md @@ -32,10 +32,10 @@ These sections can also be filtered by media type, which can be either `anime`, with: # ... other options plugin_anilist: yes - plugin_anilist_medias: anime, manga # Display both animes and mangas - plugin_anilist_sections: favorites, characters # Display only favorites and characters sections - plugin_anilist_limit: 2 # Limit to 2 entry per section (characters section excluded) - plugin_anilist_shuffle: yes # Shuffle data for more varied outputs - plugin_anilist_user: .user.login # Use same username as GitHub login - plugin_anilist_limit_characters: 22 # Limit to 22 characters in characters section + plugin_anilist_medias: anime, manga # Display both animes and mangas + plugin_anilist_sections: favorites, characters # Display only favorites and characters sections + plugin_anilist_limit: 2 # Limit to 2 entry per section (characters section excluded) + plugin_anilist_limit_characters: 22 # Limit to 22 characters in characters section + plugin_anilist_shuffle: yes # Shuffle data for more varied outputs + plugin_anilist_user: .user.login # Use same username as GitHub login ``` diff --git a/source/plugins/anilist/metadata.yml b/source/plugins/anilist/metadata.yml index 7d6b43a5..d29da9e7 100644 --- a/source/plugins/anilist/metadata.yml +++ b/source/plugins/anilist/metadata.yml @@ -1,5 +1,4 @@ name: "🌸 Anilist watch list and reading list" -cost: N/A category: social index: 4 supports: diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index 42fed0eb..140fec42 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -34,7 +34,9 @@ These are all enabled by default, but you can explicitely opt out from them. # ... other options base: header, repositories # Only display "header" and "repositories" sections repositories: 100 # Query only last 100 repositories + repositories_batch: 25 # Query repositories 25 by 25 (lower this to avoid API timeouts) repositories_forks: no # Don't include forks repositories_affiliations: owner, collaborator # Display only repositories where user is owner or collaborator repositories_skipped: lowlighter/lowlighter # Exclude automatically "lowlighter/lowlighter" repository from plugins allowing a skip list + commits_authoring: octocat@github.com # Handle you use when authoring commits, which can be used to filter commits in other plugins ``` diff --git a/source/plugins/base/metadata.yml b/source/plugins/base/metadata.yml index a4f3069f..afcfd4d4 100644 --- a/source/plugins/base/metadata.yml +++ b/source/plugins/base/metadata.yml @@ -1,5 +1,4 @@ name: "🗃ī¸ Base content" -cost: 2 GraphQL requests + 1 GraphQL request per 100 repositories fetched category: core supports: - user @@ -64,7 +63,7 @@ inputs: type: array format: comma-separated default: "" - example: my-repo-1, my-repo-2, owner/repo-3 ... + example: my-repo-1, my-repo-2, owner/repo-3, ... # List of surnames or email addresses you use when authoring commits # These are mostly used to perform commits analysis to detect ownership diff --git a/source/plugins/code/README.md b/source/plugins/code/README.md index 276543e9..48f92777 100644 --- a/source/plugins/code/README.md +++ b/source/plugins/code/README.md @@ -24,4 +24,5 @@ Display a random code snippet from your recent activity history. plugin_code_load: 100 # Fetch 100 events from activity plugin_code_visibility: public # Only display snippets from public activity plugin_code_skipped: github/octocat # Skip github/octocat repository + plugin_code_languages: javascript # Limit code snippets to JavaScript code ``` \ No newline at end of file diff --git a/source/plugins/code/metadata.yml b/source/plugins/code/metadata.yml index 7c81427f..ec8b6d26 100644 --- a/source/plugins/code/metadata.yml +++ b/source/plugins/code/metadata.yml @@ -1,5 +1,4 @@ name: "♐ Code snippet of the day" -cost: 1 REST request per 100 events fetched category: github index: 22 supports: @@ -44,7 +43,7 @@ inputs: type: array format: comma-separated default: "" - example: my-repo-1, my-repo-2, owner/repo-3 ... + example: my-repo-1, my-repo-2, owner/repo-3, ... # Restrict code snippet languages # These are guessed through linguist @@ -53,4 +52,4 @@ inputs: type: array format: comma-separated default: "" - example: javascript, typescript, .... \ No newline at end of file + example: javascript, typescript, ... \ No newline at end of file diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index bcc5f86a..723ceae9 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -49,4 +49,10 @@ Matching is performed in keys order. plugin_contributors_ignored: bot # Ignore "bot" user plugin_contributors_contributions: yes # Display number of contributions for each contributor plugin_contributors_sections: contributors # Display contributors sections + plugin_contributors_categories: | # A JSON mapping of labels by files edited + { + "📚 Documentation": ["README.md", "docs/**"], + "đŸ’ģ Code": ["source/**", "src/**"], + "#ī¸âƒŖ Others": ["*"] + } ``` \ No newline at end of file diff --git a/source/plugins/contributors/metadata.yml b/source/plugins/contributors/metadata.yml index 0be209bc..6dc7f83e 100644 --- a/source/plugins/contributors/metadata.yml +++ b/source/plugins/contributors/metadata.yml @@ -1,5 +1,4 @@ name: "🏅 Repository contributors" -cost: N/A category: github index: 5 supports: diff --git a/source/plugins/core/metadata.yml b/source/plugins/core/metadata.yml index 0c10d90c..e01779d5 100644 --- a/source/plugins/core/metadata.yml +++ b/source/plugins/core/metadata.yml @@ -1,5 +1,4 @@ name: "🧱 Core" -cost: N/A category: core supports: - user diff --git a/source/plugins/discussions/metadata.yml b/source/plugins/discussions/metadata.yml index 56756647..7b21ca2f 100644 --- a/source/plugins/discussions/metadata.yml +++ b/source/plugins/discussions/metadata.yml @@ -1,5 +1,4 @@ name: "đŸ’Ŧ Discussions" -cost: 1 GraphQL request + 1 GraphQL request per 100 discussions started category: github index: 18 supports: diff --git a/source/plugins/followup/metadata.yml b/source/plugins/followup/metadata.yml index a0d75f8e..42210f2c 100644 --- a/source/plugins/followup/metadata.yml +++ b/source/plugins/followup/metadata.yml @@ -1,5 +1,4 @@ name: "🎟ī¸ Follow-up of issues and pull requests" -cost: 0 API request (1 GraphQL request if "user" section is enabled) category: github index: 11 supports: diff --git a/source/plugins/gists/metadata.yml b/source/plugins/gists/metadata.yml index acf66bd3..777a874a 100644 --- a/source/plugins/gists/metadata.yml +++ b/source/plugins/gists/metadata.yml @@ -1,5 +1,4 @@ name: "đŸŽĢ Gists" -cost: 1 GraphQL request per 100 gists category: github index: 10 supports: diff --git a/source/plugins/habits/metadata.yml b/source/plugins/habits/metadata.yml index f2fa1d83..42a23b43 100644 --- a/source/plugins/habits/metadata.yml +++ b/source/plugins/habits/metadata.yml @@ -1,5 +1,4 @@ name: "💡 Coding habits" -cost: 1 REST request per 100 events + 1 REST request per commit category: github index: 3 supports: diff --git a/source/plugins/introduction/metadata.yml b/source/plugins/introduction/metadata.yml index 8e6113e9..279c0edf 100644 --- a/source/plugins/introduction/metadata.yml +++ b/source/plugins/introduction/metadata.yml @@ -1,5 +1,4 @@ name: "🙋 Introduction" -cost: 1 GraphQL request category: github index: 2 supports: diff --git a/source/plugins/isocalendar/metadata.yml b/source/plugins/isocalendar/metadata.yml index a0ee1546..204f7457 100644 --- a/source/plugins/isocalendar/metadata.yml +++ b/source/plugins/isocalendar/metadata.yml @@ -1,5 +1,4 @@ name: "📅 Isometric commit calendar" -cost: 1-2 GraphQL requests + 1 GraphQL request per year category: github index: 0 supports: diff --git a/source/plugins/languages/README.md b/source/plugins/languages/README.md index 987961a7..a3e0a8f0 100644 --- a/source/plugins/languages/README.md +++ b/source/plugins/languages/README.md @@ -52,16 +52,18 @@ For better results, it's advised to add either your surnames and eventually no-r plugin_languages: yes plugin_languages_ignored: html, css # List of languages to ignore plugin_languages_skipped: my-test-repo # List of repositories to skip + plugin_languages_limit: 8 # Display up to 8 languages + plugin_languages_sections: most-used, recently-used # Display most used and recently used plugin_languages_colors: "0:orange, javascript:#ff0000, ..." # Make most used languages orange and JavaScript red plugin_languages_aliases: "JavaScript:JS, TypeScript:TS, ..." # Customize languages names with aliases plugin_languages_details: bytes-size, percentage # Additionally display total bytes size and percentage plugin_languages_threshold: 2% # Hides all languages less than 2% - plugin_languages_limit: 8 # Display up to 8 languages - plugin_languages_sections: most-used, recently-used # Display most used and recently used languages stats + languages stats plugin_languages_indepth: no # Get indepth stats (see documentation before enabling) + plugin_languages_analysis_timeout: 15 # Set maximum time for indepth analysis plugin_languages_categories: programming # Display only languages that match these categories in most-used section plugin_languages_recent_categories: markup, programming, data # Display only languages that match these categories in recently-used section plugin_languages_recent_load: 500 # Load up to 500 events to compute recently used stats plugin_languages_recent_days: 7 # Limit recently used stats to last week - commits_authoring: lowlighter@users.noreply.github.com # Surnames or email addresses used to identify your commits + commits_authoring: octocat@users.noreply.github.com # Surnames or email addresses used to identify your commits ``` diff --git a/source/plugins/languages/metadata.yml b/source/plugins/languages/metadata.yml index 5ec7ce71..3b9e499b 100644 --- a/source/plugins/languages/metadata.yml +++ b/source/plugins/languages/metadata.yml @@ -1,5 +1,4 @@ name: "🈷ī¸ Most used languages" -cost: 0 API request (1 per 100 events fetched when using recently-used section) category: github index: 1 supports: @@ -28,7 +27,7 @@ inputs: type: array format: comma-separated default: "" - example: my-repo-1, my-repo-2, owner/repo-3 ... + example: my-repo-1, my-repo-2, owner/repo-3, ... # Number of languages to display # Set to 0 to disable limitations diff --git a/source/plugins/licenses/metadata.yml b/source/plugins/licenses/metadata.yml index 1ca049e6..419bf57d 100644 --- a/source/plugins/licenses/metadata.yml +++ b/source/plugins/licenses/metadata.yml @@ -1,5 +1,4 @@ name: "📜 Repository licenses" -cost: N/A category: github index: 4 supports: diff --git a/source/plugins/lines/README.md b/source/plugins/lines/README.md index 1d798631..bac0d868 100644 --- a/source/plugins/lines/README.md +++ b/source/plugins/lines/README.md @@ -18,4 +18,5 @@ The *lines* of code plugin displays the number of lines of code you have added a with: # ... other options plugin_lines: yes + plugin_lines_skipped: repo # List of skipped repositories ``` diff --git a/source/plugins/lines/metadata.yml b/source/plugins/lines/metadata.yml index a858c842..4eff7039 100644 --- a/source/plugins/lines/metadata.yml +++ b/source/plugins/lines/metadata.yml @@ -1,5 +1,4 @@ name: "👨‍đŸ’ģ Lines of code changed" -cost: 1 REST request per repository category: github index: 12 supports: @@ -20,4 +19,4 @@ inputs: type: array format: comma-separated default: "" - example: my-repo-1, my-repo-2, owner/repo-3 ... \ No newline at end of file + example: my-repo-1, my-repo-2, owner/repo-3, ... \ No newline at end of file diff --git a/source/plugins/music/README.md b/source/plugins/music/README.md index b6a5c95d..fc779c51 100644 --- a/source/plugins/music/README.md +++ b/source/plugins/music/README.md @@ -78,14 +78,14 @@ This mode is not supported for now. plugin_music: yes plugin_music_limit: 4 # Limit to 4 entries plugin_music_playlist: https://******** # Use extracted playlist link - # (plugin_music_provider and plugin_music_mode will be set automatically) + # plugin_music_provider: (will be guessed through plugin_music_playlist) + # plugin_music_mode: (will be set to "playlist" when plugin_music_playlist is provided) ``` ### Recently played & top modes -Recently played: Display tracks you have played recently. - -Top: Display your top artists/tracks for a certain time period. +- **Recently played**: Display tracks you have played recently. +- **Top**: Display your top artists/tracks for a certain time period. Select a music provider below for additional instructions. @@ -198,7 +198,6 @@ Register your API key to finish setup. plugin_music_limit: 4 # Limit to 4 entries plugin_music_user: .user.login # Use same username as GitHub login plugin_music_token: ${{ secrets.LASTFM_API_KEY }} - ``` ##### Top @@ -210,8 +209,8 @@ Register your API key to finish setup. plugin_music: yes plugin_music_provider: spotify # Use Spotify as provider plugin_music_mode: top # Set plugin mode - plugin_music_top_type: tracks # Set type for "top" mode; either tracks or artists plugin_music_limit: 4 # Limit to 4 entries, maximum is 50 for "top" mode with spotify + plugin_music_top_type: tracks # Set type for "top" mode; either tracks or artists plugin_music_time_range: short # Set time range for "top" mode; either short (4 weeks), medium (6 months) or long (several years) plugin_music_token: "${{ secrets.SPOTIFY_CLIENT_ID }}, ${{ secrets.SPOTIFY_CLIENT_SECRET }}, ${{ secrets.SPOTIFY_REFRESH_TOKEN }}" ``` @@ -223,10 +222,9 @@ Register your API key to finish setup. plugin_music: yes plugin_music_provider: lastfm # Use Last.fm as provider plugin_music_mode: top # Set plugin mode - plugin_music_top_type: artists # Set type for "top" mode; either tracks or artists plugin_music_limit: 4 # Limit to 4 entries + plugin_music_top_type: artists # Set type for "top" mode; either tracks or artists plugin_music_time_range: long # Set time range for "top" mode; either short (4 weeks), medium (6 months) or long (several years) plugin_music_user: .user.login # Use same username as GitHub login plugin_music_token: ${{ secrets.LASTFM_API_KEY }} - ``` diff --git a/source/plugins/music/metadata.yml b/source/plugins/music/metadata.yml index 2f38fcb3..6b7dc4b3 100644 --- a/source/plugins/music/metadata.yml +++ b/source/plugins/music/metadata.yml @@ -1,5 +1,4 @@ name: "đŸŽŧ Music plugin" -cost: N/A category: social index: 2 supports: diff --git a/source/plugins/nightscout/metadata.yml b/source/plugins/nightscout/metadata.yml index f22a4580..9835f283 100644 --- a/source/plugins/nightscout/metadata.yml +++ b/source/plugins/nightscout/metadata.yml @@ -1,5 +1,4 @@ name: "💉 Nightscout" -cost: N/A category: other index: 3 supports: diff --git a/source/plugins/notable/README.md b/source/plugins/notable/README.md index 9ebf4011..dbaf984b 100644 --- a/source/plugins/notable/README.md +++ b/source/plugins/notable/README.md @@ -5,13 +5,23 @@ The *notable* plugin displays badges of organization where you commited at least
See documentation 🌍
-
With repository name +
With repository name
+
Indepth analysis + +
+#### Using `indepth` statistics + +The `plugin_notable_indepth` option lets you get additional metrics about your contribution, such as: +- Total number of commits within a repository or organization. The badge will have a circular gauge which is proportional to the percentage of total contribution. It will also determine the resulting color of the badge. + +> đŸ”Ŗ On web instances, `indepth` is an extra feature and must be enabled globally in `settings.json` + #### ℹī¸ Examples workflows [➡ī¸ Available options for this plugin](metadata.yml) @@ -21,7 +31,8 @@ The *notable* plugin displays badges of organization where you commited at least with: # ... other options plugin_notable: yes - plugin_notable_filter: stars:>500 # Only display repositories with 500 stars or more (syntax based on GitHub search query) - plugin_notable_from: organization # Only display contributions within organization repositories - plugin_notable_repositories: yes # Display repositories name instead of only organization name + plugin_notable_filter: stars:>500 # Only display repositories with 500 stars or more (syntax based on GitHub search query) + plugin_notable_from: organization # Only display contributions within organization repositories + plugin_notable_repositories: yes # Display repositories name instead of only organization name + plugin_notable_indepth: yes # Gather additional informations about contributions ``` \ No newline at end of file diff --git a/source/plugins/notable/metadata.yml b/source/plugins/notable/metadata.yml index b3ca1477..141e5f81 100644 --- a/source/plugins/notable/metadata.yml +++ b/source/plugins/notable/metadata.yml @@ -1,5 +1,4 @@ name: "🎩 Notable contributions" -cost: 1 GraphQL request per 100 repositories fetched category: github index: 20 supports: diff --git a/source/plugins/pagespeed/metadata.yml b/source/plugins/pagespeed/metadata.yml index f6026bae..1d281ae3 100644 --- a/source/plugins/pagespeed/metadata.yml +++ b/source/plugins/pagespeed/metadata.yml @@ -1,5 +1,4 @@ name: "⏱ī¸ Website performances" -cost: N/A category: social index: 1 supports: diff --git a/source/plugins/people/metadata.yml b/source/plugins/people/metadata.yml index ec5d478b..b6e35d4e 100644 --- a/source/plugins/people/metadata.yml +++ b/source/plugins/people/metadata.yml @@ -1,5 +1,4 @@ name: "🧑‍🤝‍🧑 People plugin" -cost: 1 GraphQL request per 100 users + 1 REST request per user in "plugin_people_thanks" category: github index: 9 supports: diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md index 3eacee9d..63e26556 100644 --- a/source/plugins/posts/README.md +++ b/source/plugins/posts/README.md @@ -23,4 +23,7 @@ The recent *posts* plugin displays recent articles you wrote on an external sour plugin_posts: yes plugin_posts_source: dev.to # External source plugin_people_user: .github.user # Use same username as GitHub login + plugin_posts_limit: 4 # Limit to 4 posts + plugin_posts_descriptions: yes # Display article short description (when supported) + plugin_posts_covers: yes # Display article thumbnail (when supported) ``` diff --git a/source/plugins/posts/metadata.yml b/source/plugins/posts/metadata.yml index 9af5132f..dc8586f6 100644 --- a/source/plugins/posts/metadata.yml +++ b/source/plugins/posts/metadata.yml @@ -1,5 +1,4 @@ name: "✒ī¸ Recent posts" -cost: N/A category: social index: 6 supports: diff --git a/source/plugins/projects/metadata.yml b/source/plugins/projects/metadata.yml index 58ce8bde..c5bacbe3 100644 --- a/source/plugins/projects/metadata.yml +++ b/source/plugins/projects/metadata.yml @@ -1,5 +1,4 @@ name: "🗂ī¸ Active projects" -cost: 1 GraphQL request + 1 GraphQL request per repository project category: github index: 15 supports: diff --git a/source/plugins/reactions/README.md b/source/plugins/reactions/README.md index bff00b95..689415fc 100644 --- a/source/plugins/reactions/README.md +++ b/source/plugins/reactions/README.md @@ -18,9 +18,12 @@ The *reactions* plugin displays overall reactions on your recent issues and issu with: # ... other options plugin_reactions: yes - plugin_reactions_limit: 200 # Compute reactions over last 200 issue comments - plugin_reactions_limit_issues: 100 # Compute reactions over last 100 issues/pull requests opened - plugin_reactions_days: 14 # Compute reactions on issue comments posted less than 14 days ago - plugin_reactions_details: count, percentage # Display reactions count and percentage - plugin_reactions_ignored: bot # Ignore "bot" user + plugin_reactions_limit: 200 # Compute reactions over last 200 issue comments + plugin_reactions_limit_issues: 100 # Compute reactions over last 100 issues/pull requests opened + plugin_reactions_limit_discussions: 100 # Compute reactions over last 100 discussions +plugin_reactions_limit_discussions_comments: 100 # Compute reactions over last 100 discussions comments + plugin_reactions_days: 14 # Compute reactions on issue comments posted less than 14 days ago + plugin_reactions_display: absolute # Display percentages based on the total amoun fetched + plugin_reactions_details: count, percentage # Display reactions count and percentage + plugin_reactions_ignored: bot # Ignore "bot" user ``` diff --git a/source/plugins/reactions/metadata.yml b/source/plugins/reactions/metadata.yml index 5ef4c041..e82c5c87 100644 --- a/source/plugins/reactions/metadata.yml +++ b/source/plugins/reactions/metadata.yml @@ -1,5 +1,4 @@ name: "🎭 Comment reactions" -cost: 1 GraphQL request per 100 issues and issues comments fetched category: github index: 8 supports: diff --git a/source/plugins/repositories/metadata.yml b/source/plugins/repositories/metadata.yml index 8fb43a73..b493aeb2 100644 --- a/source/plugins/repositories/metadata.yml +++ b/source/plugins/repositories/metadata.yml @@ -1,6 +1,4 @@ name: "📓 Repositories" -cost: 1 GraphQL request per repository -category: github index: 21 supports: - user diff --git a/source/plugins/rss/metadata.yml b/source/plugins/rss/metadata.yml index bfc4b1cb..a92e7775 100644 --- a/source/plugins/rss/metadata.yml +++ b/source/plugins/rss/metadata.yml @@ -1,5 +1,4 @@ name: "đŸ—ŧ Rss feed" -cost: N/A category: social index: 6.5 supports: diff --git a/source/plugins/screenshot/metadata.yml b/source/plugins/screenshot/metadata.yml index 48f5e899..eea77c04 100644 --- a/source/plugins/screenshot/metadata.yml +++ b/source/plugins/screenshot/metadata.yml @@ -1,5 +1,4 @@ name: "📸 Website screenshot" -cost: N/A category: other index: 2 supports: diff --git a/source/plugins/skyline/metadata.yml b/source/plugins/skyline/metadata.yml index 991db0d1..c460cf7d 100644 --- a/source/plugins/skyline/metadata.yml +++ b/source/plugins/skyline/metadata.yml @@ -1,5 +1,4 @@ name: "🌇 GitHub Skyline 3D calendar" -cost: N/A category: github index: 24 supports: diff --git a/source/plugins/sponsors/metadata.yml b/source/plugins/sponsors/metadata.yml index 81966e64..ca6b9cbb 100644 --- a/source/plugins/sponsors/metadata.yml +++ b/source/plugins/sponsors/metadata.yml @@ -1,5 +1,4 @@ name: "💕 GitHub Sponsors" -cost: 1 GraphQL request category: github index: 23 supports: diff --git a/source/plugins/stackoverflow/README.md b/source/plugins/stackoverflow/README.md index 4614bcba..4b054c7a 100644 --- a/source/plugins/stackoverflow/README.md +++ b/source/plugins/stackoverflow/README.md @@ -33,4 +33,5 @@ Your user id will be in both url and search bar. plugin_stackoverflow_sections: answers-top, questions-recent # Display top answers and recent questions plugin_stackoverflow_limit: 2 # Display 2 entries per section plugin_stackoverflow_lines: 4 # Display 4 lines per entry + plugin_stackoverflow_lines_snippet: 2 # Display 2 lines in embed code snippets ``` \ No newline at end of file diff --git a/source/plugins/stackoverflow/metadata.yml b/source/plugins/stackoverflow/metadata.yml index 342e9cbf..742c4915 100644 --- a/source/plugins/stackoverflow/metadata.yml +++ b/source/plugins/stackoverflow/metadata.yml @@ -1,5 +1,4 @@ name: "🗨ī¸ Stackoverflow plugin" -cost: N/A category: social index: 5 supports: diff --git a/source/plugins/stargazers/metadata.yml b/source/plugins/stargazers/metadata.yml index 950319b6..49d786fc 100644 --- a/source/plugins/stargazers/metadata.yml +++ b/source/plugins/stargazers/metadata.yml @@ -1,5 +1,4 @@ name: "✨ Stargazers over last weeks" -cost: 1 GraphQL request per 100 stargazers category: github index: 14 supports: diff --git a/source/plugins/stars/metadata.yml b/source/plugins/stars/metadata.yml index 9ea8daae..9568e834 100644 --- a/source/plugins/stars/metadata.yml +++ b/source/plugins/stars/metadata.yml @@ -1,5 +1,4 @@ name: "🌟 Recently starred repositories" -cost: 1 GraphQL request category: github index: 6 supports: diff --git a/source/plugins/stock/metadata.yml b/source/plugins/stock/metadata.yml index 76b13103..de7b935d 100644 --- a/source/plugins/stock/metadata.yml +++ b/source/plugins/stock/metadata.yml @@ -1,5 +1,4 @@ name: "💹 Stock prices" -cost: N/A category: other index: 1 supports: diff --git a/source/plugins/support/metadata.yml b/source/plugins/support/metadata.yml index 2511597c..6b4c17b0 100644 --- a/source/plugins/support/metadata.yml +++ b/source/plugins/support/metadata.yml @@ -1,5 +1,4 @@ name: "💭 GitHub Community Support" -cost: N/A category: github index: 19 supports: diff --git a/source/plugins/topics/README.md b/source/plugins/topics/README.md index c231fd14..e59b8ab2 100644 --- a/source/plugins/topics/README.md +++ b/source/plugins/topics/README.md @@ -6,8 +6,8 @@ Check out [GitHub topics](https://github.com/topics) to search interesting topic @@ -25,6 +25,6 @@ This uses puppeteer to navigate through your starred topics page. # ... other options plugin_topics: yes plugin_topics_sort: stars # Sort by most starred topics - plugin_topics_mode: mastered # Display icons instead of labels + plugin_topics_mode: icons # Display icons instead of labels plugin_topics_limit: 0 # Disable limitations ``` diff --git a/source/plugins/topics/metadata.yml b/source/plugins/topics/metadata.yml index c4d4afbf..6324f788 100644 --- a/source/plugins/topics/metadata.yml +++ b/source/plugins/topics/metadata.yml @@ -1,5 +1,4 @@ name: "📌 Starred topics" -cost: N/A category: github index: 7 supports: diff --git a/source/plugins/traffic/metadata.yml b/source/plugins/traffic/metadata.yml index 44ee188c..3d74ac96 100644 --- a/source/plugins/traffic/metadata.yml +++ b/source/plugins/traffic/metadata.yml @@ -1,5 +1,4 @@ name: "🧮 Repositories traffic" -cost: 1 REST request per repository category: github index: 13 supports: diff --git a/source/plugins/tweets/metadata.yml b/source/plugins/tweets/metadata.yml index f41ef78e..787f1584 100644 --- a/source/plugins/tweets/metadata.yml +++ b/source/plugins/tweets/metadata.yml @@ -1,5 +1,4 @@ name: "🐤 Latest tweets" -cost: N/A category: social index: 3 supports: diff --git a/source/plugins/wakatime/metadata.yml b/source/plugins/wakatime/metadata.yml index 1f0f9917..c60cf013 100644 --- a/source/plugins/wakatime/metadata.yml +++ b/source/plugins/wakatime/metadata.yml @@ -1,5 +1,4 @@ name: "⏰ WakaTime plugin" -cost: N/A category: social index: 7 supports:
-
Mastered and known technologies version - +
With icons instead +