From 7ae9935efdceddd5bad0691bcc266acbecc74402 Mon Sep 17 00:00:00 2001
From: lowlighter <22963968+lowlighter@users.noreply.github.com>
Date: Fri, 14 Jan 2022 01:40:24 -0500
Subject: [PATCH] docs: auto-generate [skip ci]
---
source/plugins/achievements/README.md | 3 --
source/plugins/activity/README.md | 7 ++---
source/plugins/anilist/README.md | 5 +--
source/plugins/base/README.md | 9 +++---
source/plugins/code/README.md | 5 ++-
source/plugins/contributors/README.md | 8 ++---
source/plugins/core/README.md | 43 ++++++++++++++------------
source/plugins/discussions/README.md | 7 ++---
source/plugins/followup/README.md | 5 ++-
source/plugins/gists/README.md | 3 --
source/plugins/habits/README.md | 5 ++-
source/plugins/introduction/README.md | 3 --
source/plugins/isocalendar/README.md | 3 --
source/plugins/languages/README.md | 11 +++----
source/plugins/licenses/README.md | 5 ++-
source/plugins/lines/README.md | 5 ++-
source/plugins/music/README.md | 7 +++--
source/plugins/nightscout/README.md | 4 +--
source/plugins/notable/README.md | 5 ++-
source/plugins/pagespeed/README.md | 5 ++-
source/plugins/people/README.md | 3 --
source/plugins/poopmap/README.md | 4 +--
source/plugins/posts/README.md | 5 +--
source/plugins/projects/README.md | 5 +--
source/plugins/reactions/README.md | 7 ++---
source/plugins/repositories/README.md | 3 --
source/plugins/rss/README.md | 3 --
source/plugins/screenshot/README.md | 3 --
source/plugins/skyline/README.md | 3 --
source/plugins/sponsors/README.md | 3 --
source/plugins/stackoverflow/README.md | 3 --
source/plugins/stargazers/README.md | 3 --
source/plugins/starlists/README.md | 15 +++++----
source/plugins/stars/README.md | 3 --
source/plugins/stock/README.md | 3 +-
source/plugins/support/README.md | 3 --
source/plugins/topics/README.md | 3 --
source/plugins/traffic/README.md | 5 ++-
source/plugins/tweets/README.md | 5 ++-
source/plugins/wakatime/README.md | 5 ++-
40 files changed, 84 insertions(+), 151 deletions(-)
diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md
index 592f78df..cfa64d74 100644
--- a/source/plugins/achievements/README.md
+++ b/source/plugins/achievements/README.md
@@ -41,9 +41,6 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
| `plugin_achievements_only` | `array` *(comma-separated)* **[]** | Unlocked achievements to display |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/activity/README.md b/source/plugins/activity/README.md
index af1eefea..1ba0747a 100644
--- a/source/plugins/activity/README.md
+++ b/source/plugins/activity/README.md
@@ -41,13 +41,12 @@ Use a full `repo` scope token to display **private** events.
| `plugin_activity_filter` | `array` *(comma-separated)* **[all]** *{"all", "comment", "ref/create", "ref/delete", "release", "push", "issue", "pr", "review", "wiki", "fork", "star", "member", "public"}* | Events types to keep |
| `plugin_activity_visibility` | `string` **[all]** *{"public", "all"}* | Set events visibility |
| `plugin_activity_timestamps` | `boolean` **[no]** | Display events timestamps |
-| `plugin_activity_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
-| `plugin_activity_ignored` | `undefined` **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Actors to ignore |
+| `plugin_activity_skipped` β© | `array` *(comma-separated)* **[]** | Repositories to skip |
+| `plugin_activity_ignored` β© | `undefined` **[]** | Actors to ignore |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β© Value inherits from its related global-level option
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md
index 1690a2a6..6e3d6bfc 100644
--- a/source/plugins/anilist/README.md
+++ b/source/plugins/anilist/README.md
@@ -36,12 +36,9 @@ These sections can also be filtered by media type, which can be either `anime`,
| `plugin_anilist_limit` | `number` **[2]** *{0 β€ π₯}* | Maximum number of entries to display per section |
| `plugin_anilist_limit_characters` | `number` **[22]** *{0 β€ π₯}* | Maximum number of entries to display in characters section |
| `plugin_anilist_shuffle` | `boolean` **[yes]** | Shuffle AniList data |
-| `plugin_anilist_user` | `string` **[.user.login]** | AniList login |
+| `plugin_anilist_user` | `string` **[*β User login*]** | AniList login |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md
index 11eb635e..ab6ec7d5 100644
--- a/source/plugins/base/README.md
+++ b/source/plugins/base/README.md
@@ -34,13 +34,14 @@ These are all enabled by default, but you can explicitely opt out from them.
| `repositories_batch` | `number` **[100]** *{1 β€ π₯ β€ 100}* | Number of repositories to load at once by queries |
| `repositories_forks` | `boolean` **[no]** | Include forks in metrics |
| `repositories_affiliations` | `array` *(comma-separated)* **[owner]** *{"owner", "collaborator", "organization_member"}* | Repositories affiliations |
-| `repositories_skipped` | `array` *(comma-separated)* **[]** | Default repositories to skip |
-| `commits_authoring` | `array` *(comma-seperated)* **[.user.login]** | List of surnames or email addresses you use when authoring commits |
+| `repositories_skipped` βοΈ | `array` *(comma-separated)* **[]** | Default repositories to skip |
+| `users_ignored` βοΈ β¨ | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Default users to ignore |
+| `commits_authoring` βοΈ | `array` *(comma-seperated)* **[*β User login*]** | List of surnames or email addresses you use when authoring commits |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* βοΈ Value be inherited by its related plugin-level option
+* β¨ Currently in beta-testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/code/README.md b/source/plugins/code/README.md
index 9ba11d34..eca15b33 100644
--- a/source/plugins/code/README.md
+++ b/source/plugins/code/README.md
@@ -20,13 +20,12 @@ Display a random code snippet from your recent activity history.
| `plugin_code_lines` | `number` **[12]** | Maximum number of line that a code snippet can contain |
| `plugin_code_load` | `number` **[100]** *{100 β€ π₯ β€ 1000}* | Number of events to load |
| `plugin_code_visibility` | `string` **[public]** *{"public", "all"}* | Set events visibility |
-| `plugin_code_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
+| `plugin_code_skipped` β© | `array` *(comma-separated)* **[]** | Repositories to skip |
| `plugin_code_languages` | `array` *(comma-separated)* **[]** | Restrict code snippet languages |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β© Value inherits from its related global-level option
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md
index 285429ce..0cb978ce 100644
--- a/source/plugins/contributors/README.md
+++ b/source/plugins/contributors/README.md
@@ -42,10 +42,10 @@ Matching is performed in keys order.
| `plugin_contributors` | `boolean` **[no]** | Display repository contributors |
| `plugin_contributors_base` | `string` **[]** | Base reference |
| `plugin_contributors_head` | `string` **[master]** | Head reference |
-| `plugin_contributors_ignored` | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore |
+| `plugin_contributors_ignored` β© | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore |
| `plugin_contributors_contributions` | `boolean` **[no]** | Display contributions |
| `plugin_contributors_sections` | `array` *(comma-separated)* **[contributors]** *{"contributors", "categories"}* | Sections to display |
-| `plugin_contributors_categories` | `json` **[{
+| `plugin_contributors_categories` π§° | `json` **[{
"π Documentation": ["README.md", "docs/**"],
"π» Code": ["source/**", "src/**"],
"#οΈβ£ Others": ["*"]
@@ -54,8 +54,8 @@ Matching is performed in keys order.
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β© Value inherits from its related global-level option
+* π§° Must be enabled in `settings.json` (for web instances)
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/core/README.md b/source/plugins/core/README.md
index 2867fdd6..090aa78f 100644
--- a/source/plugins/core/README.md
+++ b/source/plugins/core/README.md
@@ -7,10 +7,10 @@ Metrics also have general options that impact global metrics rendering.
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
-| `token` π | `token` | GitHub Personal Token |
+| `token` βοΈ π | `token` | GitHub Personal Token |
| `user` | `string` **[]** | GitHub username |
| `repo` | `string` **[]** | GitHub repository |
-| `committer_token` π | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics |
+| `committer_token` π | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics |
| `committer_branch` | `string` **[]** | Branch used to commit rendered metrics |
| `committer_message` | `string` **[Update ${filename} - [Skip GitHub Action]]** | Commit message |
| `committer_gist` | `string` **[]** | Gist used to store metrics |
@@ -20,37 +20,40 @@ Metrics also have general options that impact global metrics rendering.
| `output_action` | `string` **[commit]** *{"none", "commit", "pull-request", "pull-request-merge", "pull-request-squash", "pull-request-rebase", "gist"}* | Output action |
| `output_condition` | `string` **[always]** *{"always", "data-changed"}* | Output condition |
| `optimize` | `array` *(comma-separated)* **[css, xml]** *{"css", "xml", "svg"}* | SVG optimization |
-| `setup_community_templates` | `array` *(comma-separated,/(?[-a-z0-9]+)[/](?[-a-z0-9]+)@(?[-a-z0-9]+):(?[-a-z0-9]+)/)* **[]** | Additional community templates to setup |
+| `setup_community_templates` π§° | `array` *(comma-separated)* **[]** | Additional community templates to setup |
| `template` | `string` **[classic]** | Template to use |
| `query` | `json` **[{}]** | Additional query parameters |
-| `extras_css` | `string` **[]** | Extra CSS |
-| `config_timezone` | `string` **[]** | Timezone used |
-| `config_order` | `array` *(comma-separated)* **[]** | Configure content order |
-| `config_twemoji` | `boolean` **[no]** | Use twemojis instead of emojis |
-| `config_gemoji` | `boolean` **[yes]** | Use GitHub custom emojis |
-| `config_display` | `string` **[regular]** *{"regular", "large", "columns"}* | Render display width |
-| `config_animations` | `boolean` **[yes]** | SVG CSS animations |
-| `config_base64` | `boolean` **[yes]** | Encode images links into base64 data |
+| `extras_css` π§° | `string` **[]** | Extra CSS |
+| `config_timezone` βοΈ | `string` **[]** | Timezone used |
+| `config_order` βοΈ | `array` *(comma-separated)* **[]** | Configure content order |
+| `config_twemoji` βοΈ | `boolean` **[no]** | Use twemojis instead of emojis |
+| `config_gemoji` βοΈ | `boolean` **[yes]** | Use GitHub custom emojis |
+| `config_display` βοΈ | `string` **[regular]** *{"regular", "large", "columns"}* | Render display width |
+| `config_animations` βοΈ | `boolean` **[yes]** | SVG CSS animations |
+| `config_base64` βοΈ | `boolean` **[yes]** | Encode images links into base64 data |
| `config_padding` | `string` **[0, 8 + 11%]** | Image padding |
| `config_output` | `string` **[auto]** *{"auto", "svg", "png", "jpeg", "json", "markdown", "markdown-pdf", "insights"}* | Output image format |
| `retries` | `number` **[3]** *{1 β€ π₯ β€ 10}* | Number of retries |
| `retries_delay` | `number` **[300]** *{0 β€ π₯ β€ 3600}* | Time to wait (in seconds) before each retry |
| `retries_output_action` | `number` **[5]** *{1 β€ π₯ β€ 10}* | Number of retries (output action) |
| `retries_delay_output_action` | `number` **[120]** *{0 β€ π₯ β€ 3600}* | Time to wait (in seconds) before each retry (output action) |
-| `plugins_errors_fatal` | `boolean` **[no]** | Die on plugins errors |
-| `debug` | `boolean` **[no]** | Debug logs |
-| `verify` | `boolean` **[no]** | Verify SVG |
-| `debug_flags` | `array` *(space-separated)* **[]** *{"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags |
-| `dryrun` | `boolean` **[no]** | Enable dry-run |
-| `experimental_features` | `array` *(space-separated)* **[]** *{"--optimize-svg"}* | Experimental features |
-| `use_mocked_data` | `boolean` **[no]** | Use mocked data instead of live APIs |
-| `use_prebuilt_image` | `boolean` **[yes]** | Use pre-built image from GitHub registry |
| `delay` | `number` **[0]** *{0 β€ π₯ β€ 3600}* | Use this to avoid triggering abuse mechanics on large workflows |
+| `use_prebuilt_image` | `boolean` **[yes]** | Use pre-built image from GitHub registry |
+| `plugins_errors_fatal` π§ | `boolean` **[no]** | Die on plugins errors |
+| `debug` π§ | `boolean` **[no]** | Debug logs |
+| `verify` π§ | `boolean` **[no]** | Verify SVG |
+| `debug_flags` π§ | `array` *(space-separated)* **[]** *{"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags |
+| `dryrun` π§ | `boolean` **[no]** | Enable dry-run |
+| `experimental_features` π§ | `array` *(space-separated)* **[]** *{"--optimize-svg"}* | Experimental features |
+| `use_mocked_data` π§ | `boolean` **[no]** | Use mocked data instead of live APIs |
Legend for option icons:
+* βοΈ Value must be provided
* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* βοΈ Value be inherited by its related plugin-level option
+* π§ For development purposes, use with caution
+* π§° Must be enabled in `settings.json` (for web instances)
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/discussions/README.md b/source/plugins/discussions/README.md
index c94872fd..c1d3c558 100644
--- a/source/plugins/discussions/README.md
+++ b/source/plugins/discussions/README.md
@@ -15,13 +15,12 @@ The *discussions* plugin displays your GitHub discussions metrics.
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_discussions` | `boolean` **[no]** | GitHub discussions metrics |
-| `plugin_discussions_categories` β¨ | `boolean` **[yes]** | Display discussion categories |
-| `plugin_discussions_categories_limit` β¨ | `number` **[0]** | Number of discussion categories to display |
+| `plugin_discussions_categories` β¨ | `boolean` **[yes]** | Display discussion categories |
+| `plugin_discussions_categories_limit` β¨ | `number` **[0]** | Number of discussion categories to display |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β¨ Currently in beta-testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/followup/README.md b/source/plugins/followup/README.md
index f75088b5..26169c5d 100644
--- a/source/plugins/followup/README.md
+++ b/source/plugins/followup/README.md
@@ -24,12 +24,11 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
| ------ | -------------------------------- | ----------- |
| `plugin_followup` | `boolean` **[no]** | Display follow-up of repositories issues and pull requests |
| `plugin_followup_sections` | `array` *(comma-separated)* **[repositories]** *{"repositories", "user"}* | Sections to display |
-| `plugin_followup_indepth` | `boolean` **[no]** | Indepth follow-up processing |
+| `plugin_followup_indepth` π§° | `boolean` **[no]** | Indepth follow-up processing |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* π§° Must be enabled in `settings.json` (for web instances)
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/gists/README.md b/source/plugins/gists/README.md
index 761ff507..142061af 100644
--- a/source/plugins/gists/README.md
+++ b/source/plugins/gists/README.md
@@ -17,9 +17,6 @@ The *gists* plugin displays your [gists](https://gist.github.com) metrics.
| `plugin_gists` | `boolean` **[no]** | Display gists metrics |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/habits/README.md b/source/plugins/habits/README.md
index 735166d9..059e9699 100644
--- a/source/plugins/habits/README.md
+++ b/source/plugins/habits/README.md
@@ -34,13 +34,12 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
| `plugin_habits_from` | `number` **[200]** *{1 β€ π₯ β€ 1000}* | Number of events to use |
| `plugin_habits_days` | `number` **[14]** *{1 β€ π₯ β€ 30}* | Maximum event age |
| `plugin_habits_facts` | `boolean` **[yes]** | Display coding habits collected facts based on recent activity |
-| `plugin_habits_charts` | `boolean` **[no]** | Display coding habits charts based on recent activity |
+| `plugin_habits_charts` π§° | `boolean` **[no]** | Display coding habits charts based on recent activity |
| `plugin_habits_trim` | `boolean` **[no]** | Trim unused hours on daily chart |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* π§° Must be enabled in `settings.json` (for web instances)
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/introduction/README.md b/source/plugins/introduction/README.md
index b86e296e..caac482f 100644
--- a/source/plugins/introduction/README.md
+++ b/source/plugins/introduction/README.md
@@ -24,9 +24,6 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
| `plugin_introduction_title` | `boolean` **[yes]** | Display introduction section title |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/isocalendar/README.md b/source/plugins/isocalendar/README.md
index 5e10b64f..2698143b 100644
--- a/source/plugins/isocalendar/README.md
+++ b/source/plugins/isocalendar/README.md
@@ -23,9 +23,6 @@ The *isocalendar* plugin displays an isometric view of your commits calendar, al
| `plugin_isocalendar_duration` | `string` **[half-year]** *{"half-year", "full-year"}* | Set time window shown by isometric calendar |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/languages/README.md b/source/plugins/languages/README.md
index e983a1d9..d65da513 100644
--- a/source/plugins/languages/README.md
+++ b/source/plugins/languages/README.md
@@ -52,13 +52,13 @@ For better results, it's advised to add either your surnames and eventually no-r
| `plugin_languages_ignored` | `array` *(comma-separated)* **[]** | Languages to ignore |
| `plugin_languages_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
| `plugin_languages_limit` | `number` **[8]** *{0 β€ π₯ β€ 8}* | Maximum number of languages to display |
-| `plugin_languages_sections` | `array` *(comma-separated)* **[most-used]** *{"most-used", "recently-used"}* | Sections to display |
-| `plugin_languages_colors` | `array` *(comma-separated,/((?[0-9])|(?[-+a-z0-9#]+)):(?#?[-a-z0-9]+)/)* **[github]** | Custom languages colors |
+| `plugin_languages_sections` π§° | `array` *(comma-separated)* **[most-used]** *{"most-used", "recently-used"}* | Sections to display |
+| `plugin_languages_colors` | `array` *(comma-separated)* **[github]** | Custom languages colors |
| `plugin_languages_aliases` | `string` **[]** | Custom languages names |
| `plugin_languages_details` | `array` *(comma-separated)* **[]** *{"bytes-size", "percentage", "lines"}* | Additional details |
| `plugin_languages_threshold` | `string` **[0%]** | Minimum threshold |
-| `plugin_languages_indepth` | `boolean` **[false]** | Indepth languages processing (see documentation before enabling) |
-| `plugin_languages_analysis_timeout` | `number` **[15]** *{1 β€ π₯ β€ 30}* | Languages analysis timeout |
+| `plugin_languages_indepth` π§° | `boolean` **[false]** | Indepth languages processing (see documentation before enabling) |
+| `plugin_languages_analysis_timeout` π§° | `number` **[15]** *{1 β€ π₯ β€ 30}* | Languages analysis timeout |
| `plugin_languages_categories` | `array` *(comma-separated)* **[markup, programming]** *{"data", "markup", "programming", "prose"}* | Language categories to display |
| `plugin_languages_recent_categories` | `array` *(comma-separated)* **[markup, programming]** *{"data", "markup", "programming", "prose"}* | Language categories to display (for recently used section) |
| `plugin_languages_recent_load` | `number` **[300]** *{100 β€ π₯ β€ 1000}* | Number of events to load (for recently used section) |
@@ -66,8 +66,7 @@ For better results, it's advised to add either your surnames and eventually no-r
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* π§° Must be enabled in `settings.json` (for web instances)
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md
index 8375b306..2902439d 100644
--- a/source/plugins/licenses/README.md
+++ b/source/plugins/licenses/README.md
@@ -29,15 +29,14 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
-| `plugin_licenses` | `boolean` **[no]** | Display licenses informations |
+| `plugin_licenses` π§° | `boolean` **[no]** | Display licenses informations |
| `plugin_licenses_setup` | `string` **[]** | Command to setup target repository |
| `plugin_licenses_ratio` | `boolean` **[no]** | Display used licenses ratio |
| `plugin_licenses_legal` | `boolean` **[yes]** | Display legal informations about used licenses |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* π§° Must be enabled in `settings.json` (for web instances)
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/lines/README.md b/source/plugins/lines/README.md
index 91f46166..cc185df0 100644
--- a/source/plugins/lines/README.md
+++ b/source/plugins/lines/README.md
@@ -15,12 +15,11 @@ The *lines* of code plugin displays the number of lines of code you have added a
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_lines` | `boolean` **[no]** | Display lines of code metrics |
-| `plugin_lines_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
+| `plugin_lines_skipped` β© | `array` *(comma-separated)* **[]** | Repositories to skip |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β© Value inherits from its related global-level option
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/music/README.md b/source/plugins/music/README.md
index eb6f80ca..9ce31148 100644
--- a/source/plugins/music/README.md
+++ b/source/plugins/music/README.md
@@ -212,19 +212,18 @@ Click on the Name of any matching request. In the βHeadersβ tab, scroll to t
| ------ | -------------------------------- | ----------- |
| `plugin_music` | `boolean` **[no]** | Display your music tracks |
| `plugin_music_provider` | `string` **[]** *{"apple", "spotify", "lastfm", "youtube"}* | Music provider |
-| `plugin_music_token` π | `token` **[]** | Music provider personal token |
+| `plugin_music_token` π | `token` **[]** | Music provider personal token |
| `plugin_music_mode` | `string` **[]** *{"playlist", "recent", "top"}* | Plugin mode |
| `plugin_music_playlist` | `string` **[]** | Embed playlist url |
| `plugin_music_limit` | `number` **[4]** *{1 β€ π₯ β€ 100}* | Maximum number of tracks to display |
| `plugin_music_played_at` | `boolean` **[no]** | Display when the track was played |
| `plugin_music_time_range` | `string` **[short]** *{"short", "medium", "long"}* | Time period for top mode |
| `plugin_music_top_type` | `string` **[tracks]** *{"tracks", "artists"}* | Whether to show tracks or artists in top mode |
-| `plugin_music_user` | `string` **[.user.login]** | Music provider username |
+| `plugin_music_user` | `string` **[*β User login*]** | Music provider username |
Legend for option icons:
* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
@@ -274,6 +273,7 @@ with:
plugin_music: 'yes'
plugin_music_mode: top
plugin_music_provider: spotify
+ plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_time_range: short
plugin_music_top_type: tracks
@@ -286,6 +286,7 @@ with:
plugin_music: 'yes'
plugin_music_mode: top
plugin_music_provider: spotify
+ plugin_music_token: ${{ secrets.SPOTIFY_TOKENS }}
plugin_music_time_range: long
plugin_music_top_type: artists
diff --git a/source/plugins/nightscout/README.md b/source/plugins/nightscout/README.md
index 2576febf..75b18197 100644
--- a/source/plugins/nightscout/README.md
+++ b/source/plugins/nightscout/README.md
@@ -30,9 +30,6 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
| `plugin_nightscout_urgenthighalert` | `number` **[250]** *{0 β€ π₯}* | When the blood sugar is considered urgently high |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
@@ -43,6 +40,7 @@ Legend for option icons:
```yaml
uses: lowlighter/metrics@latest
with:
+ token: ${{ secrets.METRICS_TOKEN }}
plugin_nightscout: 'yes'
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}
diff --git a/source/plugins/notable/README.md b/source/plugins/notable/README.md
index dda398f9..ce05970d 100644
--- a/source/plugins/notable/README.md
+++ b/source/plugins/notable/README.md
@@ -30,12 +30,11 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
| `plugin_notable_filter` | `string` **[]** | Query filter |
| `plugin_notable_from` | `string` **[organization]** *{"all", "organization", "user"}* | Filter by repository host account type |
| `plugin_notable_repositories` | `boolean` **[no]** | Also display repository name |
-| `plugin_notable_indepth` | `boolean` **[no]** | Indepth notable contributions processing |
+| `plugin_notable_indepth` π§° | `boolean` **[no]** | Indepth notable contributions processing |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* π§° Must be enabled in `settings.json` (for web instances)
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/pagespeed/README.md b/source/plugins/pagespeed/README.md
index 4c32fb6c..d90e8589 100644
--- a/source/plugins/pagespeed/README.md
+++ b/source/plugins/pagespeed/README.md
@@ -32,15 +32,14 @@ Expect 10 to 30 seconds to generate the results.
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_pagespeed` | `boolean` **[no]** | Display a website Google PageSpeed metrics |
-| `plugin_pagespeed_url` | `string` **[.user.website]** | Audited website |
+| `plugin_pagespeed_url` | `string` **[*β User attached website*]** | Audited website |
| `plugin_pagespeed_detailed` | `boolean` **[no]** | Detailed audit result |
| `plugin_pagespeed_screenshot` | `boolean` **[no]** | Display a screenshot of your website |
-| `plugin_pagespeed_token` π | `token` **[]** | PageSpeed token |
+| `plugin_pagespeed_token` π | `token` **[]** | PageSpeed token |
Legend for option icons:
* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/people/README.md b/source/plugins/people/README.md
index 3adf2d35..fe25a5b4 100644
--- a/source/plugins/people/README.md
+++ b/source/plugins/people/README.md
@@ -48,9 +48,6 @@ Sections will be ordered the same as specified in `plugin_people_types`.
| `plugin_people_shuffle` | `boolean` **[no]** | Shuffle users |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/poopmap/README.md b/source/plugins/poopmap/README.md
index db1e81ee..96142ed1 100644
--- a/source/plugins/poopmap/README.md
+++ b/source/plugins/poopmap/README.md
@@ -45,13 +45,12 @@ You now have your PoopMap token! This token will not expire and it can only acce
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_poopmap` | `boolean` **[no]** | Display PoopMap stats |
-| `plugin_poopmap_token` π | `token` **[]** | PoopMap API token |
+| `plugin_poopmap_token` π | `token` **[]** | PoopMap API token |
| `plugin_poopmap_days` | `number` **[7]** *{"7", "30", "180", "365"}* | PoopMap time range |
Legend for option icons:
* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
@@ -62,6 +61,7 @@ Legend for option icons:
```yaml
uses: lowlighter/metrics@latest
with:
+ token: ${{ secrets.METRICS_TOKEN }}
plugin_poopmap: 'yes'
```
diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md
index d4575d45..d508ca18 100644
--- a/source/plugins/posts/README.md
+++ b/source/plugins/posts/README.md
@@ -24,12 +24,9 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
| `plugin_posts_descriptions` | `boolean` **[no]** | Display posts descriptions |
| `plugin_posts_covers` | `boolean` **[no]** | Display posts cover images |
| `plugin_posts_limit` | `number` **[4]** *{1 β€ π₯ β€ 30}* | Maximum number of posts to display |
-| `plugin_posts_user` | `string` **[.user.login]** | Posts external source username |
+| `plugin_posts_user` | `string` **[*β User login*]** | Posts external source username |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/projects/README.md b/source/plugins/projects/README.md
index 98892908..7ac48c00 100644
--- a/source/plugins/projects/README.md
+++ b/source/plugins/projects/README.md
@@ -47,13 +47,10 @@ To do so, open your repository project and retrieve the last URL endpoint, in th
| ------ | -------------------------------- | ----------- |
| `plugin_projects` | `boolean` **[no]** | Display active projects |
| `plugin_projects_limit` | `number` **[4]** *{0 β€ π₯ β€ 100}* | Maximum number of projects to display |
-| `plugin_projects_repositories` | `array` *(comma-separated,/(?[-a-z0-9]+)[/](?[-a-z0-9]+)[/]projects[/](?[0-9]+)/)* **[]** | List of repository project identifiers to disaplay |
+| `plugin_projects_repositories` | `array` *(comma-separated)* **[]** | List of repository project identifiers to disaplay |
| `plugin_projects_descriptions` | `boolean` **[no]** | Display projects descriptions |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/reactions/README.md b/source/plugins/reactions/README.md
index 96a4c9af..c8e741ac 100644
--- a/source/plugins/reactions/README.md
+++ b/source/plugins/reactions/README.md
@@ -22,12 +22,11 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
| `plugin_reactions_days` | `number` **[0]** *{0 β€ π₯}* | Maximum comments age |
| `plugin_reactions_display` | `string` **[absolute]** *{"absolute", "relative"}* | Display mode |
| `plugin_reactions_details` | `array` *(comma-separated)* **[]** *{"count", "percentage"}* | Additional details |
-| `plugin_reactions_ignored` | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Users to ignore |
+| `plugin_reactions_ignored` β© | `array` *(comma-separated)* **[]** | Users to ignore |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β© Value inherits from its related global-level option
*[β Full specification](metadata.yml)*
@@ -36,7 +35,7 @@ Legend for option icons:
```yaml
-name: π Comment reactions
+name: Comment reactions
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.reactions.svg
diff --git a/source/plugins/repositories/README.md b/source/plugins/repositories/README.md
index d0e3d652..02ab5a54 100644
--- a/source/plugins/repositories/README.md
+++ b/source/plugins/repositories/README.md
@@ -22,9 +22,6 @@ Because of limitations of using SVG inside of `
` tags, people won't be able
| `plugin_repositories_featured` | `array` *(comma-separated)* **[]** | List of repositories to display |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/rss/README.md b/source/plugins/rss/README.md
index 38e2de91..423267c6 100644
--- a/source/plugins/rss/README.md
+++ b/source/plugins/rss/README.md
@@ -19,9 +19,6 @@ The *rss* plugin displays items from a specified RSS feed.
| `plugin_rss_limit` | `number` **[4]** *{0 β€ π₯ β€ 30}* | Maximum number of items to display |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/screenshot/README.md b/source/plugins/screenshot/README.md
index 1c2e6e5f..bb92607f 100644
--- a/source/plugins/screenshot/README.md
+++ b/source/plugins/screenshot/README.md
@@ -22,9 +22,6 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
| `plugin_screenshot_background` | `boolean` **[yes]** | Display or remove default page background |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/skyline/README.md b/source/plugins/skyline/README.md
index 8884fd01..cf59468a 100644
--- a/source/plugins/skyline/README.md
+++ b/source/plugins/skyline/README.md
@@ -25,9 +25,6 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
| `plugin_skyline_compatibility` | `boolean` **[no]** | Compatibility mode |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md
index 7e85d1a3..a7cbb581 100644
--- a/source/plugins/sponsors/README.md
+++ b/source/plugins/sponsors/README.md
@@ -23,9 +23,6 @@ The *sponsors* plugin lets you display your sponsors and introduction text from
| `plugin_sponsors_sections` | `array` *(comma-separated)* **[goal, about]** *{"goal", "about"}* | Sections to display |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/stackoverflow/README.md b/source/plugins/stackoverflow/README.md
index 35aae817..a318ebb7 100644
--- a/source/plugins/stackoverflow/README.md
+++ b/source/plugins/stackoverflow/README.md
@@ -33,9 +33,6 @@ Your user id will be in both url and search bar.
| `plugin_stackoverflow_lines_snippet` | `number` **[2]** *{0 β€ π₯}* | Maximum number of lines to display per code snippet |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/stargazers/README.md b/source/plugins/stargazers/README.md
index c48541b4..e83a34cf 100644
--- a/source/plugins/stargazers/README.md
+++ b/source/plugins/stargazers/README.md
@@ -17,9 +17,6 @@ The *stargazers* plugin displays your stargazers evolution across all of your re
| `plugin_stargazers` | `boolean` **[no]** | Display stargazers metrics |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/starlists/README.md b/source/plugins/starlists/README.md
index 4bf9d764..e74950de 100644
--- a/source/plugins/starlists/README.md
+++ b/source/plugins/starlists/README.md
@@ -14,17 +14,16 @@ The *starlists* plugin displays your recently star lists.
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
-| `plugin_starlists` β¨ | `boolean` **[no]** | Display star lists |
-| `plugin_starlists_limit` β¨ | `number` **[2]** *{1 β€ π₯ β€ 100}* | Number of star lists to display |
-| `plugin_starlists_limit_repositories` β¨ | `number` **[2]** *{0 β€ π₯ β€ 100}* | Number of repositories to display per star lists |
-| `plugin_starlists_shuffle_repositories` β¨ | `boolean` **[yes]** | Shuffle displayed repositories |
-| `plugin_starlists_ignored` β¨ | `array` *(comma-separated)* **[]** | Star lists to skip |
-| `plugin_starlists_only` β¨ | `array` *(comma-separated)* **[]** | Star lists to display |
+| `plugin_starlists` β¨ | `boolean` **[no]** | Display star lists |
+| `plugin_starlists_limit` β¨ | `number` **[2]** *{1 β€ π₯ β€ 100}* | Number of star lists to display |
+| `plugin_starlists_limit_repositories` β¨ | `number` **[2]** *{0 β€ π₯ β€ 100}* | Number of repositories to display per star lists |
+| `plugin_starlists_shuffle_repositories` β¨ | `boolean` **[yes]** | Shuffle displayed repositories |
+| `plugin_starlists_ignored` β¨ | `array` *(comma-separated)* **[]** | Star lists to skip |
+| `plugin_starlists_only` β¨ | `array` *(comma-separated)* **[]** | Star lists to display |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β¨ Currently in beta-testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/stars/README.md b/source/plugins/stars/README.md
index 6cf7cda2..6cb782e8 100644
--- a/source/plugins/stars/README.md
+++ b/source/plugins/stars/README.md
@@ -18,9 +18,6 @@ The *stars* plugin displays your recently starred repositories.
| `plugin_stars_limit` | `number` **[4]** *{1 β€ π₯ β€ 100}* | Maximum number of stars to display |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/stock/README.md b/source/plugins/stock/README.md
index 51b615f0..53f2c3d7 100644
--- a/source/plugins/stock/README.md
+++ b/source/plugins/stock/README.md
@@ -24,7 +24,7 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_stock` | `boolean` **[no]** | Display stock prices of a given company |
-| `plugin_stock_token` π | `token` **[]** | Yahoo Finance token |
+| `plugin_stock_token` π | `token` **[]** | Yahoo Finance token |
| `plugin_stock_symbol` | `string` **[]** | Company stock symbol |
| `plugin_stock_duration` | `string` **[1d]** *{"1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"}* | Time range to display |
| `plugin_stock_interval` | `string` **[5m]** *{"1m", "2m", "5m", "15m", "60m", "1d"}* | Time intervals between records |
@@ -32,7 +32,6 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
Legend for option icons:
* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/support/README.md b/source/plugins/support/README.md
index e577b4d5..5391e9f4 100644
--- a/source/plugins/support/README.md
+++ b/source/plugins/support/README.md
@@ -19,9 +19,6 @@ An account on [GitHub Support Community](https://github.community/) is required
| `plugin_support` | `boolean` **[no]** | GitHub Community Support metrics |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/topics/README.md b/source/plugins/topics/README.md
index fbe432e3..2807ebae 100644
--- a/source/plugins/topics/README.md
+++ b/source/plugins/topics/README.md
@@ -28,9 +28,6 @@ This uses puppeteer to navigate through your starred topics page.
| `plugin_topics_limit` | `number` **[15]** *{0 β€ π₯ β€ 20}* | Maximum number of topics to display |
-Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/traffic/README.md b/source/plugins/traffic/README.md
index ac4869aa..c6fcbdb8 100644
--- a/source/plugins/traffic/README.md
+++ b/source/plugins/traffic/README.md
@@ -20,12 +20,11 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_traffic` | `boolean` **[no]** | Display repositories traffic metrics |
-| `plugin_traffic_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
+| `plugin_traffic_skipped` β© | `array` *(comma-separated)* **[]** | Repositories to skip |
Legend for option icons:
-* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
+* β© Value inherits from its related global-level option
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/tweets/README.md b/source/plugins/tweets/README.md
index 654807ec..c3250123 100644
--- a/source/plugins/tweets/README.md
+++ b/source/plugins/tweets/README.md
@@ -32,15 +32,14 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_tweets` | `boolean` **[no]** | Display recent tweets |
-| `plugin_tweets_token` π | `token` **[]** | Twitter API token |
+| `plugin_tweets_token` π | `token` **[]** | Twitter API token |
| `plugin_tweets_attachments` | `boolean` **[no]** | Display tweets attchments |
| `plugin_tweets_limit` | `number` **[2]** *{1 β€ π₯ β€ 10}* | Maximum number of tweets to display |
-| `plugin_tweets_user` | `string` **[.user.twitter]** | Twitter username |
+| `plugin_tweets_user` | `string` **[*β User attached twitter*]** | Twitter username |
Legend for option icons:
* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
diff --git a/source/plugins/wakatime/README.md b/source/plugins/wakatime/README.md
index d5d713db..44440cf4 100644
--- a/source/plugins/wakatime/README.md
+++ b/source/plugins/wakatime/README.md
@@ -26,7 +26,7 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_wakatime` | `boolean` **[no]** | Display WakaTime stats |
-| `plugin_wakatime_token` π | `token` **[]** | WakaTime API token |
+| `plugin_wakatime_token` π | `token` **[]** | WakaTime API token |
| `plugin_wakatime_days` | `string` **[7]** *{"7", "30", "180", "365"}* | WakaTime time range |
| `plugin_wakatime_sections` | `array` **[time, projects, projects-graphs, languages, languages-graphs, editors, os]** *{"time", "projects", "projects-graphs", "languages", "languages-graphs", "editors", "editors-graphs", "os", "os-graphs"}* | Sections to display |
| `plugin_wakatime_limit` | `number` **[5]** *{0 β€ π₯}* | Maximum number of entries to display per graph |
@@ -36,7 +36,6 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
Legend for option icons:
* π Value should be stored in repository secrets
-* β¨ New feature currently in testing on `master`/`main`
*[β Full specification](metadata.yml)*
@@ -45,7 +44,7 @@ Legend for option icons:
```yaml
-name: β° WakaTime
+name: WakaTime
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.wakatime.svg