Skip to content

Commit 2251ba7

Browse files
ci: auto-regenerate files
1 parent 3decb9b commit 2251ba7

File tree

6 files changed

+37
-21
lines changed

6 files changed

+37
-21
lines changed

action.yml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

source/plugins/base/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ This currently improves the accuracy of the following statistics:</p>
9292
<td rowspan="2"><p>Skip base content</p>
9393
<blockquote>
9494
<p>⚠️ Any plugin that relies on base content data may break!
95-
Only use this option when using a plugin that can be configured with <code>token: NOT_NEEDED</code></p>
95+
Only use this option when using a plugin that can be configured with <a href="/source/plugins/core/README.md#token"><code>token: NOT_NEEDED</code></a></p>
9696
</blockquote>
9797
<img width="900" height="1" alt=""></td>
9898
</tr>

source/plugins/community/chess/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ All product and company names are trademarks™ or registered® trademarks of th
6060
</tr>
6161
<tr>
6262
<td nowrap="nowrap"><h4><code>plugin_chess_user</code></h4></td>
63-
<td rowspan="2"><p>AniList login</p>
63+
<td rowspan="2"><p>Chess platform login</p>
6464
<img width="900" height="1" alt=""></td>
6565
</tr>
6666
<tr>

source/plugins/contributors/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ All product and company names are trademarks™ or registered® trademarks of th
9292
<td rowspan="2"><p>Displayed sections</p>
9393
<ul>
9494
<li><code>contributors</code>: all contributors</li>
95-
<li><code>categories</code>: contributors sorted by contributions categories (must be configured with <code>plugin_contributors_categories</code>)</li>
95+
<li><code>categories</code>: contributors sorted by contributions categories (must be configured with <a href="/source/plugins/contributors/README.md#plugin_contributors_categories"><code>plugin_contributors_categories</code></a>)</li>
9696
</ul>
9797
<img width="900" height="1" alt=""></td>
9898
</tr>

