Skip to content

Commit 7ae9935

Browse files
committedJan 14, 2022
docs: auto-generate [skip ci]
1 parent 48c1d5c commit 7ae9935

File tree

40 files changed

+84
-151
lines changed

40 files changed

+84
-151
lines changed
 

‎source/plugins/achievements/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,6 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
4141
| `plugin_achievements_only` | `array` *(comma-separated)* **[]** | Unlocked achievements to display |
4242

4343

44-
Legend for option icons:
45-
* 🔐 Value should be stored in repository secrets
46-
* ✨ New feature currently in testing on `master`/`main`
4744
<!--/options-->
4845

4946
*[→ Full specification](metadata.yml)*

‎source/plugins/activity/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,12 @@ Use a full `repo` scope token to display **private** events.
4141
| `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 |
4242
| `plugin_activity_visibility` | `string` **[all]** *{"public", "all"}* | Set events visibility |
4343
| `plugin_activity_timestamps` | `boolean` **[no]** | Display events timestamps |
44-
| `plugin_activity_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
45-
| `plugin_activity_ignored` | `undefined` **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Actors to ignore |
44+
| `plugin_activity_skipped` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Repositories to skip |
45+
| `plugin_activity_ignored` <sup>⏩</sup> | `undefined` **[]** | Actors to ignore |
4646

4747

4848
Legend for option icons:
49-
* 🔐 Value should be stored in repository secrets
50-
* ✨ New feature currently in testing on `master`/`main`
49+
* ⏩ Value inherits from its related global-level option
5150
<!--/options-->
5251

5352
*[→ Full specification](metadata.yml)*

‎source/plugins/anilist/README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,9 @@ These sections can also be filtered by media type, which can be either `anime`,
3636
| `plugin_anilist_limit` | `number` **[2]** *{0 ≤ 𝑥}* | Maximum number of entries to display per section |
3737
| `plugin_anilist_limit_characters` | `number` **[22]** *{0 ≤ 𝑥}* | Maximum number of entries to display in characters section |
3838
| `plugin_anilist_shuffle` | `boolean` **[yes]** | Shuffle AniList data |
39-
| `plugin_anilist_user` | `string` **[.user.login]** | AniList login |
39+
| `plugin_anilist_user` | `string` **[*→ User login*]** | AniList login |
4040

4141

42-
Legend for option icons:
43-
* 🔐 Value should be stored in repository secrets
44-
* ✨ New feature currently in testing on `master`/`main`
4542
<!--/options-->
4643

4744
*[→ Full specification](metadata.yml)*

‎source/plugins/base/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,14 @@ These are all enabled by default, but you can explicitely opt out from them.
3434
| `repositories_batch` | `number` **[100]** *{1 ≤ 𝑥 ≤ 100}* | Number of repositories to load at once by queries |
3535
| `repositories_forks` | `boolean` **[no]** | Include forks in metrics |
3636
| `repositories_affiliations` | `array` *(comma-separated)* **[owner]** *{"owner", "collaborator", "organization_member"}* | Repositories affiliations |
37-
| `repositories_skipped` | `array` *(comma-separated)* **[]** | Default repositories to skip |
38-
| `commits_authoring` | `array` *(comma-seperated)* **[.user.login]** | List of surnames or email addresses you use when authoring commits |
37+
| `repositories_skipped` <sup>⏭️</sup> | `array` *(comma-separated)* **[]** | Default repositories to skip |
38+
| `users_ignored` <sup>⏭️</sup> <sup>✨</sup> | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Default users to ignore |
39+
| `commits_authoring` <sup>⏭️</sup> | `array` *(comma-seperated)* **[*→ User login*]** | List of surnames or email addresses you use when authoring commits |
3940

4041

4142
Legend for option icons:
42-
* 🔐 Value should be stored in repository secrets
43-
*New feature currently in testing on `master`/`main`
43+
* ⏭️ Value be inherited by its related plugin-level option
44+
*Currently in beta-testing on `master`/`main`
4445
<!--/options-->
4546

4647
*[→ Full specification](metadata.yml)*

