You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/plugins/base/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ This currently improves the accuracy of the following statistics:</p>
92
92
<td rowspan="2"><p>Skip base content</p>
93
93
<blockquote>
94
94
<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 <ahref="/source/plugins/core/README.md#token"><code>token: NOT_NEEDED</code></a></p>
Copy file name to clipboardExpand all lines: source/plugins/contributors/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ All product and company names are trademarks™ or registered® trademarks of th
92
92
<td rowspan="2"><p>Displayed sections</p>
93
93
<ul>
94
94
<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 <ahref="/source/plugins/contributors/README.md#plugin_contributors_categories"><code>plugin_contributors_categories</code></a>)</li>
<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>
478
478
<img width="900" height="1" alt=""></td>
479
479
</tr>
480
480
<tr>
@@ -498,7 +498,7 @@ When doing so, any settings which defaults on user fetched values will not be te
498
498
<td rowspan="2"><p>GitHub Token used to commit metrics</p>
499
499
<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>
500
500
<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>
502
502
</blockquote>
503
503
<img width="900" height="1" alt=""></td>
504
504
</tr>
@@ -532,7 +532,7 @@ When doing so, any settings which defaults on user fetched values will not be te
<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>
536
536
<img width="900" height="1" alt=""></td>
537
537
</tr>
538
538
<tr>
@@ -543,7 +543,7 @@ When doing so, any settings which defaults on user fetched values will not be te
<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>
547
547
<img width="900" height="1" alt=""></td>
548
548
</tr>
549
549
<tr>
@@ -602,6 +602,9 @@ When doing so, any settings which defaults on user fetched values will not be te
602
602
<li><code>always</code>: always try to push changes</li>
603
603
<li><code>data-changed</code>: skip changes if no data changed (e.g. like when only metadata changed)</li>
604
604
</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>
605
608
<img width="900" height="1" alt=""></td>
606
609
</tr>
607
610
<tr>
@@ -616,9 +619,9 @@ When doing so, any settings which defaults on user fetched values will not be te
616
619
<ul>
617
620
<li><code>css</code>: purge and minify CSS styles</li>
618
621
<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>
620
623
</ul>
621
-
<p>Some templates may not support all options</p>
624
+
<p>Templates may not always honour all provided options</p>
622
625
<img width="900" height="1" alt=""></td>
623
626
</tr>
624
627
<tr>
@@ -675,6 +678,9 @@ This is mostly useful for custom templates.</p>
675
678
<td rowspan="2"><p>Extra CSS</p>
676
679
<p>Custom CSS that will be injected in used template.
677
680
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>
678
684
<img width="900" height="1" alt=""></td>
679
685
</tr>
680
686
<tr>
@@ -690,8 +696,11 @@ Useful to avoid creating a new template just to tweak some styling</p>
690
696
<td rowspan="2"><p>Extra JavaScript</p>
691
697
<p>Custom JavaScript that will be executed during puppeteer rendering.
692
698
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.
694
702
It is run after transformations and optimizations, but just before resizing.</p>
703
+
</blockquote>
695
704
<img width="900" height="1" alt=""></td>
696
705
</tr>
697
706
<tr>
@@ -772,7 +781,7 @@ May increase filesize.</p>
772
781
<td rowspan="2"><p>Use GitHub custom emojis</p>
773
782
<p>GitHub supports additional emojis which are not registered in Unicode standard (:octocat:, :shipit:, :trollface:, ...)
774
783
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>
776
785
<p>May increase filesize</p>
777
786
<img width="900" height="1" alt=""></td>
778
787
</tr>
@@ -854,9 +863,9 @@ It can result in cropped or oversized outputs.</p>
854
863
</ul>
855
864
<p>Each value need to respect the following format:</p>
856
865
<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>
860
869
</ul>
861
870
<p>Percentage are relative to computed dimensions</p>
862
871
<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.</
<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>
1075
1084
<img width="900" height="1" alt=""></td>
1076
1085
</tr>
1077
1086
<tr>
@@ -1130,7 +1139,9 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<p>Contrary to <code>output_action: none</code>, output file won'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't be available in <code>/metrics_renders</code> directory</p>
1144
+
</blockquote>
1134
1145
<img width="900" height="1" alt=""></td>
1135
1146
</tr>
1136
1147
<tr>
@@ -1143,7 +1154,9 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
0 commit comments