source/plugins/core/README.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ When doing so, any settings which defaults on user fetched values will not be te
474474
<tr>
475475
<td nowrap="nowrap"><h4><code>user</code></h4></td>
476476
<td rowspan="2"><p>GitHub username</p>
477-
<p>Defaults to <code>token</code> owner username.</p>
477+
<p>Defaults to <a href="/source/plugins/core/README.md#token"><code>token</code></a> owner username.</p>
478478
<img width="900" height="1" alt=""></td>
479479
</tr>
480480
<tr>
@@ -498,7 +498,7 @@ When doing so, any settings which defaults on user fetched values will not be te
498498
<td rowspan="2"><p>GitHub Token used to commit metrics</p>
499499
<p>Leave this to <code>${{ github.token }}</code> or <code>${{ secrets.GITHUB_TOKEN }}</code>, which is a special auto-generated token restricted to current repository scope.</p>
500500
<blockquote>
501-
<p>💡 When using <code>output_action: gist</code>, it will use <code>token</code> instead, since gists are outside of scope</p>
501+
<p>💡 When using <a href="/source/plugins/core/README.md#output_action"><code>output_action: gist</code></a>, it will use <a href="/source/plugins/core/README.md#token"><code>token</code></a> instead, since gists are outside of scope</p>
502502
</blockquote>
503503
<img width="900" height="1" alt=""></td>
504504
</tr>
@@ -532,7 +532,7 @@ When doing so, any settings which defaults on user fetched values will not be te
532532
<tr>
533533
<td nowrap="nowrap"><h4><code>committer_gist</code></h4></td>
534534
<td rowspan="2"><p>Gist id</p>
535-
<p>Specify an existing gist id (can be retrieved from its URL) when using <code>output_action: gist</code>.</p>
535+
<p>Specify an existing gist id (can be retrieved from its URL) when using <a href="/source/plugins/core/README.md#output_action"><code>output_action: gist</code></a>.</p>
536536
<img width="900" height="1" alt=""></td>
537537
</tr>
538538
<tr>
@@ -543,7 +543,7 @@ When doing so, any settings which defaults on user fetched values will not be te
543543
<tr>
544544
<td nowrap="nowrap"><h4><code>filename</code></h4></td>
545545
<td rowspan="2"><p>Output path</p>
546-
<p>When using an asterisk (<code>*</code>), correct extension will automatically be applied according to <code>config_output</code> value</p>
546+
<p>When using an asterisk (<code>*</code>), correct extension will automatically be applied according to <a href="/source/plugins/core/README.md#config_output"><code>config_output</code></a> value</p>
547547
<img width="900" height="1" alt=""></td>
548548
</tr>
549549
<tr>
@@ -602,6 +602,9 @@ When doing so, any settings which defaults on user fetched values will not be te
602602
<li><code>always</code>: always try to push changes</li>
603603
<li><code>data-changed</code>: skip changes if no data changed (e.g. like when only metadata changed)</li>
604604
</ul>
605+
<blockquote>
606+
<p>ℹ️ This option is only revelant when <a href="/source/plugins/core/README.md#config_output"><code>config_output: svg</code></a> is set</p>
607+
</blockquote>
605608
<img width="900" height="1" alt=""></td>
606609
</tr>
607610
<tr>
@@ -616,9 +619,9 @@ When doing so, any settings which defaults on user fetched values will not be te
616619
<ul>
617620
<li><code>css</code>: purge and minify CSS styles</li>
618621
<li><code>xml</code>: pretty-print XML (useful to reduce diff)</li>
619-
<li><code>svg</code>: optimization with SVGO (experimental, require <code>--optimize-svg</code> experimental flag)</li>
622+
<li><code>svg</code>: optimization with SVGO (experimental, requires <a href="/source/plugins/core/README.md#experimental_features"><code>experimental_features: --optimize-svg</code></a>)</li>
620623
</ul>
621-
<p>Some templates may not support all options</p>
624+
<p>Templates may not always honour all provided options</p>
622625
<img width="900" height="1" alt=""></td>
623626
</tr>
624627
<tr>
@@ -675,6 +678,9 @@ This is mostly useful for custom templates.</p>
675678
<td rowspan="2"><p>Extra CSS</p>
676679
<p>Custom CSS that will be injected in used template.
677680
Useful to avoid creating a new template just to tweak some styling</p>
681+
<blockquote>
682+
<p>💡 <em>metrics</em> tends to avoid using <code>!important</code> rules, which means that most styling can be overridden by this option when using <code>!important</code></p>
683+
</blockquote>
678684
<img width="900" height="1" alt=""></td>
679685
</tr>
680686
<tr>
@@ -690,8 +696,11 @@ Useful to avoid creating a new template just to tweak some styling</p>
690696
<td rowspan="2"><p>Extra JavaScript</p>
691697
<p>Custom JavaScript that will be executed during puppeteer rendering.
692698
Useful to avoid creating a new template just to tweak some content.</p>
693-
<p>Note that is it executed within puppeteer context and <strong>not</strong> <em>metrics</em> context.
699+
<blockquote>
700+
<p>⚠️ Note that is it executed within puppeteer context and <strong>not</strong> within <em>metrics</em> context.
701+
No access to fetched data or configuration will be offered through this context.
694702
It is run after transformations and optimizations, but just before resizing.</p>
703+
</blockquote>
695704
<img width="900" height="1" alt=""></td>
696705
</tr>
697706
<tr>
@@ -772,7 +781,7 @@ May increase filesize.</p>
772781
<td rowspan="2"><p>Use GitHub custom emojis</p>
773782
<p>GitHub supports additional emojis which are not registered in Unicode standard (:octocat:, :shipit:, :trollface:, ...)
774783
See full list at <a href="https://api.github.com/emojis">https://api.github.com/emojis</a>.</p>
775-
<p>This option has no effect when <code>token: NOT_NEEDED</code> is set.</p>
784+
<p>This option has no effect when [`token: NOT_NEEDED``](/source/plugins/core/README.md#token) is set.</p>
776785
<p>May increase filesize</p>
777786
<img width="900" height="1" alt=""></td>
778787
</tr>
@@ -854,9 +863,9 @@ It can result in cropped or oversized outputs.</p>
854863
</ul>
855864
<p>Each value need to respect the following format:</p>
856865
<ul>
857-
<li>{number}</li>
858-
<li>{number} + {number}%</li>
859-
<li>{number}%</li>
866+
<li><code>{number}</code></li>
867+
<li><code>{number} + {number}%</code></li>
868+
<li><code>{number}%</code></li>
860869
</ul>
861870
<p>Percentage are relative to computed dimensions</p>
862871
<img width="900" height="1" alt=""></td>
@@ -990,7 +999,7 @@ Be sure to disable this option when asking for help or submitting bug reports.</
990999
<td nowrap="nowrap"><h4><code>quota_required_rest</code></h4></td>
9911000
<td rowspan="2"><p>Minimum GitHub REST API requests quota required to run</p>
9921001
<p>Action will cancel itself without any errors if requirements are not met</p>
993-
<p>This option has no effect when <code>token</code> is set to <code>NOT_NEEDED</code></p>
1002+
<p>This option has no effect when <a href="/source/plugins/core/README.md#token"><code>token: NOT_NEEDED</code></a> is set</p>
9941003
<img width="900" height="1" alt=""></td>
9951004
</tr>
9961005
<tr>
@@ -1005,7 +1014,7 @@ Be sure to disable this option when asking for help or submitting bug reports.</
10051014
<td nowrap="nowrap"><h4><code>quota_required_graphql</code></h4></td>
10061015
<td rowspan="2"><p>Minimum GitHub GraphQL API requests quota required to run</p>
10071016
<p>Action will cancel itself without any errors if requirements are not met</p>
1008-
<p>This option has no effect when <code>token</code> is set to <code>NOT_NEEDED</code></p>
1017+
<p>This option has no effect when <a href="/source/plugins/core/README.md#token"><code>token: NOT_NEEDED</code></a> is set</p>
10091018
<img width="900" height="1" alt=""></td>
10101019
</tr>
10111020
<tr>
@@ -1020,7 +1029,7 @@ Be sure to disable this option when asking for help or submitting bug reports.</
10201029
<td nowrap="nowrap"><h4><code>quota_required_search</code></h4></td>
10211030
<td rowspan="2"><p>Minimum GitHub Search API requests quota required to run</p>
10221031
<p>Action will cancel itself without any errors if requirements are not met</p>
1023-
<p>This option has no effect when <code>token</code> is set to <code>NOT_NEEDED</code></p>
1032+
<p>This option has no effect when <a href="/source/plugins/core/README.md#token"><code>token: NOT_NEEDED</code></a> is set</p>
10241033
<img width="900" height="1" alt=""></td>
10251034
</tr>
10261035
<tr>
@@ -1071,7 +1080,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
10711080
<tr>
10721081
<td nowrap="nowrap"><h4><code>debug</code></h4></td>
10731082
<td rowspan="2"><p>Debug mode</p>
1074-
<p>This setting is automatically enable if a job fail (useful with <code>plugins_errors_fatal: yes</code>)</p>
1083+
<p>This setting is automatically enable if a job fail (useful with <a href="/source/plugins/core/README.md#plugins_errors_fatal"><code>plugins_errors_fatal: yes</code></a>)</p>
10751084
<img width="900" height="1" alt=""></td>
10761085
</tr>
10771086
<tr>
@@ -1130,7 +1139,9 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
11301139
<tr>
11311140
<td nowrap="nowrap"><h4><code>dryrun</code></h4></td>
11321141
<td rowspan="2"><p>Dry-run</p>
1133-
<p>Contrary to <code>output_action: none</code>, output file won&#39;t be available in <code>/metrics_renders</code> directory</p>
1142+
<blockquote>
1143+
<p>⚠️ Unlike <a href="/source/plugins/core/README.md#output_action"><code>output_action: none</code></a>, output file won&#39;t be available in <code>/metrics_renders</code> directory</p>
1144+
</blockquote>
11341145
<img width="900" height="1" alt=""></td>
11351146
</tr>
11361147
<tr>
@@ -1143,7 +1154,9 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
11431154
<tr>
11441155
<td nowrap="nowrap"><h4><code>experimental_features</code></h4></td>
11451156
<td rowspan="2"><p>Experimental features</p>
1146-
<p>No backward compatibility is guaranteed for these features</p>
1157+
<blockquote>
1158+
<p>⚠️ No backward compatibility is guaranteed for these features</p>
1159+
</blockquote>
11471160
<img width="900" height="1" alt=""></td>
11481161
</tr>
11491162
<tr>

source/plugins/lines/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ All product and company names are trademarks™ or registered® trademarks of th
6363
<li><code>repositories</code> will display repositories with the most lines added and removed</li>
6464
<li><code>history</code> will display a graph displaying lines added and removed over time</li>
6565
</ul>
66+
<blockquote>
67+
<p>ℹ️ <code>base</code> requires at least <a href="/source/plugins/base/README.md#base"><code>base: repositories</code></a> to be set</p>
68+
</blockquote>
6669
<img width="900" height="1" alt=""></td>
6770
</tr>
6871
<tr>

0 commit comments

Comments
 (0)