‎source/plugins/code/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,12 @@ Display a random code snippet from your recent activity history.
2020
| `plugin_code_lines` | `number` **[12]** | Maximum number of line that a code snippet can contain |
2121
| `plugin_code_load` | `number` **[100]** *{100 ≤ 𝑥 ≤ 1000}* | Number of events to load |
2222
| `plugin_code_visibility` | `string` **[public]** *{"public", "all"}* | Set events visibility |
23-
| `plugin_code_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
23+
| `plugin_code_skipped` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Repositories to skip |
2424
| `plugin_code_languages` | `array` *(comma-separated)* **[]** | Restrict code snippet languages |
2525

2626

2727
Legend for option icons:
28-
* 🔐 Value should be stored in repository secrets
29-
* ✨ New feature currently in testing on `master`/`main`
28+
* ⏩ Value inherits from its related global-level option
3029
<!--/options-->
3130

3231
*[→ Full specification](metadata.yml)*

‎source/plugins/contributors/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ Matching is performed in keys order.
4242
| `plugin_contributors` | `boolean` **[no]** | Display repository contributors |
4343
| `plugin_contributors_base` | `string` **[]** | Base reference |
4444
| `plugin_contributors_head` | `string` **[master]** | Head reference |
45-
| `plugin_contributors_ignored` | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore |
45+
| `plugin_contributors_ignored` <sup>⏩</sup> | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore |
4646
| `plugin_contributors_contributions` | `boolean` **[no]** | Display contributions |
4747
| `plugin_contributors_sections` | `array` *(comma-separated)* **[contributors]** *{"contributors", "categories"}* | Sections to display |
48-
| `plugin_contributors_categories` | `json` **[{
48+
| `plugin_contributors_categories` <sup>🧰</sup> | `json` **[{
4949
"📚 Documentation": ["README.md", "docs/**"],
5050
"💻 Code": ["source/**", "src/**"],
5151
"#️⃣ Others": ["*"]
@@ -54,8 +54,8 @@ Matching is performed in keys order.
5454

5555

5656
Legend for option icons:
57-
* 🔐 Value should be stored in repository secrets
58-
* ✨ New feature currently in testing on `master`/`main`
57+
* Value inherits from its related global-level option
58+
* 🧰 Must be enabled in `settings.json` (for web instances)
5959
<!--/options-->
6060

6161
*[→ Full specification](metadata.yml)*

‎source/plugins/core/README.md

+23-20
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Metrics also have general options that impact global metrics rendering.
77
<!--options-->
88
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
99
| ------ | -------------------------------- | ----------- |
10-
| `token` 🔐 | `token` | GitHub Personal Token |
10+
| `token` <sup>✔️</sup> <sup>🔐</sup> | `token` | GitHub Personal Token |
1111
| `user` | `string` **[]** | GitHub username |
1212
| `repo` | `string` **[]** | GitHub repository |
13-
| `committer_token` 🔐 | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics |
13+
| `committer_token` <sup>🔐</sup> | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics |
1414
| `committer_branch` | `string` **[]** | Branch used to commit rendered metrics |
1515
| `committer_message` | `string` **[Update ${filename} - [Skip GitHub Action]]** | Commit message |
1616
| `committer_gist` | `string` **[]** | Gist used to store metrics |
@@ -20,37 +20,40 @@ Metrics also have general options that impact global metrics rendering.
2020
| `output_action` | `string` **[commit]** *{"none", "commit", "pull-request", "pull-request-merge", "pull-request-squash", "pull-request-rebase", "gist"}* | Output action |
2121
| `output_condition` | `string` **[always]** *{"always", "data-changed"}* | Output condition |
2222
| `optimize` | `array` *(comma-separated)* **[css, xml]** *{"css", "xml", "svg"}* | SVG optimization |
23-
| `setup_community_templates` | `array` *(comma-separated,/(?<user>[-a-z0-9]+)[/](?<repo>[-a-z0-9]+)@(?<branch>[-a-z0-9]+):(?<template>[-a-z0-9]+)/)* **[]** | Additional community templates to setup |
23+
| `setup_community_templates` <sup>🧰</sup> | `array` *(comma-separated)* **[]** | Additional community templates to setup |
2424
| `template` | `string` **[classic]** | Template to use |
2525
| `query` | `json` **[{}]** | Additional query parameters |
26-
| `extras_css` | `string` **[]** | Extra CSS |
27-
| `config_timezone` | `string` **[]** | Timezone used |
28-
| `config_order` | `array` *(comma-separated)* **[]** | Configure content order |
29-
| `config_twemoji` | `boolean` **[no]** | Use twemojis instead of emojis |
30-
| `config_gemoji` | `boolean` **[yes]** | Use GitHub custom emojis |
31-
| `config_display` | `string` **[regular]** *{"regular", "large", "columns"}* | Render display width |
32-
| `config_animations` | `boolean` **[yes]** | SVG CSS animations |
33-
| `config_base64` | `boolean` **[yes]** | Encode images links into base64 data |
26+
| `extras_css` <sup>🧰</sup> | `string` **[]** | Extra CSS |
27+
| `config_timezone` <sup>⏭️</sup> | `string` **[]** | Timezone used |
28+
| `config_order` <sup>⏭️</sup> | `array` *(comma-separated)* **[]** | Configure content order |
29+
| `config_twemoji` <sup>⏭️</sup> | `boolean` **[no]** | Use twemojis instead of emojis |
30+
| `config_gemoji` <sup>⏭️</sup> | `boolean` **[yes]** | Use GitHub custom emojis |
31+
| `config_display` <sup>⏭️</sup> | `string` **[regular]** *{"regular", "large", "columns"}* | Render display width |
32+
| `config_animations` <sup>⏭️</sup> | `boolean` **[yes]** | SVG CSS animations |
33+
| `config_base64` <sup>⏭️</sup> | `boolean` **[yes]** | Encode images links into base64 data |
3434
| `config_padding` | `string` **[0, 8 + 11%]** | Image padding |
3535
| `config_output` | `string` **[auto]** *{"auto", "svg", "png", "jpeg", "json", "markdown", "markdown-pdf", "insights"}* | Output image format |
3636
| `retries` | `number` **[3]** *{1 ≤ 𝑥 ≤ 10}* | Number of retries |
3737
| `retries_delay` | `number` **[300]** *{0 ≤ 𝑥 ≤ 3600}* | Time to wait (in seconds) before each retry |
3838
| `retries_output_action` | `number` **[5]** *{1 ≤ 𝑥 ≤ 10}* | Number of retries (output action) |
3939
| `retries_delay_output_action` | `number` **[120]** *{0 ≤ 𝑥 ≤ 3600}* | Time to wait (in seconds) before each retry (output action) |
40-
| `plugins_errors_fatal` | `boolean` **[no]** | Die on plugins errors |
41-
| `debug` | `boolean` **[no]** | Debug logs |
42-
| `verify` | `boolean` **[no]** | Verify SVG |
43-
| `debug_flags` | `array` *(space-separated)* **[]** *{"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags |
44-
| `dryrun` | `boolean` **[no]** | Enable dry-run |
45-
| `experimental_features` | `array` *(space-separated)* **[]** *{"--optimize-svg"}* | Experimental features |
46-
| `use_mocked_data` | `boolean` **[no]** | Use mocked data instead of live APIs |
47-
| `use_prebuilt_image` | `boolean` **[yes]** | Use pre-built image from GitHub registry |
4840
| `delay` | `number` **[0]** *{0 ≤ 𝑥 ≤ 3600}* | Use this to avoid triggering abuse mechanics on large workflows |
41+
| `use_prebuilt_image` | `boolean` **[yes]** | Use pre-built image from GitHub registry |
42+
| `plugins_errors_fatal` <sup>🔧</sup> | `boolean` **[no]** | Die on plugins errors |
43+
| `debug` <sup>🔧</sup> | `boolean` **[no]** | Debug logs |
44+
| `verify` <sup>🔧</sup> | `boolean` **[no]** | Verify SVG |
45+
| `debug_flags` <sup>🔧</sup> | `array` *(space-separated)* **[]** *{"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags |
46+
| `dryrun` <sup>🔧</sup> | `boolean` **[no]** | Enable dry-run |
47+
| `experimental_features` <sup>🔧</sup> | `array` *(space-separated)* **[]** *{"--optimize-svg"}* | Experimental features |
48+
| `use_mocked_data` <sup>🔧</sup> | `boolean` **[no]** | Use mocked data instead of live APIs |
4949

5050

5151
Legend for option icons:
52+
* ✔️ Value must be provided
5253
* 🔐 Value should be stored in repository secrets
53-
* ✨ New feature currently in testing on `master`/`main`
54+
* ⏭️ Value be inherited by its related plugin-level option
55+
* 🔧 For development purposes, use with caution
56+
* 🧰 Must be enabled in `settings.json` (for web instances)
5457
<!--/options-->
5558

5659
*[→ Full specification](metadata.yml)*

‎source/plugins/discussions/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,12 @@ The *discussions* plugin displays your GitHub discussions metrics.
1515
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
1616
| ------ | -------------------------------- | ----------- |
1717
| `plugin_discussions` | `boolean` **[no]** | GitHub discussions metrics |
18-
| `plugin_discussions_categories` | `boolean` **[yes]** | Display discussion categories |
19-
| `plugin_discussions_categories_limit` | `number` **[0]** | Number of discussion categories to display |
18+
| `plugin_discussions_categories` <sup>✨</sup> | `boolean` **[yes]** | Display discussion categories |
19+
| `plugin_discussions_categories_limit` <sup>✨</sup> | `number` **[0]** | Number of discussion categories to display |
2020

2121

2222
Legend for option icons:
23-
* 🔐 Value should be stored in repository secrets
24-
* ✨ New feature currently in testing on `master`/`main`
23+
* ✨ Currently in beta-testing on `master`/`main`
2524
<!--/options-->
2625

2726
*[→ Full specification](metadata.yml)*

‎source/plugins/followup/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,11 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
2424
| ------ | -------------------------------- | ----------- |
2525
| `plugin_followup` | `boolean` **[no]** | Display follow-up of repositories issues and pull requests |
2626
| `plugin_followup_sections` | `array` *(comma-separated)* **[repositories]** *{"repositories", "user"}* | Sections to display |
27-
| `plugin_followup_indepth` | `boolean` **[no]** | Indepth follow-up processing |
27+
| `plugin_followup_indepth` <sup>🧰</sup> | `boolean` **[no]** | Indepth follow-up processing |
2828

2929

3030
Legend for option icons:
31-
* 🔐 Value should be stored in repository secrets
32-
* ✨ New feature currently in testing on `master`/`main`
31+
* 🧰 Must be enabled in `settings.json` (for web instances)
3332
<!--/options-->
3433

3534
*[→ Full specification](metadata.yml)*

‎source/plugins/gists/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@ The *gists* plugin displays your [gists](https://gist.github.com) metrics.
1717
| `plugin_gists` | `boolean` **[no]** | Display gists metrics |
1818

1919

20-
Legend for option icons:
21-
* 🔐 Value should be stored in repository secrets
22-
* ✨ New feature currently in testing on `master`/`main`
2320
<!--/options-->
2421

2522
*[→ Full specification](metadata.yml)*

‎source/plugins/habits/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,12 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
3434
| `plugin_habits_from` | `number` **[200]** *{1 ≤ 𝑥 ≤ 1000}* | Number of events to use |
3535
| `plugin_habits_days` | `number` **[14]** *{1 ≤ 𝑥 ≤ 30}* | Maximum event age |
3636
| `plugin_habits_facts` | `boolean` **[yes]** | Display coding habits collected facts based on recent activity |
37-
| `plugin_habits_charts` | `boolean` **[no]** | Display coding habits charts based on recent activity |
37+
| `plugin_habits_charts` <sup>🧰</sup> | `boolean` **[no]** | Display coding habits charts based on recent activity |
3838
| `plugin_habits_trim` | `boolean` **[no]** | Trim unused hours on daily chart |
3939

4040

4141
Legend for option icons:
42-
* 🔐 Value should be stored in repository secrets
43-
* ✨ New feature currently in testing on `master`/`main`
42+
* 🧰 Must be enabled in `settings.json` (for web instances)
4443
<!--/options-->
4544

4645
*[→ Full specification](metadata.yml)*

‎source/plugins/introduction/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
2424
| `plugin_introduction_title` | `boolean` **[yes]** | Display introduction section title |
2525

2626

27-
Legend for option icons:
28-
* 🔐 Value should be stored in repository secrets
29-
* ✨ New feature currently in testing on `master`/`main`
3027
<!--/options-->
3128

3229
*[→ Full specification](metadata.yml)*

‎source/plugins/isocalendar/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ The *isocalendar* plugin displays an isometric view of your commits calendar, al
2323
| `plugin_isocalendar_duration` | `string` **[half-year]** *{"half-year", "full-year"}* | Set time window shown by isometric calendar |
2424

2525

26-
Legend for option icons:
27-
* 🔐 Value should be stored in repository secrets
28-
* ✨ New feature currently in testing on `master`/`main`
2926
<!--/options-->
3027

3128
*[→ Full specification](metadata.yml)*

‎source/plugins/languages/README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -52,22 +52,21 @@ For better results, it's advised to add either your surnames and eventually no-r
5252
| `plugin_languages_ignored` | `array` *(comma-separated)* **[]** | Languages to ignore |
5353
| `plugin_languages_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
5454
| `plugin_languages_limit` | `number` **[8]** *{0 ≤ 𝑥 ≤ 8}* | Maximum number of languages to display |
55-
| `plugin_languages_sections` | `array` *(comma-separated)* **[most-used]** *{"most-used", "recently-used"}* | Sections to display |
56-
| `plugin_languages_colors` | `array` *(comma-separated,/((?<index>[0-9])|(?<language>[-+a-z0-9#]+)):(?<color>#?[-a-z0-9]+)/)* **[github]** | Custom languages colors |
55+
| `plugin_languages_sections` <sup>🧰</sup> | `array` *(comma-separated)* **[most-used]** *{"most-used", "recently-used"}* | Sections to display |
56+
| `plugin_languages_colors` | `array` *(comma-separated)* **[github]** | Custom languages colors |
5757
| `plugin_languages_aliases` | `string` **[]** | Custom languages names |
5858
| `plugin_languages_details` | `array` *(comma-separated)* **[]** *{"bytes-size", "percentage", "lines"}* | Additional details |
5959
| `plugin_languages_threshold` | `string` **[0%]** | Minimum threshold |
60-
| `plugin_languages_indepth` | `boolean` **[false]** | Indepth languages processing (see documentation before enabling) |
61-
| `plugin_languages_analysis_timeout` | `number` **[15]** *{1 ≤ 𝑥 ≤ 30}* | Languages analysis timeout |
60+
| `plugin_languages_indepth` <sup>🧰</sup> | `boolean` **[false]** | Indepth languages processing (see documentation before enabling) |
61+
| `plugin_languages_analysis_timeout` <sup>🧰</sup> | `number` **[15]** *{1 ≤ 𝑥 ≤ 30}* | Languages analysis timeout |
6262
| `plugin_languages_categories` | `array` *(comma-separated)* **[markup, programming]** *{"data", "markup", "programming", "prose"}* | Language categories to display |
6363
| `plugin_languages_recent_categories` | `array` *(comma-separated)* **[markup, programming]** *{"data", "markup", "programming", "prose"}* | Language categories to display (for recently used section) |
6464
| `plugin_languages_recent_load` | `number` **[300]** *{100 ≤ 𝑥 ≤ 1000}* | Number of events to load (for recently used section) |
6565
| `plugin_languages_recent_days` | `number` **[14]** *{0 ≤ 𝑥 ≤ 365}* | Maximum event age (for recently used section) |
6666

6767

6868
Legend for option icons:
69-
* 🔐 Value should be stored in repository secrets
70-
* ✨ New feature currently in testing on `master`/`main`
69+
* 🧰 Must be enabled in `settings.json` (for web instances)
7170
<!--/options-->
7271

7372
*[→ Full specification](metadata.yml)*

‎source/plugins/licenses/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,14 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
2929
<!--options-->
3030
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
3131
| ------ | -------------------------------- | ----------- |
32-
| `plugin_licenses` | `boolean` **[no]** | Display licenses informations |
32+
| `plugin_licenses` <sup>🧰</sup> | `boolean` **[no]** | Display licenses informations |
3333
| `plugin_licenses_setup` | `string` **[]** | Command to setup target repository |
3434
| `plugin_licenses_ratio` | `boolean` **[no]** | Display used licenses ratio |
3535
| `plugin_licenses_legal` | `boolean` **[yes]** | Display legal informations about used licenses |
3636

3737

3838
Legend for option icons:
39-
* 🔐 Value should be stored in repository secrets
40-
* ✨ New feature currently in testing on `master`/`main`
39+
* 🧰 Must be enabled in `settings.json` (for web instances)
4140
<!--/options-->
4241

4342
*[→ Full specification](metadata.yml)*

‎source/plugins/lines/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,11 @@ The *lines* of code plugin displays the number of lines of code you have added a
1515
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
1616
| ------ | -------------------------------- | ----------- |
1717
| `plugin_lines` | `boolean` **[no]** | Display lines of code metrics |
18-
| `plugin_lines_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip |
18+
| `plugin_lines_skipped` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Repositories to skip |
1919

2020

2121
Legend for option icons:
22-
* 🔐 Value should be stored in repository secrets
23-
* ✨ New feature currently in testing on `master`/`main`
22+
* ⏩ Value inherits from its related global-level option
2423
<!--/options-->
2524

2625
*[→ Full specification](metadata.yml)*

0 commit comments

Comments
 (0)
Failed to load comments.