Skip to content

Commit a0eb798

Browse files
ci: auto-regenerate files
1 parent a586769 commit a0eb798

File tree

42 files changed

+245
-248
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+245
-248
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,8 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
356356
# 📚 Documentation
357357

358358

359+
> <sup>*⚠️ This is the documentation of **v3.20-beta** (`@master`/`@main` branches) which includes [unreleased features](https://github.com/lowlighter/metrics/compare/latest...master). See documentation for [**v3.19** (`@latest` branch) here](https://github.com/lowlighter/metrics/blob/latest/README.md).*</sup>
360+
359361

360362

361363
## 🦮 Setup

source/plugins/achievements/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
3232
</tr>
3333
<tr>
34-
<td nowrap="nowrap"><code>plugin_achievements</code></td>
34+
<td nowrap="nowrap"><h4><code>plugin_achievements</code></h4></td>
3535
<td rowspan="2"><p>Enable achievements plugin</p>
3636
<img width="900" height="1" alt=""></td>
3737
</tr>
@@ -41,7 +41,7 @@
4141
<b>default:</b> no<br></td>
4242
</tr>
4343
<tr>
44-
<td nowrap="nowrap"><code>plugin_achievements_threshold</code></td>
44+
<td nowrap="nowrap"><h4><code>plugin_achievements_threshold</code></h4></td>
4545
<td rowspan="2"><p>Display rank threshold</p>
4646
<p>Use <code>X</code> to display achievements not yet unlocked</p>
4747
<img width="900" height="1" alt=""></td>
@@ -53,7 +53,7 @@
5353
<b>allowed values:</b><ul><li>S</li><li>A</li><li>B</li><li>C</li><li>X</li></ul></td>
5454
</tr>
5555
<tr>
56-
<td nowrap="nowrap"><code>plugin_achievements_secrets</code></td>
56+
<td nowrap="nowrap"><h4><code>plugin_achievements_secrets</code></h4></td>
5757
<td rowspan="2"><p>Display secrets achievements</p>
5858
<img width="900" height="1" alt=""></td>
5959
</tr>
@@ -63,7 +63,7 @@
6363
<b>default:</b> yes<br></td>
6464
</tr>
6565
<tr>
66-
<td nowrap="nowrap"><code>plugin_achievements_display</code></td>
66+
<td nowrap="nowrap"><h4><code>plugin_achievements_display</code></h4></td>
6767
<td rowspan="2"><p>Display style</p>
6868
<ul>
6969
<li><code>detailed</code>: display icon, name, description and ranking</li>
@@ -78,7 +78,7 @@
7878
<b>allowed values:</b><ul><li>detailed</li><li>compact</li></ul></td>
7979
</tr>
8080
<tr>
81-
<td nowrap="nowrap"><code>plugin_achievements_limit</code></td>
81+
<td nowrap="nowrap"><h4><code>plugin_achievements_limit</code></h4></td>
8282
<td rowspan="2"><p>Display limit</p>
8383
<img width="900" height="1" alt=""></td>
8484
</tr>
@@ -90,7 +90,7 @@
9090
<b>default:</b> 0<br></td>
9191
</tr>
9292
<tr>
93-
<td nowrap="nowrap"><code>plugin_achievements_ignored</code></td>
93+
<td nowrap="nowrap"><h4><code>plugin_achievements_ignored</code></h4></td>
9494
<td rowspan="2"><p>Hide specified achievements</p>
9595
<p>Use names without the rank adjective (i.e. without &quot;great&quot;, &quot;super&quot; or &quot;master&quot;)</p>
9696
<img width="900" height="1" alt=""></td>
@@ -101,7 +101,7 @@
101101
<br></td>
102102
</tr>
103103
<tr>
104-
<td nowrap="nowrap"><code>plugin_achievements_only</code></td>
104+
<td nowrap="nowrap"><h4><code>plugin_achievements_only</code></h4></td>
105105
<td rowspan="2"><p>Restrict display to specified achievements</p>
106106
<p>Use names without the rank adjective (i.e. without &quot;great&quot;, &quot;super&quot; or &quot;master&quot;)</p>
107107
<p>This option is equivalent to <code>plugin_achievements_ignored</code> with all existing achievements but the ones listed in this option</p>

source/plugins/activity/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
3131
</tr>
3232
<tr>
33-
<td nowrap="nowrap"><code>plugin_activity</code></td>
33+
<td nowrap="nowrap"><h4><code>plugin_activity</code></h4></td>
3434
<td rowspan="2"><p>Enable activity plugin</p>
3535
<img width="900" height="1" alt=""></td>
3636
</tr>
@@ -40,7 +40,7 @@
4040
<b>default:</b> no<br></td>
4141
</tr>
4242
<tr>
43-
<td nowrap="nowrap"><code>plugin_activity_limit</code></td>
43+
<td nowrap="nowrap"><h4><code>plugin_activity_limit</code></h4></td>
4444
<td rowspan="2"><p>Display limit</p>
4545
<img width="900" height="1" alt=""></td>
4646
</tr>
@@ -53,7 +53,7 @@
5353
<b>default:</b> 5<br></td>
5454
</tr>
5555
<tr>
56-
<td nowrap="nowrap"><code>plugin_activity_load</code></td>
56+
<td nowrap="nowrap"><h4><code>plugin_activity_load</code></h4></td>
5757
<td rowspan="2"><p>Events to load</p>
5858
<img width="900" height="1" alt=""></td>
5959
</tr>
@@ -66,7 +66,7 @@
6666
<b>default:</b> 300<br></td>
6767
</tr>
6868
<tr>
69-
<td nowrap="nowrap"><code>plugin_activity_days</code></td>
69+
<td nowrap="nowrap"><h4><code>plugin_activity_days</code></h4></td>
7070
<td rowspan="2"><p>Events maximum age</p>
7171
<img width="900" height="1" alt=""></td>
7272
</tr>
@@ -80,7 +80,7 @@
8080
<b>default:</b> 14<br></td>
8181
</tr>
8282
<tr>
83-
<td nowrap="nowrap"><code>plugin_activity_visibility</code></td>
83+
<td nowrap="nowrap"><h4><code>plugin_activity_visibility</code></h4></td>
8484
<td rowspan="2"><p>Events visibility</p>
8585
<p>Lets you hide private activity when using a <code>repo</code> scope token</p>
8686
<img width="900" height="1" alt=""></td>
@@ -92,7 +92,7 @@
9292
<b>allowed values:</b><ul><li>public</li><li>all</li></ul></td>
9393
</tr>
9494
<tr>
95-
<td nowrap="nowrap"><code>plugin_activity_timestamps</code></td>
95+
<td nowrap="nowrap"><h4><code>plugin_activity_timestamps</code></h4></td>
9696
<td rowspan="2"><p>Display events timestamps</p>
9797
<img width="900" height="1" alt=""></td>
9898
</tr>
@@ -102,7 +102,7 @@
102102
<b>default:</b> no<br></td>
103103
</tr>
104104
<tr>
105-
<td nowrap="nowrap"><code>plugin_activity_skipped</code></td>
105+
<td nowrap="nowrap"><h4><code>plugin_activity_skipped</code></h4></td>
106106
<td rowspan="2"><p>Skipped repositories</p>
107107
<img width="900" height="1" alt=""></td>
108108
</tr>
@@ -113,7 +113,7 @@
113113
<br></td>
114114
</tr>
115115
<tr>
116-
<td nowrap="nowrap"><code>plugin_activity_ignored</code></td>
116+
<td nowrap="nowrap"><h4><code>plugin_activity_ignored</code></h4></td>
117117
<td rowspan="2"><p>Ignored users</p>
118118
<p>Useful to ignore bots activity</p>
119119
<img width="900" height="1" alt=""></td>
@@ -125,7 +125,7 @@
125125
<br></td>
126126
</tr>
127127
<tr>
128-
<td nowrap="nowrap"><code>plugin_activity_filter</code></td>
128+
<td nowrap="nowrap"><h4><code>plugin_activity_filter</code></h4></td>
129129
<td rowspan="2"><p>Events types</p>
130130
<p>These are fetched from <a href="https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/github-event-types">GitHub events API</a> and the following types are currently supported:</p>
131131
<ul>

source/plugins/anilist/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
3333
</tr>
3434
<tr>
35-
<td nowrap="nowrap"><code>plugin_anilist</code></td>
35+
<td nowrap="nowrap"><h4><code>plugin_anilist</code></h4></td>
3636
<td rowspan="2"><p>Enable aniList plugin</p>
3737
<img width="900" height="1" alt=""></td>
3838
</tr>
@@ -42,7 +42,7 @@
4242
<b>default:</b> no<br></td>
4343
</tr>
4444
<tr>
45-
<td nowrap="nowrap"><code>plugin_anilist_medias</code></td>
45+
<td nowrap="nowrap"><h4><code>plugin_anilist_medias</code></h4></td>
4646
<td rowspan="2"><p>Display medias types</p>
4747
<img width="900" height="1" alt=""></td>
4848
</tr>
@@ -54,7 +54,7 @@
5454
<b>allowed values:</b><ul><li>anime</li><li>manga</li></ul></td>
5555
</tr>
5656
<tr>
57-
<td nowrap="nowrap"><code>plugin_anilist_sections</code></td>
57+
<td nowrap="nowrap"><h4><code>plugin_anilist_sections</code></h4></td>
5858
<td rowspan="2"><p>Displayed sections</p>
5959
<ul>
6060
<li><code>favorites</code> will display favorites <code>plugin_anilist_medias</code></li>
@@ -72,7 +72,7 @@
7272
<b>allowed values:</b><ul><li>favorites</li><li>watching</li><li>reading</li><li>characters</li></ul></td>
7373
</tr>
7474
<tr>
75-
<td nowrap="nowrap"><code>plugin_anilist_limit</code></td>
75+
<td nowrap="nowrap"><h4><code>plugin_anilist_limit</code></h4></td>
7676
<td rowspan="2"><p>Display limit (medias)</p>
7777
<img width="900" height="1" alt=""></td>
7878
</tr>
@@ -85,7 +85,7 @@
8585
<b>default:</b> 2<br></td>
8686
</tr>
8787
<tr>
88-
<td nowrap="nowrap"><code>plugin_anilist_limit_characters</code></td>
88+
<td nowrap="nowrap"><h4><code>plugin_anilist_limit_characters</code></h4></td>
8989
<td rowspan="2"><p>Display limit (characters)</p>
9090
<img width="900" height="1" alt=""></td>
9191
</tr>
@@ -98,7 +98,7 @@
9898
<b>default:</b> 22<br></td>
9999
</tr>
100100
<tr>
101-
<td nowrap="nowrap"><code>plugin_anilist_shuffle</code></td>
101+
<td nowrap="nowrap"><h4><code>plugin_anilist_shuffle</code></h4></td>
102102
<td rowspan="2"><p>Shuffle data for varied outputs</p>
103103
<img width="900" height="1" alt=""></td>
104104
</tr>
@@ -108,7 +108,7 @@
108108
<b>default:</b> yes<br></td>
109109
</tr>
110110
<tr>
111-
<td nowrap="nowrap"><code>plugin_anilist_user</code></td>
111+
<td nowrap="nowrap"><h4><code>plugin_anilist_user</code></h4></td>
112112
<td rowspan="2"><p>AniList login</p>
113113
<img width="900" height="1" alt=""></td>
114114
</tr>

source/plugins/base/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
3434
</tr>
3535
<tr>
36-
<td nowrap="nowrap"><code>base</code></td>
36+
<td nowrap="nowrap"><h4><code>base</code></h4></td>
3737
<td rowspan="2"><p>Base content</p>
3838
<p>The following sections are supported:</p>
3939
<ul>
@@ -54,7 +54,7 @@
5454
<b>allowed values:</b><ul><li>header</li><li>activity</li><li>community</li><li>repositories</li><li>metadata</li></ul></td>
5555
</tr>
5656
<tr>
57-
<td nowrap="nowrap"><code>repositories</code></td>
57+
<td nowrap="nowrap"><h4><code>repositories</code></h4></td>
5858
<td rowspan="2"><p>Repositories to fetch</p>
5959
<p>A higher value result in more accurate metrics but can hit GitHub API rate-limit more easily (especially with a lot of plugins enabled)</p>
6060
<img width="900" height="1" alt=""></td>
@@ -67,7 +67,7 @@
6767
<b>default:</b> 100<br></td>
6868
</tr>
6969
<tr>
70-
<td nowrap="nowrap"><code>repositories_batch</code></td>
70+
<td nowrap="nowrap"><h4><code>repositories_batch</code></h4></td>
7171
<td rowspan="2"><p>Repositories to fetch at a time</p>
7272
<p>If you receive <code>Something went wrong while executing your query</code> (which is usually caused by API timeout),
7373
try lowering this value.</p>
@@ -82,7 +82,7 @@ try lowering this value.</p>
8282
<b>default:</b> 100<br></td>
8383
</tr>
8484
<tr>
85-
<td nowrap="nowrap"><code>repositories_forks</code></td>
85+
<td nowrap="nowrap"><h4><code>repositories_forks</code></h4></td>
8686
<td rowspan="2"><p>Include forks</p>
8787
<img width="900" height="1" alt=""></td>
8888
</tr>
@@ -92,7 +92,7 @@ try lowering this value.</p>
9292
<b>default:</b> no<br></td>
9393
</tr>
9494
<tr>
95-
<td nowrap="nowrap"><code>repositories_affiliations</code></td>
95+
<td nowrap="nowrap"><h4><code>repositories_affiliations</code></h4></td>
9696
<td rowspan="2"><p>Repositories affiliations</p>
9797
<ul>
9898
<li><code>owner</code>: owned repositories</li>
@@ -112,7 +112,7 @@ Broad affiliation will result in less representative metrics.</p>
112112
<b>allowed values:</b><ul><li>owner</li><li>collaborator</li><li>organization_member</li></ul></td>
113113
</tr>
114114
<tr>
115-
<td nowrap="nowrap"><code>repositories_skipped</code></td>
115+
<td nowrap="nowrap"><h4><code>repositories_skipped</code></h4></td>
116116
<td rowspan="2"><p>Default skipped repositories</p>
117117
<img width="900" height="1" alt=""></td>
118118
</tr>
@@ -123,7 +123,7 @@ Broad affiliation will result in less representative metrics.</p>
123123
<br></td>
124124
</tr>
125125
<tr>
126-
<td nowrap="nowrap"><code>users_ignored</code></td>
126+
<td nowrap="nowrap"><h4><code>users_ignored</code></h4></td>
127127
<td rowspan="2"><p>Default ignored users</p>
128128
<img width="900" height="1" alt=""></td>
129129
</tr>
@@ -135,7 +135,7 @@ Broad affiliation will result in less representative metrics.</p>
135135
<b>default:</b> github-actions[bot], dependabot[bot], dependabot-preview[bot]<br></td>
136136
</tr>
137137
<tr>
138-
<td nowrap="nowrap"><code>commits_authoring</code></td>
138+
<td nowrap="nowrap"><h4><code>commits_authoring</code></h4></td>
139139
<td rowspan="2"><p>Identifiers that has been used for authoring commits</p>
140140
<p>Specify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins</p>
141141
<img width="900" height="1" alt=""></td>

source/plugins/code/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
3535
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
3636
</tr>
3737
<tr>
38-
<td nowrap="nowrap"><code>plugin_code</code></td>
38+
<td nowrap="nowrap"><h4><code>plugin_code</code></h4></td>
3939
<td rowspan="2"><p>Enable code plugin</p>
4040
<img width="900" height="1" alt=""></td>
4141
</tr>
@@ -45,7 +45,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
4545
<b>default:</b> no<br></td>
4646
</tr>
4747
<tr>
48-
<td nowrap="nowrap"><code>plugin_code_lines</code></td>
48+
<td nowrap="nowrap"><h4><code>plugin_code_lines</code></h4></td>
4949
<td rowspan="2"><p>Display limit for code snippets</p>
5050
<img width="900" height="1" alt=""></td>
5151
</tr>
@@ -55,7 +55,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
5555
<b>default:</b> 12<br></td>
5656
</tr>
5757
<tr>
58-
<td nowrap="nowrap"><code>plugin_code_load</code></td>
58+
<td nowrap="nowrap"><h4><code>plugin_code_load</code></h4></td>
5959
<td rowspan="2"><p>Events to load</p>
6060
<img width="900" height="1" alt=""></td>
6161
</tr>
@@ -68,7 +68,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
6868
<b>default:</b> 100<br></td>
6969
</tr>
7070
<tr>
71-
<td nowrap="nowrap"><code>plugin_code_visibility</code></td>
71+
<td nowrap="nowrap"><h4><code>plugin_code_visibility</code></h4></td>
7272
<td rowspan="2"><p>Events visibility</p>
7373
<p>Lets you hide private activity when using a <code>repo</code> scope token</p>
7474
<img width="900" height="1" alt=""></td>
@@ -80,7 +80,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
8080
<b>allowed values:</b><ul><li>public</li><li>all</li></ul></td>
8181
</tr>
8282
<tr>
83-
<td nowrap="nowrap"><code>plugin_code_skipped</code></td>
83+
<td nowrap="nowrap"><h4><code>plugin_code_skipped</code></h4></td>
8484
<td rowspan="2"><p>Skipped repositories</p>
8585
<img width="900" height="1" alt=""></td>
8686
</tr>
@@ -91,7 +91,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
9191
<br></td>
9292
</tr>
9393
<tr>
94-
<td nowrap="nowrap"><code>plugin_code_languages</code></td>
94+
<td nowrap="nowrap"><h4><code>plugin_code_languages</code></h4></td>
9595
<td rowspan="2"><p>Restrict display to specific languages</p>
9696
<img width="900" height="1" alt=""></td>
9797
</tr>

source/plugins/community/fortune/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,12 @@
3131
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
3232
</tr>
3333
<tr>
34-
<td nowrap="nowrap"><code>plugin_fortune</code></td>
34+
<td nowrap="nowrap"><h4><code>plugin_fortune</code></h4></td>
3535
<td rowspan="2"><p>Enable fortune plugin</p>
3636
<img width="900" height="1" alt=""></td>
3737
</tr>
3838
<tr>
39-
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
40-
<b>type:</b> <code>boolean</code>
39+
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
4140
<br>
4241
<b>default:</b> no<br></td>
4342
</tr>

0 commit comments

Comments
 (0)