sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

ci: auto-regenerate files

Browse Source
This commit is contained in:
github-actions[bot]
2022-02-04 02:56:51 +00:00
parent a5867697ca
commit a0eb798524
42 changed files with 245 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -356,6 +356,8 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
# 📚 Documentation
> <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>
## 🦮 Setup

14
source/plugins/achievements/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements</code></td>
<td nowrap="nowrap"><h4><code>plugin_achievements</code></h4></td>
<td rowspan="2"><p>Enable achievements plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_threshold</code></td>
<td nowrap="nowrap"><h4><code>plugin_achievements_threshold</code></h4></td>
<td rowspan="2"><p>Display rank threshold</p>
<p>Use <code>X</code> to display achievements not yet unlocked</p>
<img width="900" height="1" alt=""></td>
@@ -53,7 +53,7 @@
<b>allowed values:</b><ul><li>S</li><li>A</li><li>B</li><li>C</li><li>X</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_secrets</code></td>
<td nowrap="nowrap"><h4><code>plugin_achievements_secrets</code></h4></td>
<td rowspan="2"><p>Display secrets achievements</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -63,7 +63,7 @@
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_display</code></td>
<td nowrap="nowrap"><h4><code>plugin_achievements_display</code></h4></td>
<td rowspan="2"><p>Display style</p>
<ul>
<li><code>detailed</code>: display icon, name, description and ranking</li>
@@ -78,7 +78,7 @@
<b>allowed values:</b><ul><li>detailed</li><li>compact</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_achievements_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -90,7 +90,7 @@
<b>default:</b> 0<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_ignored</code></td>
<td nowrap="nowrap"><h4><code>plugin_achievements_ignored</code></h4></td>
<td rowspan="2"><p>Hide specified achievements</p>
<p>Use names without the rank adjective (i.e. without &quot;great&quot;, &quot;super&quot; or &quot;master&quot;)</p>
<img width="900" height="1" alt=""></td>
@@ -101,7 +101,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_only</code></td>
<td nowrap="nowrap"><h4><code>plugin_achievements_only</code></h4></td>
<td rowspan="2"><p>Restrict display to specified achievements</p>
<p>Use names without the rank adjective (i.e. without &quot;great&quot;, &quot;super&quot; or &quot;master&quot;)</p>
<p>This option is equivalent to <code>plugin_achievements_ignored</code> with all existing achievements but the ones listed in this option</p>

18
source/plugins/activity/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity</code></h4></td>
<td rowspan="2"><p>Enable activity plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -53,7 +53,7 @@
<b>default:</b> 5<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_load</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_load</code></h4></td>
<td rowspan="2"><p>Events to load</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -66,7 +66,7 @@
<b>default:</b> 300<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_days</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_days</code></h4></td>
<td rowspan="2"><p>Events maximum age</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -80,7 +80,7 @@
<b>default:</b> 14<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_visibility</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_visibility</code></h4></td>
<td rowspan="2"><p>Events visibility</p>
<p>Lets you hide private activity when using a <code>repo</code> scope token</p>
<img width="900" height="1" alt=""></td>
@@ -92,7 +92,7 @@
<b>allowed values:</b><ul><li>public</li><li>all</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_timestamps</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_timestamps</code></h4></td>
<td rowspan="2"><p>Display events timestamps</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -102,7 +102,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_skipped</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_skipped</code></h4></td>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -113,7 +113,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_ignored</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_ignored</code></h4></td>
<td rowspan="2"><p>Ignored users</p>
<p>Useful to ignore bots activity</p>
<img width="900" height="1" alt=""></td>
@@ -125,7 +125,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_filter</code></td>
<td nowrap="nowrap"><h4><code>plugin_activity_filter</code></h4></td>
<td rowspan="2"><p>Events types</p>
<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>
<ul>

14
source/plugins/anilist/README.md
View File

@@ -32,7 +32,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist</code></td>
<td nowrap="nowrap"><h4><code>plugin_anilist</code></h4></td>
<td rowspan="2"><p>Enable aniList plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -42,7 +42,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_medias</code></td>
<td nowrap="nowrap"><h4><code>plugin_anilist_medias</code></h4></td>
<td rowspan="2"><p>Display medias types</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -54,7 +54,7 @@
<b>allowed values:</b><ul><li>anime</li><li>manga</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_sections</code></td>
<td nowrap="nowrap"><h4><code>plugin_anilist_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>favorites</code> will display favorites <code>plugin_anilist_medias</code></li>
@@ -72,7 +72,7 @@
<b>allowed values:</b><ul><li>favorites</li><li>watching</li><li>reading</li><li>characters</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_anilist_limit</code></h4></td>
<td rowspan="2"><p>Display limit (medias)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -85,7 +85,7 @@
<b>default:</b> 2<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_limit_characters</code></td>
<td nowrap="nowrap"><h4><code>plugin_anilist_limit_characters</code></h4></td>
<td rowspan="2"><p>Display limit (characters)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -98,7 +98,7 @@
<b>default:</b> 22<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_shuffle</code></td>
<td nowrap="nowrap"><h4><code>plugin_anilist_shuffle</code></h4></td>
<td rowspan="2"><p>Shuffle data for varied outputs</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -108,7 +108,7 @@
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_user</code></td>
<td nowrap="nowrap"><h4><code>plugin_anilist_user</code></h4></td>
<td rowspan="2"><p>AniList login</p>
<img width="900" height="1" alt=""></td>
</tr>

16
source/plugins/base/README.md
View File

@@ -33,7 +33,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>base</code></td>
<td nowrap="nowrap"><h4><code>base</code></h4></td>
<td rowspan="2"><p>Base content</p>
<p>The following sections are supported:</p>
<ul>
@@ -54,7 +54,7 @@
<b>allowed values:</b><ul><li>header</li><li>activity</li><li>community</li><li>repositories</li><li>metadata</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>repositories</code></td>
<td nowrap="nowrap"><h4><code>repositories</code></h4></td>
<td rowspan="2"><p>Repositories to fetch</p>
<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>
<img width="900" height="1" alt=""></td>
@@ -67,7 +67,7 @@
<b>default:</b> 100<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_batch</code></td>
<td nowrap="nowrap"><h4><code>repositories_batch</code></h4></td>
<td rowspan="2"><p>Repositories to fetch at a time</p>
<p>If you receive <code>Something went wrong while executing your query</code> (which is usually caused by API timeout),
try lowering this value.</p>
@@ -82,7 +82,7 @@ try lowering this value.</p>
<b>default:</b> 100<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_forks</code></td>
<td nowrap="nowrap"><h4><code>repositories_forks</code></h4></td>
<td rowspan="2"><p>Include forks</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -92,7 +92,7 @@ try lowering this value.</p>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_affiliations</code></td>
<td nowrap="nowrap"><h4><code>repositories_affiliations</code></h4></td>
<td rowspan="2"><p>Repositories affiliations</p>
<ul>
<li><code>owner</code>: owned repositories</li>
@@ -112,7 +112,7 @@ Broad affiliation will result in less representative metrics.</p>
<b>allowed values:</b><ul><li>owner</li><li>collaborator</li><li>organization_member</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_skipped</code></td>
<td nowrap="nowrap"><h4><code>repositories_skipped</code></h4></td>
<td rowspan="2"><p>Default skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -123,7 +123,7 @@ Broad affiliation will result in less representative metrics.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>users_ignored</code></td>
<td nowrap="nowrap"><h4><code>users_ignored</code></h4></td>
<td rowspan="2"><p>Default ignored users</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -135,7 +135,7 @@ Broad affiliation will result in less representative metrics.</p>
<b>default:</b> github-actions[bot], dependabot[bot], dependabot-preview[bot]<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>commits_authoring</code></td>
<td nowrap="nowrap"><h4><code>commits_authoring</code></h4></td>
<td rowspan="2"><p>Identifiers that has been used for authoring commits</p>
<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>
<img width="900" height="1" alt=""></td>

12
source/plugins/code/README.md
View File

@@ -35,7 +35,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code</code></td>
<td nowrap="nowrap"><h4><code>plugin_code</code></h4></td>
<td rowspan="2"><p>Enable code plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -45,7 +45,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_lines</code></td>
<td nowrap="nowrap"><h4><code>plugin_code_lines</code></h4></td>
<td rowspan="2"><p>Display limit for code snippets</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -55,7 +55,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
<b>default:</b> 12<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_load</code></td>
<td nowrap="nowrap"><h4><code>plugin_code_load</code></h4></td>
<td rowspan="2"><p>Events to load</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -68,7 +68,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
<b>default:</b> 100<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_visibility</code></td>
<td nowrap="nowrap"><h4><code>plugin_code_visibility</code></h4></td>
<td rowspan="2"><p>Events visibility</p>
<p>Lets you hide private activity when using a <code>repo</code> scope token</p>
<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
<b>allowed values:</b><ul><li>public</li><li>all</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_skipped</code></td>
<td nowrap="nowrap"><h4><code>plugin_code_skipped</code></h4></td>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -91,7 +91,7 @@ Use at your own risk, <em>metrics</em> and its authors cannot be held responsibl
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_languages</code></td>
<td nowrap="nowrap"><h4><code>plugin_code_languages</code></h4></td>
<td rowspan="2"><p>Restrict display to specific languages</p>
<img width="900" height="1" alt=""></td>
</tr>

5
source/plugins/community/fortune/README.md
View File

@@ -31,13 +31,12 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_fortune</code></td>
<td nowrap="nowrap"><h4><code>plugin_fortune</code></h4></td>
<td rowspan="2"><p>Enable fortune plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>boolean</code>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
<br>
<b>default:</b> no<br></td>
</tr>

14
source/plugins/community/nightscout/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout</code></td>
<td nowrap="nowrap"><h4><code>plugin_nightscout</code></h4></td>
<td rowspan="2"><p>Enable nightscout plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_url</code></td>
<td nowrap="nowrap"><h4><code>plugin_nightscout_url</code></h4></td>
<td rowspan="2"><p>Nightscout URL</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -51,7 +51,7 @@
<b>default:</b> https://example.herokuapp.com<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_datapoints</code></td>
<td nowrap="nowrap"><h4><code>plugin_nightscout_datapoints</code></h4></td>
<td rowspan="2"><p>Number of datapoints shown the graph</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -64,7 +64,7 @@
<b>default:</b> 12<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_lowalert</code></td>
<td nowrap="nowrap"><h4><code>plugin_nightscout_lowalert</code></h4></td>
<td rowspan="2"><p>Threshold for low blood sugar</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -76,7 +76,7 @@
<b>default:</b> 80<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_highalert</code></td>
<td nowrap="nowrap"><h4><code>plugin_nightscout_highalert</code></h4></td>
<td rowspan="2"><p>Threshold for high blood sugar</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -88,7 +88,7 @@
<b>default:</b> 180<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_urgentlowalert</code></td>
<td nowrap="nowrap"><h4><code>plugin_nightscout_urgentlowalert</code></h4></td>
<td rowspan="2"><p>Threshold for urgently low blood sugar</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -100,7 +100,7 @@
<b>default:</b> 50<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_urgenthighalert</code></td>
<td nowrap="nowrap"><h4><code>plugin_nightscout_urgenthighalert</code></h4></td>
<td rowspan="2"><p>Threshold for urgently high blood sugar</p>
<img width="900" height="1" alt=""></td>
</tr>

6
source/plugins/community/poopmap/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_poopmap</code></td>
<td nowrap="nowrap"><h4><code>plugin_poopmap</code></h4></td>
<td rowspan="2"><p>Enable poopmap plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_poopmap_token</code></td>
<td nowrap="nowrap"><h4><code>plugin_poopmap_token</code></h4></td>
<td rowspan="2"><p>PoopMap API token</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -51,7 +51,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_poopmap_days</code></td>
<td nowrap="nowrap"><h4><code>plugin_poopmap_days</code></h4></td>
<td rowspan="2"><p>Time range</p>
<img width="900" height="1" alt=""></td>
</tr>

10
source/plugins/community/screenshot/README.md
View File

@@ -32,7 +32,7 @@ It can either the full page or a portion restricted by a <a href="https://develo
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot</code></td>
<td nowrap="nowrap"><h4><code>plugin_screenshot</code></h4></td>
<td rowspan="2"><p>Enable screenshot plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -42,7 +42,7 @@ It can either the full page or a portion restricted by a <a href="https://develo
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_title</code></td>
<td nowrap="nowrap"><h4><code>plugin_screenshot_title</code></h4></td>
<td rowspan="2"><p>Title caption</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -52,7 +52,7 @@ It can either the full page or a portion restricted by a <a href="https://develo
<b>default:</b> Screenshot<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_url</code></td>
<td nowrap="nowrap"><h4><code>plugin_screenshot_url</code></h4></td>
<td rowspan="2"><p>Website url</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -61,7 +61,7 @@ It can either the full page or a portion restricted by a <a href="https://develo
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_selector</code></td>
<td nowrap="nowrap"><h4><code>plugin_screenshot_selector</code></h4></td>
<td rowspan="2"><p>CSS Selector</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -71,7 +71,7 @@ It can either the full page or a portion restricted by a <a href="https://develo
<b>default:</b> body<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_background</code></td>
<td nowrap="nowrap"><h4><code>plugin_screenshot_background</code></h4></td>
<td rowspan="2"><p>Display background</p>
<img width="900" height="1" alt=""></td>
</tr>

10
source/plugins/community/stock/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock</code></td>
<td nowrap="nowrap"><h4><code>plugin_stock</code></h4></td>
<td rowspan="2"><p>Enable stock plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_token</code></td>
<td nowrap="nowrap"><h4><code>plugin_stock_token</code></h4></td>
<td rowspan="2"><p>Yahoo Finance token</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -51,7 +51,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_symbol</code></td>
<td nowrap="nowrap"><h4><code>plugin_stock_symbol</code></h4></td>
<td rowspan="2"><p>Company stock symbol</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -60,7 +60,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_duration</code></td>
<td nowrap="nowrap"><h4><code>plugin_stock_duration</code></h4></td>
<td rowspan="2"><p>Time range (relative to current date)</p>
<ul>
<li><code>1d</code>: Today</li>
@@ -84,7 +84,7 @@
<b>allowed values:</b><ul><li>1d</li><li>5d</li><li>1mo</li><li>3mo</li><li>6mo</li><li>1y</li><li>2y</li><li>5y</li><li>10y</li><li>ytd</li><li>max</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_interval</code></td>
<td nowrap="nowrap"><h4><code>plugin_stock_interval</code></h4></td>
<td rowspan="2"><p>Time interval between points</p>
<ul>
<li><code>1m</code>: 1 minute</li>

14
source/plugins/contributors/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors</code></td>
<td nowrap="nowrap"><h4><code>plugin_contributors</code></h4></td>
<td rowspan="2"><p>Enable contributors plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_base</code></td>
<td nowrap="nowrap"><h4><code>plugin_contributors_base</code></h4></td>
<td rowspan="2"><p>Base reference (commit, tag, branch, etc.)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -50,7 +50,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_head</code></td>
<td nowrap="nowrap"><h4><code>plugin_contributors_head</code></h4></td>
<td rowspan="2"><p>Head reference (commit, tag, branch, etc.)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -60,7 +60,7 @@
<b>default:</b> master<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_ignored</code></td>
<td nowrap="nowrap"><h4><code>plugin_contributors_ignored</code></h4></td>
<td rowspan="2"><p>Ignored users</p>
<p>Useful to ignore bots activity</p>
<img width="900" height="1" alt=""></td>
@@ -72,7 +72,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_contributions</code></td>
<td nowrap="nowrap"><h4><code>plugin_contributors_contributions</code></h4></td>
<td rowspan="2"><p>Toggle number of contributions display</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -82,7 +82,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_sections</code></td>
<td nowrap="nowrap"><h4><code>plugin_contributors_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>contributors</code>: all contributors</li>
@@ -98,7 +98,7 @@
<b>allowed values:</b><ul><li>contributors</li><li>categories</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_categories</code></td>
<td nowrap="nowrap"><h4><code>plugin_contributors_categories</code></h4></td>
<td rowspan="2"><p>Configure contribution categories</p>
<p>This option required <code>plugin_contributors_sections</code> to have <code>categories</code> in it to be effective
Pass a JSON object mapping category with fileglobs</p>

89
source/plugins/core/README.md
View File

@@ -377,7 +377,7 @@ On forks, this feature is disable to take into account any changes you made on i
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>token</code></td>
<td nowrap="nowrap"><h4><code>token</code></h4></td>
<td rowspan="2"><p>GitHub Personal Access Token</p>
<p>No scopes are required by default, though some plugins and features may require additional scopes</p>
<p>When using a configuration which does not requires a GitHub PAT, you may pass <code>NOT_NEEDED</code> instead.
@@ -392,7 +392,7 @@ Most of the time <code>user</code> option must also be set.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>user</code></td>
<td nowrap="nowrap"><h4><code>user</code></h4></td>
<td rowspan="2"><p>GitHub username</p>
<p>Defaults to <code>token</code> owner username.</p>
<img width="900" height="1" alt=""></td>
@@ -403,7 +403,7 @@ Most of the time <code>user</code> option must also be set.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>repo</code></td>
<td nowrap="nowrap"><h4><code>repo</code></h4></td>
<td rowspan="2"><p>GitHub repository</p>
<p>This option is revevalant only for repositories templates</p>
<img width="900" height="1" alt=""></td>
@@ -414,7 +414,7 @@ Most of the time <code>user</code> option must also be set.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>committer_token</code></td>
<td nowrap="nowrap"><h4><code>committer_token</code></h4></td>
<td rowspan="2"><p>GitHub Token used to commit metrics</p>
<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>
<blockquote>
@@ -429,7 +429,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>default:</b> ${{ github.token }}<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>committer_branch</code></td>
<td nowrap="nowrap"><h4><code>committer_branch</code></h4></td>
<td rowspan="2"><p>Target branch</p>
<p>Default value is set to your repository default branch</p>
<img width="900" height="1" alt=""></td>
@@ -439,7 +439,7 @@ Most of the time <code>user</code> option must also be set.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>committer_message</code></td>
<td nowrap="nowrap"><h4><code>committer_message</code></h4></td>
<td rowspan="2"><p>Commit message</p>
<p>Use <code>${filename}</code> to display filename</p>
<img width="900" height="1" alt=""></td>
@@ -450,7 +450,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>default:</b> Update ${filename} - [Skip GitHub Action]<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>committer_gist</code></td>
<td nowrap="nowrap"><h4><code>committer_gist</code></h4></td>
<td rowspan="2"><p>Gist id</p>
<p>Specify an existing gist id (can be retrieved from its URL) when using <code>output_action: gist</code>.</p>
<img width="900" height="1" alt=""></td>
@@ -461,7 +461,7 @@ Most of the time <code>user</code> option must also be set.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>filename</code></td>
<td nowrap="nowrap"><h4><code>filename</code></h4></td>
<td rowspan="2"><p>Output path</p>
<p>When using an asterisk (<code>*</code>), correct extension will automatically be applied according to <code>config_output</code> value</p>
<img width="900" height="1" alt=""></td>
@@ -472,7 +472,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>default:</b> github-metrics.*<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>markdown</code></td>
<td nowrap="nowrap"><h4><code>markdown</code></h4></td>
<td rowspan="2"><p>Markdown template path</p>
<p>It can be either a local path or a full link (e.g. <a href="https://raw.githubusercontent.com">https://raw.githubusercontent.com</a>)</p>
<img width="900" height="1" alt=""></td>
@@ -483,7 +483,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>default:</b> TEMPLATE.md<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>markdown_cache</code></td>
<td nowrap="nowrap"><h4><code>markdown_cache</code></h4></td>
<td rowspan="2"><p>Markdown file cache</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -493,7 +493,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>default:</b> .cache<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>output_action</code></td>
<td nowrap="nowrap"><h4><code>output_action</code></h4></td>
<td rowspan="2"><p>Output action</p>
<ul>
<li><code>none</code>: just create file in <code>/metrics_renders</code> directory of action runner</li>
@@ -516,7 +516,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>allowed values:</b><ul><li>none</li><li>commit</li><li>pull-request</li><li>pull-request-merge</li><li>pull-request-squash</li><li>pull-request-rebase</li><li>gist</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>output_condition</code></td>
<td nowrap="nowrap"><h4><code>output_condition</code></h4></td>
<td rowspan="2"><p>Output condition</p>
<ul>
<li><code>always</code>: always try to push changes</li>
@@ -531,7 +531,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>allowed values:</b><ul><li>always</li><li>data-changed</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>optimize</code></td>
<td nowrap="nowrap"><h4><code>optimize</code></h4></td>
<td rowspan="2"><p>Optimization features</p>
<ul>
<li><code>css</code>: purge and minify CSS styles</li>
@@ -549,7 +549,7 @@ Most of the time <code>user</code> option must also be set.</p>
<b>allowed values:</b><ul><li>css</li><li>xml</li><li>svg</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>setup_community_templates</code></td>
<td nowrap="nowrap"><h4><code>setup_community_templates</code></h4></td>
<td rowspan="2"><p>Community templates to setup</p>
<p>See <a href="https://github.com/lowlighter/metrics/blob/master/source/templates/community/README.md">community templates guide</a> for more informations</p>
<img width="900" height="1" alt=""></td>
@@ -561,7 +561,7 @@ Most of the time <code>user</code> option must also be set.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>template</code></td>
<td nowrap="nowrap"><h4><code>template</code></h4></td>
<td rowspan="2"><p>Template</p>
<p>Community templates must be prefixed by at sign (<code>@</code>)
See <a href="https://github.com/lowlighter/metrics/blob/master/README.md#%EF%B8%8F-templates">list of supported templates</a></p>
@@ -573,7 +573,7 @@ See <a href="https://github.com/lowlighter/metrics/blob/master/README.md#%EF%B8%
<b>default:</b> classic<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>query</code></td>
<td nowrap="nowrap"><h4><code>query</code></h4></td>
<td rowspan="2"><p>Query parameters</p>
<p>Pass additional parameters to templates.
This is mostly useful for custom templates.</p>
@@ -588,7 +588,7 @@ This is mostly useful for custom templates.</p>
<b>default:</b> {}<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>extras_css</code></td>
<td nowrap="nowrap"><h4><code>extras_css</code></h4></td>
<td rowspan="2"><p>Extra CSS</p>
<p>Custom CSS that will be injected in used template.
Useful to avoid creating a new template just to tweak some styling</p>
@@ -600,7 +600,7 @@ Useful to avoid creating a new template just to tweak some styling</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>extras_js</code></td>
<td nowrap="nowrap"><h4><code>extras_js</code></h4></td>
<td rowspan="2"><p>Extra JavaScript</p>
<p>Custom JavaScript that will be executed during puppeteer rendering.
Useful to avoid creating a new template just to tweak some content.</p>
@@ -609,13 +609,12 @@ It is run after transformations and optimizations, but just before resizing.</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
🌐 Web instances must configure <code>settings.json</code><br>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
<b>type:</b> <code>string</code>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_timezone</code></td>
<td nowrap="nowrap"><h4><code>config_timezone</code></h4></td>
<td rowspan="2"><p>Timezone for dates</p>
<p>See <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">list of supported timezone</a></p>
<img width="900" height="1" alt=""></td>
@@ -626,7 +625,7 @@ It is run after transformations and optimizations, but just before resizing.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_order</code></td>
<td nowrap="nowrap"><h4><code>config_order</code></h4></td>
<td rowspan="2"><p>Plugin order</p>
<p>By default, templates use <code>partials/_.json</code> ordering.
You can override the content order by using this setting.</p>
@@ -640,7 +639,7 @@ You can override the content order by using this setting.</p>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_twemoji</code></td>
<td nowrap="nowrap"><h4><code>config_twemoji</code></h4></td>
<td rowspan="2"><p>Use twemojis</p>
<p>Replace emojis by <a href="%5Btwemojis%5D(https://github.com/twitter/twemoji)">twemojis</a> to have a consistent render across all platforms
May increase filesize.</p>
@@ -653,7 +652,7 @@ May increase filesize.</p>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_gemoji</code></td>
<td nowrap="nowrap"><h4><code>config_gemoji</code></h4></td>
<td rowspan="2"><p>Use GitHub custom emojis</p>
<p>GitHub supports additional emojis which are not registered in Unicode standard (:octocat:, :shipit:, :trollface:, ...)
See full list at <a href="https://api.github.com/emojis">https://api.github.com/emojis</a>.</p>
@@ -667,7 +666,7 @@ See full list at <a href="https://api.github.com/emojis">https://api.github.com/
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_display</code></td>
<td nowrap="nowrap"><h4><code>config_display</code></h4></td>
<td rowspan="2"><p>Display width (for image output formats)</p>
<ul>
<li><code>regular</code>: 480px width</li>
@@ -687,7 +686,7 @@ See full list at <a href="https://api.github.com/emojis">https://api.github.com/
<b>allowed values:</b><ul><li>regular</li><li>large</li><li>columns</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_animations</code></td>
<td nowrap="nowrap"><h4><code>config_animations</code></h4></td>
<td rowspan="2"><p>Use CSS animations</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -698,7 +697,7 @@ See full list at <a href="https://api.github.com/emojis">https://api.github.com/
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_base64</code></td>
<td nowrap="nowrap"><h4><code>config_base64</code></h4></td>
<td rowspan="2"><p>Base64-encoded images</p>
<p>Enable this option to make self-contained ouput (i.e. with no external links)</p>
<img width="900" height="1" alt=""></td>
@@ -710,7 +709,7 @@ See full list at <a href="https://api.github.com/emojis">https://api.github.com/
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_padding</code></td>
<td nowrap="nowrap"><h4><code>config_padding</code></h4></td>
<td rowspan="2"><p>Output padding</p>
<p>Although <em>metrics</em> try to auto-guess resulting height, rendering is still dependent on OS and browser settings.
It can result in cropped or oversized outputs.</p>
@@ -734,7 +733,7 @@ It can result in cropped or oversized outputs.</p>
<b>default:</b> 0, 8 + 11%<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_output</code></td>
<td nowrap="nowrap"><h4><code>config_output</code></h4></td>
<td rowspan="2"><p>Output format</p>
<ul>
<li><code>auto</code>: Template default (usually <code>svg</code> or <code>markdown</code>)</li>
@@ -755,19 +754,18 @@ It can result in cropped or oversized outputs.</p>
<b>allowed values:</b><ul><li>auto</li><li>svg</li><li>png</li><li>jpeg</li><li>json</li><li>markdown</li><li>markdown-pdf</li><li>insights</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>config_presets</code></td>
<td nowrap="nowrap"><h4><code>config_presets</code></h4></td>
<td rowspan="2"><p>Configuration presets</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏯️ Cannot be preset<br>
✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>array</code>
<i>(comma-separated)</i>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>retries</code></td>
<td nowrap="nowrap"><h4><code>retries</code></h4></td>
<td rowspan="2"><p>Retries in case of failures (for rendering)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -780,7 +778,7 @@ It can result in cropped or oversized outputs.</p>
<b>default:</b> 3<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>retries_delay</code></td>
<td nowrap="nowrap"><h4><code>retries_delay</code></h4></td>
<td rowspan="2"><p>Delay between each retry (in seconds, for rendering)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -793,7 +791,7 @@ It can result in cropped or oversized outputs.</p>
<b>default:</b> 300<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>retries_output_action</code></td>
<td nowrap="nowrap"><h4><code>retries_output_action</code></h4></td>
<td rowspan="2"><p>Retries in case of failures (for output action)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -806,7 +804,7 @@ It can result in cropped or oversized outputs.</p>
<b>default:</b> 5<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>retries_delay_output_action</code></td>
<td nowrap="nowrap"><h4><code>retries_delay_output_action</code></h4></td>
<td rowspan="2"><p>Delay between each retry (in seconds, for output action)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -819,7 +817,7 @@ It can result in cropped or oversized outputs.</p>
<b>default:</b> 120<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>delay</code></td>
<td nowrap="nowrap"><h4><code>delay</code></h4></td>
<td rowspan="2"><p>Job delay</p>
<p>This can be used to avoid triggering GitHub abuse mechanics on large workflows</p>
<img width="900" height="1" alt=""></td>
@@ -833,7 +831,7 @@ It can result in cropped or oversized outputs.</p>
<b>default:</b> 0<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>use_prebuilt_image</code></td>
<td nowrap="nowrap"><h4><code>use_prebuilt_image</code></h4></td>
<td rowspan="2"><p>Use pre-built docker image from <a href="https://github.com/lowlighter/metrics/pkgs/container/metrics">GitHub container registry</a></p>
<p>It allows to save build time and make job significantly faster, and there is almost no reason to disable this settings.
This option has no effects on forks (images will always be rebuilt from Dockerfile)</p>
@@ -847,7 +845,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugins_errors_fatal</code></td>
<td nowrap="nowrap"><h4><code>plugins_errors_fatal</code></h4></td>
<td rowspan="2"><p>Fatal plugin errors</p>
<p>When enabled, the job will fail in case of plugin errors, else it will be handled gracefully in output with an error message</p>
<img width="900" height="1" alt=""></td>
@@ -860,7 +858,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>debug</code></td>
<td nowrap="nowrap"><h4><code>debug</code></h4></td>
<td rowspan="2"><p>Debug mode</p>
<p>This setting is automatically enable if a job fail (useful with <code>plugins_errors_fatal: yes</code>)</p>
<img width="900" height="1" alt=""></td>
@@ -873,7 +871,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>verify</code></td>
<td nowrap="nowrap"><h4><code>verify</code></h4></td>
<td rowspan="2"><p>SVG validity check</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -885,7 +883,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>debug_flags</code></td>
<td nowrap="nowrap"><h4><code>debug_flags</code></h4></td>
<td rowspan="2"><p>Debug flags</p>
<ul>
<li><code>--cakeday</code>: simulate registration anniversary</li>
@@ -904,20 +902,19 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<b>allowed values:</b><ul><li>--cakeday</li><li>--hireable</li><li>--halloween</li><li>--error</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>debug_print</code></td>
<td nowrap="nowrap"><h4><code>debug_print</code></h4></td>
<td rowspan="2"><p>Print output in console</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏯️ Cannot be preset<br>
🔧 For development<br>
✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>boolean</code>
<br>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>dryrun</code></td>
<td nowrap="nowrap"><h4><code>dryrun</code></h4></td>
<td rowspan="2"><p>Dry-run</p>
<p>Contrary to <code>output_action: none</code>, output file won&#39;t be available in <code>/metrics_renders</code> directory</p>
<img width="900" height="1" alt=""></td>
@@ -930,7 +927,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>experimental_features</code></td>
<td nowrap="nowrap"><h4><code>experimental_features</code></h4></td>
<td rowspan="2"><p>Experimental features</p>
<p>No backward compatibility is guaranteed for these features</p>
<img width="900" height="1" alt=""></td>
@@ -944,7 +941,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi
<b>allowed values:</b><ul><li>--optimize-svg</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>use_mocked_data</code></td>
<td nowrap="nowrap"><h4><code>use_mocked_data</code></h4></td>
<td rowspan="2"><p>Use mocked data instead of live APIs</p>
<img width="900" height="1" alt=""></td>
</tr>

6
source/plugins/discussions/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_discussions</code></td>
<td nowrap="nowrap"><h4><code>plugin_discussions</code></h4></td>
<td rowspan="2"><p>Enable discussions plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_discussions_categories</code></td>
<td nowrap="nowrap"><h4><code>plugin_discussions_categories</code></h4></td>
<td rowspan="2"><p>Toggle discussion categories display</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -50,7 +50,7 @@
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_discussions_categories_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_discussions_categories_limit</code></h4></td>
<td rowspan="2"><p>Display limit (categories)</p>
<p>Note that categories are sorted from highest to lowest count.</p>
<img width="900" height="1" alt=""></td>

6
source/plugins/followup/README.md
View File

@@ -32,7 +32,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_followup</code></td>
<td nowrap="nowrap"><h4><code>plugin_followup</code></h4></td>
<td rowspan="2"><p>Enable followup plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -42,7 +42,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_followup_sections</code></td>
<td nowrap="nowrap"><h4><code>plugin_followup_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>repositories</code>: overall status of issues and pull requests on your repositories</li>
@@ -58,7 +58,7 @@
<b>allowed values:</b><ul><li>repositories</li><li>user</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_followup_indepth</code></td>
<td nowrap="nowrap"><h4><code>plugin_followup_indepth</code></h4></td>
<td rowspan="2"><p>Indepth analysis</p>
<img width="900" height="1" alt=""></td>
</tr>

2
source/plugins/gists/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_gists</code></td>
<td nowrap="nowrap"><h4><code>plugin_gists</code></h4></td>
<td rowspan="2"><p>Enable gists plugin</p>
<img width="900" height="1" alt=""></td>
</tr>

12
source/plugins/habits/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits</code></td>
<td nowrap="nowrap"><h4><code>plugin_habits</code></h4></td>
<td rowspan="2"><p>Enable habits plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_from</code></td>
<td nowrap="nowrap"><h4><code>plugin_habits_from</code></h4></td>
<td rowspan="2"><p>Events to use</p>
<p>A higher number will increase stats accuracy</p>
<img width="900" height="1" alt=""></td>
@@ -55,7 +55,7 @@
<b>default:</b> 200<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_days</code></td>
<td nowrap="nowrap"><h4><code>plugin_habits_days</code></h4></td>
<td rowspan="2"><p>Event maximum age</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -68,7 +68,7 @@
<b>default:</b> 14<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_facts</code></td>
<td nowrap="nowrap"><h4><code>plugin_habits_facts</code></h4></td>
<td rowspan="2"><p>Toggle midly interesting facts display</p>
<p>It includes indentation type, average number of characters per line of code, and most active time and day</p>
<img width="900" height="1" alt=""></td>
@@ -79,7 +79,7 @@
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_charts</code></td>
<td nowrap="nowrap"><h4><code>plugin_habits_charts</code></h4></td>
<td rowspan="2"><p>Toggle charts display</p>
<p>It includes commit activity per hour of day and commit activity per day of week
Recent language activity may also displayed (it requires extras features to be enabled for web instances) for historical reasons</p>
@@ -92,7 +92,7 @@ Recent language activity may also displayed (it requires extras features to be e
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_trim</code></td>
<td nowrap="nowrap"><h4><code>plugin_habits_trim</code></h4></td>
<td rowspan="2"><p>Trim unused hours on charts</p>
<img width="900" height="1" alt=""></td>
</tr>

4
source/plugins/introduction/README.md
View File

@@ -32,7 +32,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_introduction</code></td>
<td nowrap="nowrap"><h4><code>plugin_introduction</code></h4></td>
<td rowspan="2"><p>Display account or repository introduction</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -42,7 +42,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_introduction_title</code></td>
<td nowrap="nowrap"><h4><code>plugin_introduction_title</code></h4></td>
<td rowspan="2"><p>Display introduction section title</p>
<img width="900" height="1" alt=""></td>
</tr>

4
source/plugins/isocalendar/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_isocalendar</code></td>
<td nowrap="nowrap"><h4><code>plugin_isocalendar</code></h4></td>
<td rowspan="2"><p>Enable isocalendar plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_isocalendar_duration</code></td>
<td nowrap="nowrap"><h4><code>plugin_isocalendar_duration</code></h4></td>
<td rowspan="2"><p>Time range</p>
<ul>
<li><code>half-year</code>: 180 days</li>

30
source/plugins/languages/README.md
View File

@@ -33,7 +33,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages</code></h4></td>
<td rowspan="2"><p>Enable languages plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -43,7 +43,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_ignored</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_ignored</code></h4></td>
<td rowspan="2"><p>Ignored languages</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -53,7 +53,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_skipped</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_skipped</code></h4></td>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -64,7 +64,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -78,7 +78,7 @@
<b>default:</b> 8<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_threshold</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_threshold</code></h4></td>
<td rowspan="2"><p>Display threshold (percentage)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -88,7 +88,7 @@
<b>default:</b> 0%<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_colors</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_colors</code></h4></td>
<td rowspan="2"><p>Custom languages colors</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -99,7 +99,7 @@
<b>default:</b> github<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_aliases</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_aliases</code></h4></td>
<td rowspan="2"><p>Custom languages names</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -108,7 +108,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_sections</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -121,7 +121,7 @@
<b>allowed values:</b><ul><li>most-used</li><li>recently-used</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_details</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_details</code></h4></td>
<td rowspan="2"><p>Additional details</p>
<p>Note that <code>lines</code> is only available when <code>plugin_languages_indepth</code> is enabled</p>
<img width="900" height="1" alt=""></td>
@@ -134,7 +134,7 @@
<b>allowed values:</b><ul><li>bytes-size</li><li>percentage</li><li>lines</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_indepth</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_indepth</code></h4></td>
<td rowspan="2"><p>Indepth mode (⚠️ read documentation first)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -145,7 +145,7 @@
<b>default:</b> false<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_analysis_timeout</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_analysis_timeout</code></h4></td>
<td rowspan="2"><p>Indepth mode - Analysis timeout</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -159,7 +159,7 @@
<b>default:</b> 15<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_categories</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_categories</code></h4></td>
<td rowspan="2"><p>Indepth mode - Displayed categories (most-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -172,7 +172,7 @@
<b>allowed values:</b><ul><li>data</li><li>markup</li><li>programming</li><li>prose</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_recent_categories</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_recent_categories</code></h4></td>
<td rowspan="2"><p>Indepth mode - Displayed categories (recently-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -185,7 +185,7 @@
<b>allowed values:</b><ul><li>data</li><li>markup</li><li>programming</li><li>prose</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_recent_load</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_recent_load</code></h4></td>
<td rowspan="2"><p>Events to load (recently-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -199,7 +199,7 @@
<b>default:</b> 300<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_recent_days</code></td>
<td nowrap="nowrap"><h4><code>plugin_languages_recent_days</code></h4></td>
<td rowspan="2"><p>Events maximum age (day, recently-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>

8
source/plugins/licenses/README.md
View File

@@ -52,7 +52,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses</code></td>
<td nowrap="nowrap"><h4><code>plugin_licenses</code></h4></td>
<td rowspan="2"><p>Enable licenses plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -63,7 +63,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses_setup</code></td>
<td nowrap="nowrap"><h4><code>plugin_licenses_setup</code></h4></td>
<td rowspan="2"><p>Setup command</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -72,7 +72,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses_ratio</code></td>
<td nowrap="nowrap"><h4><code>plugin_licenses_ratio</code></h4></td>
<td rowspan="2"><p>Display used licenses ratio</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -82,7 +82,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses_legal</code></td>
<td nowrap="nowrap"><h4><code>plugin_licenses_legal</code></h4></td>
<td rowspan="2"><p>Display permissions, limitations and conditions about licenses</p>
<img width="900" height="1" alt=""></td>
</tr>

4
source/plugins/lines/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_lines</code></td>
<td nowrap="nowrap"><h4><code>plugin_lines</code></h4></td>
<td rowspan="2"><p>Enable lines plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_lines_skipped</code></td>
<td nowrap="nowrap"><h4><code>plugin_lines_skipped</code></h4></td>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>

20
source/plugins/music/README.md
View File

@@ -32,7 +32,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music</code></td>
<td nowrap="nowrap"><h4><code>plugin_music</code></h4></td>
<td rowspan="2"><p>Enable music plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -42,7 +42,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_provider</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_provider</code></h4></td>
<td rowspan="2"><p>Music provider</p>
<ul>
<li><code>apple</code>: Apple Music</li>
@@ -59,7 +59,7 @@
<b>allowed values:</b><ul><li>apple</li><li>spotify</li><li>lastfm</li><li>youtube</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_token</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_token</code></h4></td>
<td rowspan="2"><p>Music provider token</p>
<p>Below is the expected token format for each provider:</p>
<ul>
@@ -76,7 +76,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_mode</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_mode</code></h4></td>
<td rowspan="2"><p>Display mode</p>
<ul>
<li><code>playlist</code>: display random tracks from an URL playlist</li>
@@ -92,7 +92,7 @@
<b>allowed values:</b><ul><li>playlist</li><li>recent</li><li>top</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_playlist</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_playlist</code></h4></td>
<td rowspan="2"><p>Playlist URL</p>
<p>It must be from an &quot;embed url&quot; (i.e. music player iframes that can be integrated in other websites)</p>
<img width="900" height="1" alt=""></td>
@@ -103,7 +103,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -116,7 +116,7 @@
<b>default:</b> 4<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_played_at</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_played_at</code></h4></td>
<td rowspan="2"><p>Recently played - Toggle last played timestamp display</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -126,7 +126,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_time_range</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_time_range</code></h4></td>
<td rowspan="2"><p>Top tracks - Time range for <code>top</code> mode</p>
<ul>
<li><code>short</code>: 4 weeks</li>
@@ -142,7 +142,7 @@
<b>allowed values:</b><ul><li>short</li><li>medium</li><li>long</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_top_type</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_top_type</code></h4></td>
<td rowspan="2"><p>Top tracks - Display type</p>
<ul>
<li><code>tracks</code>: display track</li>
@@ -157,7 +157,7 @@
<b>allowed values:</b><ul><li>tracks</li><li>artists</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_user</code></td>
<td nowrap="nowrap"><h4><code>plugin_music_user</code></h4></td>
<td rowspan="2"><p>Music provider username</p>
<img width="900" height="1" alt=""></td>
</tr>

12
source/plugins/notable/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable</code></td>
<td nowrap="nowrap"><h4><code>plugin_notable</code></h4></td>
<td rowspan="2"><p>Enable notable plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_filter</code></td>
<td nowrap="nowrap"><h4><code>plugin_notable_filter</code></h4></td>
<td rowspan="2"><p>Query filter</p>
<p>Based on <a href="https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax">GitHub search syntax</a>.
Supported fields are <code>stars</code>, <code>forks</code> and <code>watchers</code></p>
@@ -54,7 +54,7 @@ Some repositories may not be able to reported advanced stats and in the case the
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_skipped</code></td>
<td nowrap="nowrap"><h4><code>plugin_notable_skipped</code></h4></td>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -65,7 +65,7 @@ Some repositories may not be able to reported advanced stats and in the case the
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_from</code></td>
<td nowrap="nowrap"><h4><code>plugin_notable_from</code></h4></td>
<td rowspan="2"><p>Filter by repository owner account type</p>
<ul>
<li><code>all</code>: no filtering</li>
@@ -81,7 +81,7 @@ Some repositories may not be able to reported advanced stats and in the case the
<b>allowed values:</b><ul><li>all</li><li>organization</li><li>user</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_repositories</code></td>
<td nowrap="nowrap"><h4><code>plugin_notable_repositories</code></h4></td>
<td rowspan="2"><p>Toggle repository name display</p>
<p>Note that Repositories hosted by user account will always be fully displayed</p>
<img width="900" height="1" alt=""></td>
@@ -92,7 +92,7 @@ Some repositories may not be able to reported advanced stats and in the case the
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_indepth</code></td>
<td nowrap="nowrap"><h4><code>plugin_notable_indepth</code></h4></td>
<td rowspan="2"><p>Indepth mode</p>
<img width="900" height="1" alt=""></td>
</tr>

10
source/plugins/pagespeed/README.md
View File

@@ -33,7 +33,7 @@ It uses <a href="https://developers.google.com/speed/docs/insights/v5/get-starte
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed</code></td>
<td nowrap="nowrap"><h4><code>plugin_pagespeed</code></h4></td>
<td rowspan="2"><p>Enable pagespeed plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -43,7 +43,7 @@ It uses <a href="https://developers.google.com/speed/docs/insights/v5/get-starte
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_url</code></td>
<td nowrap="nowrap"><h4><code>plugin_pagespeed_url</code></h4></td>
<td rowspan="2"><p>Audited website</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -54,7 +54,7 @@ It uses <a href="https://developers.google.com/speed/docs/insights/v5/get-starte
<b>default:</b> <code>→ User attached website</code><br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_detailed</code></td>
<td nowrap="nowrap"><h4><code>plugin_pagespeed_detailed</code></h4></td>
<td rowspan="2"><p>Detailed results</p>
<p>The following additional stats will be displayed:</p>
<ul>
@@ -73,7 +73,7 @@ It uses <a href="https://developers.google.com/speed/docs/insights/v5/get-starte
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_screenshot</code></td>
<td nowrap="nowrap"><h4><code>plugin_pagespeed_screenshot</code></h4></td>
<td rowspan="2"><p>Display a website screenshot</p>
<p>Significantly increase filesize</p>
<img width="900" height="1" alt=""></td>
@@ -84,7 +84,7 @@ It uses <a href="https://developers.google.com/speed/docs/insights/v5/get-starte
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_token</code></td>
<td nowrap="nowrap"><h4><code>plugin_pagespeed_token</code></h4></td>
<td rowspan="2"><p>PageSpeed token</p>
<p>Although not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See <a href="https://developers.google.com/speed/docs/insights/v5/get-started">PageSpeed documentation</a> for more informations.</p>
<img width="900" height="1" alt=""></td>

16
source/plugins/people/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people</code></td>
<td nowrap="nowrap"><h4><code>plugin_people</code></h4></td>
<td rowspan="2"><p>Enable people plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_people_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -54,7 +54,7 @@
<b>default:</b> 24<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_identicons</code></td>
<td nowrap="nowrap"><h4><code>plugin_people_identicons</code></h4></td>
<td rowspan="2"><p>Toggle identicons display</p>
<p>This can be used to mask user profile pictures for privacy</p>
<img width="900" height="1" alt=""></td>
@@ -65,7 +65,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_size</code></td>
<td nowrap="nowrap"><h4><code>plugin_people_size</code></h4></td>
<td rowspan="2"><p>Profile picture display size</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -78,7 +78,7 @@
<b>default:</b> 28<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_types</code></td>
<td nowrap="nowrap"><h4><code>plugin_people_types</code></h4></td>
<td rowspan="2"><p>Displayed sections (order is respected)</p>
<p>User and organization accounts support the following values:</p>
<ul>
@@ -105,7 +105,7 @@ Repositories support the following values:</li>
<b>allowed values:</b><ul><li>followers</li><li>following</li><li>followed</li><li>sponsoring</li><li>members</li><li>sponsored</li><li>sponsors</li><li>contributors</li><li>stargazers</li><li>watchers</li><li>thanks</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_thanks</code></td>
<td nowrap="nowrap"><h4><code>plugin_people_thanks</code></h4></td>
<td rowspan="2"><p>Special thanks</p>
<p>This list can be used to thank specific users</p>
<img width="900" height="1" alt=""></td>
@@ -117,7 +117,7 @@ Repositories support the following values:</li>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_sponsors_custom</code></td>
<td nowrap="nowrap"><h4><code>plugin_people_sponsors_custom</code></h4></td>
<td rowspan="2"><p>Custom sponsors</p>
<p>This list can be used to add users from unsupported GitHub sponsors sources.
The option <code>plugin_people_types</code> must contain the <code>sponsors</code> section in order for this setting to be effective</p>
@@ -130,7 +130,7 @@ The option <code>plugin_people_types</code> must contain the <code>sponsors</cod
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_shuffle</code></td>
<td nowrap="nowrap"><h4><code>plugin_people_shuffle</code></h4></td>
<td rowspan="2"><p>Shuffle data for varied output</p>
<p>This will fetch 10 times more data than <code>plugin_people_limit</code> to ensure output is always different</p>
<img width="900" height="1" alt=""></td>

12
source/plugins/posts/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts</code></td>
<td nowrap="nowrap"><h4><code>plugin_posts</code></h4></td>
<td rowspan="2"><p>Enable posts plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_source</code></td>
<td nowrap="nowrap"><h4><code>plugin_posts_source</code></h4></td>
<td rowspan="2"><p>External source</p>
<ul>
<li><code>dev.to</code>: <a href="https://dev.to">dev.to</a></li>
@@ -55,7 +55,7 @@
<b>allowed values:</b><ul><li>dev.to</li><li>hashnode</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_descriptions</code></td>
<td nowrap="nowrap"><h4><code>plugin_posts_descriptions</code></h4></td>
<td rowspan="2"><p>Toggle posts descriptions display</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -65,7 +65,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_covers</code></td>
<td nowrap="nowrap"><h4><code>plugin_posts_covers</code></h4></td>
<td rowspan="2"><p>Toggle posts cover images display</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -75,7 +75,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_posts_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -88,7 +88,7 @@
<b>default:</b> 4<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_user</code></td>
<td nowrap="nowrap"><h4><code>plugin_posts_user</code></h4></td>
<td rowspan="2"><p>External source username</p>
<img width="900" height="1" alt=""></td>
</tr>

8
source/plugins/projects/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects</code></td>
<td nowrap="nowrap"><h4><code>plugin_projects</code></h4></td>
<td rowspan="2"><p>Enable projects plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_projects_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<p>Note that <code>plugin_projects_repositories</code> is not affected by this option</p>
<img width="900" height="1" alt=""></td>
@@ -54,7 +54,7 @@
<b>default:</b> 4<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects_repositories</code></td>
<td nowrap="nowrap"><h4><code>plugin_projects_repositories</code></h4></td>
<td rowspan="2"><p>List of repositories projects</p>
<p>Use the following syntax for each project <code>:user/:repo/projects/:project_id</code></p>
<img width="900" height="1" alt=""></td>
@@ -66,7 +66,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects_descriptions</code></td>
<td nowrap="nowrap"><h4><code>plugin_projects_descriptions</code></h4></td>
<td rowspan="2"><p>Toggle projects descriptions display</p>
<img width="900" height="1" alt=""></td>
</tr>

18
source/plugins/reactions/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions</code></h4></td>
<td rowspan="2"><p>Enable reactions plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_limit</code></h4></td>
<td rowspan="2"><p>Display limit (issues and pull requests comments)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -53,7 +53,7 @@
<b>default:</b> 200<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_issues</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_limit_issues</code></h4></td>
<td rowspan="2"><p>Display limit (issues and pull requests, first comment)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -66,7 +66,7 @@
<b>default:</b> 100<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_discussions</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_limit_discussions</code></h4></td>
<td rowspan="2"><p>Display limit (discussions, first comment)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -79,7 +79,7 @@
<b>default:</b> 100<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_discussions_comments</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_limit_discussions_comments</code></h4></td>
<td rowspan="2"><p>Display limit (discussions comments)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -92,7 +92,7 @@
<b>default:</b> 100<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_days</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_days</code></h4></td>
<td rowspan="2"><p>Comments maximum age</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -105,7 +105,7 @@
<b>default:</b> 0<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_display</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_display</code></h4></td>
<td rowspan="2"><p>Display mode</p>
<ul>
<li><code>absolute</code>: scale percentages using total reactions count</li>
@@ -120,7 +120,7 @@
<b>allowed values:</b><ul><li>absolute</li><li>relative</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_details</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_details</code></h4></td>
<td rowspan="2"><p>Additional details</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -131,7 +131,7 @@
<b>allowed values:</b><ul><li>count</li><li>percentage</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_ignored</code></td>
<td nowrap="nowrap"><h4><code>plugin_reactions_ignored</code></h4></td>
<td rowspan="2"><p>Ignored users</p>
<p>Useful to ignore bots activity</p>
<img width="900" height="1" alt=""></td>

4
source/plugins/repositories/README.md
View File

@@ -34,7 +34,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_repositories</code></td>
<td nowrap="nowrap"><h4><code>plugin_repositories</code></h4></td>
<td rowspan="2"><p>Enable repositories plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -44,7 +44,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_repositories_featured</code></td>
<td nowrap="nowrap"><h4><code>plugin_repositories_featured</code></h4></td>
<td rowspan="2"><p>List of featured repositories</p>
<p>If no owner is specified, it will implicitly use the current account login</p>
<img width="900" height="1" alt=""></td>

6
source/plugins/rss/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_rss</code></td>
<td nowrap="nowrap"><h4><code>plugin_rss</code></h4></td>
<td rowspan="2"><p>Enable rss plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_rss_source</code></td>
<td nowrap="nowrap"><h4><code>plugin_rss_source</code></h4></td>
<td rowspan="2"><p>RSS feed source</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -49,7 +49,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_rss_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_rss_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>

10
source/plugins/skyline/README.md
View File

@@ -33,7 +33,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline</code></td>
<td nowrap="nowrap"><h4><code>plugin_skyline</code></h4></td>
<td rowspan="2"><p>Enable skyline plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -43,7 +43,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_year</code></td>
<td nowrap="nowrap"><h4><code>plugin_skyline_year</code></h4></td>
<td rowspan="2"><p>Displayed year</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -55,7 +55,7 @@
<b>default:</b> current-year<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_frames</code></td>
<td nowrap="nowrap"><h4><code>plugin_skyline_frames</code></h4></td>
<td rowspan="2"><p>Frames count</p>
<p>Use 120 for a full-loop and 60 for a half-loop.
A higher number of frames will increase file size.</p>
@@ -70,7 +70,7 @@ A higher number of frames will increase file size.</p>
<b>default:</b> 60<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_quality</code></td>
<td nowrap="nowrap"><h4><code>plugin_skyline_quality</code></h4></td>
<td rowspan="2"><p>Image quality</p>
<p>A higher image quality will increase file size.</p>
<img width="900" height="1" alt=""></td>
@@ -84,7 +84,7 @@ A higher number of frames will increase file size.</p>
<b>default:</b> 0.5<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_compatibility</code></td>
<td nowrap="nowrap"><h4><code>plugin_skyline_compatibility</code></h4></td>
<td rowspan="2"><p>Compatibility mode</p>
<p>This uses CSS animations rather than embedded GIF to support a widerr range of browser, like Firefox and Safari.
Using this mode significantly increase file size as each frame is encoded separately</p>

4
source/plugins/sponsors/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_sponsors</code></td>
<td nowrap="nowrap"><h4><code>plugin_sponsors</code></h4></td>
<td rowspan="2"><p>Enable sponsors plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_sponsors_sections</code></td>
<td nowrap="nowrap"><h4><code>plugin_sponsors_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>goal</code>: display GitHub active goal</li>

12
source/plugins/stackoverflow/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow</code></td>
<td nowrap="nowrap"><h4><code>plugin_stackoverflow</code></h4></td>
<td rowspan="2"><p>Enable stackoverflow plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_user</code></td>
<td nowrap="nowrap"><h4><code>plugin_stackoverflow_user</code></h4></td>
<td rowspan="2"><p>Stackoverflow user id</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -51,7 +51,7 @@
<b>default:</b> 0<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_sections</code></td>
<td nowrap="nowrap"><h4><code>plugin_stackoverflow_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>answers-top</code>: display most popular answers</li>
@@ -69,7 +69,7 @@
<b>allowed values:</b><ul><li>answers-top</li><li>answers-recent</li><li>questions-top</li><li>questions-recent</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_stackoverflow_limit</code></h4></td>
<td rowspan="2"><p>Display limit (per section)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -82,7 +82,7 @@
<b>default:</b> 2<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_lines</code></td>
<td nowrap="nowrap"><h4><code>plugin_stackoverflow_lines</code></h4></td>
<td rowspan="2"><p>Display limit for questions and answers</p>
<p>Code snippets count as a single line and must be configured with <code>plugin_stackoverflow_lines_snippet</code> instead</p>
<img width="900" height="1" alt=""></td>
@@ -96,7 +96,7 @@
<b>default:</b> 4<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_lines_snippet</code></td>
<td nowrap="nowrap"><h4><code>plugin_stackoverflow_lines_snippet</code></h4></td>
<td rowspan="2"><p>Display limit for code snippets</p>
<img width="900" height="1" alt=""></td>
</tr>

7
source/plugins/stargazers/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stargazers</code></td>
<td nowrap="nowrap"><h4><code>plugin_stargazers</code></h4></td>
<td rowspan="2"><p>Enable stargazers plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stargazers_charts_type</code></td>
<td nowrap="nowrap"><h4><code>plugin_stargazers_charts_type</code></h4></td>
<td rowspan="2"><p>Charts display type</p>
<ul>
<li><code>classic</code>: <code>&lt;div&gt;</code> based charts, simple and lightweight</li>
@@ -50,8 +50,7 @@
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>string</code>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
<br>
<b>default:</b> classic<br>
<b>allowed values:</b><ul><li>classic</li><li>chartist</li></ul></td>

12
source/plugins/starlists/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists</code></td>
<td nowrap="nowrap"><h4><code>plugin_starlists</code></h4></td>
<td rowspan="2"><p>Enable starlists plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_starlists_limit</code></h4></td>
<td rowspan="2"><p>Display limit (star lists)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -53,7 +53,7 @@
<b>default:</b> 2<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_limit_repositories</code></td>
<td nowrap="nowrap"><h4><code>plugin_starlists_limit_repositories</code></h4></td>
<td rowspan="2"><p>Display limit (repositories per star list)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -66,7 +66,7 @@
<b>default:</b> 2<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_shuffle_repositories</code></td>
<td nowrap="nowrap"><h4><code>plugin_starlists_shuffle_repositories</code></h4></td>
<td rowspan="2"><p>Shuffle data for varied outputs</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -76,7 +76,7 @@
<b>default:</b> yes<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_ignored</code></td>
<td nowrap="nowrap"><h4><code>plugin_starlists_ignored</code></h4></td>
<td rowspan="2"><p>Skipped star lists</p>
<p>This is case and emojis insensitive</p>
<img width="900" height="1" alt=""></td>
@@ -87,7 +87,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_only</code></td>
<td nowrap="nowrap"><h4><code>plugin_starlists_only</code></h4></td>
<td rowspan="2"><p>Restrict display to specified star lists</p>
<p>This is case and emojis insensitive.
This option is equivalent to <code>plugin_starlists_ignored</code> with all star lists but the ones listed in this option</p>

4
source/plugins/stars/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stars</code></td>
<td nowrap="nowrap"><h4><code>plugin_stars</code></h4></td>
<td rowspan="2"><p>Enable stars plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stars_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_stars_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>

2
source/plugins/support/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_support</code></td>
<td nowrap="nowrap"><h4><code>plugin_support</code></h4></td>
<td rowspan="2"><p>Enable support plugin</p>
<img width="900" height="1" alt=""></td>
</tr>

8
source/plugins/topics/README.md
View File

@@ -32,7 +32,7 @@ Check out <a href="https://github.com/topics">GitHub topics</a> to search intere
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics</code></td>
<td nowrap="nowrap"><h4><code>plugin_topics</code></h4></td>
<td rowspan="2"><p>Enable topics plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -42,7 +42,7 @@ Check out <a href="https://github.com/topics">GitHub topics</a> to search intere
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics_mode</code></td>
<td nowrap="nowrap"><h4><code>plugin_topics_mode</code></h4></td>
<td rowspan="2"><p>Display mode:</p>
<ul>
<li><code>labels</code>: display labels</li>
@@ -59,7 +59,7 @@ Check out <a href="https://github.com/topics">GitHub topics</a> to search intere
<b>allowed values:</b><ul><li>labels</li><li>icons</li><li>starred</li><li>mastered</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics_sort</code></td>
<td nowrap="nowrap"><h4><code>plugin_topics_sort</code></h4></td>
<td rowspan="2"><p>Sorting method:</p>
<ul>
<li><code>stars</code>: sort by most stars</li>
@@ -76,7 +76,7 @@ Check out <a href="https://github.com/topics">GitHub topics</a> to search intere
<b>allowed values:</b><ul><li>stars</li><li>activity</li><li>starred</li><li>random</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_topics_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_topics_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<p>When using <code>plugin_topics_mode: labels</code>, an ellipsis will be displayed</p>
<img width="900" height="1" alt=""></td>

4
source/plugins/traffic/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_traffic</code></td>
<td nowrap="nowrap"><h4><code>plugin_traffic</code></h4></td>
<td rowspan="2"><p>Enable traffic plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_traffic_skipped</code></td>
<td nowrap="nowrap"><h4><code>plugin_traffic_skipped</code></h4></td>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>

10
source/plugins/tweets/README.md
View File

@@ -31,7 +31,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets</code></td>
<td nowrap="nowrap"><h4><code>plugin_tweets</code></h4></td>
<td rowspan="2"><p>Enable tweets plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -41,7 +41,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_token</code></td>
<td nowrap="nowrap"><h4><code>plugin_tweets_token</code></h4></td>
<td rowspan="2"><p>Twitter API token</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -51,7 +51,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_attachments</code></td>
<td nowrap="nowrap"><h4><code>plugin_tweets_attachments</code></h4></td>
<td rowspan="2"><p>Display tweets attachments (images, video previews, etc.)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -61,7 +61,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_tweets_limit</code></h4></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -74,7 +74,7 @@
<b>default:</b> 2<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_user</code></td>
<td nowrap="nowrap"><h4><code>plugin_tweets_user</code></h4></td>
<td rowspan="2"><p>Twitter username</p>
<img width="900" height="1" alt=""></td>
</tr>

14
source/plugins/wakatime/README.md
View File

@@ -30,7 +30,7 @@
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime</code></td>
<td nowrap="nowrap"><h4><code>plugin_wakatime</code></h4></td>
<td rowspan="2"><p>Enable wakatime plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -40,7 +40,7 @@
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_token</code></td>
<td nowrap="nowrap"><h4><code>plugin_wakatime_token</code></h4></td>
<td rowspan="2"><p>WakaTime API token</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -50,7 +50,7 @@
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_days</code></td>
<td nowrap="nowrap"><h4><code>plugin_wakatime_days</code></h4></td>
<td rowspan="2"><p>Time range</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -61,7 +61,7 @@
<b>allowed values:</b><ul><li>7</li><li>30</li><li>180</li><li>365</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_sections</code></td>
<td nowrap="nowrap"><h4><code>plugin_wakatime_sections</code></h4></td>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>time</code>: show total coding time and daily average</li>
@@ -83,7 +83,7 @@
<b>allowed values:</b><ul><li>time</li><li>projects</li><li>projects-graphs</li><li>languages</li><li>languages-graphs</li><li>editors</li><li>editors-graphs</li><li>os</li><li>os-graphs</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_limit</code></td>
<td nowrap="nowrap"><h4><code>plugin_wakatime_limit</code></h4></td>
<td rowspan="2"><p>Display limit (per graph)</p>
<img width="900" height="1" alt=""></td>
</tr>
@@ -96,7 +96,7 @@
<b>default:</b> 5<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_url</code></td>
<td nowrap="nowrap"><h4><code>plugin_wakatime_url</code></h4></td>
<td rowspan="2"><p>WakaTime url</p>
<p>Also compatible with self-hosted instance (<a href="https://github.com/muety/wakapi">wakapi</a>)</p>
<img width="900" height="1" alt=""></td>
@@ -107,7 +107,7 @@
<b>default:</b> https://wakatime.com<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_user</code></td>
<td nowrap="nowrap"><h4><code>plugin_wakatime_user</code></h4></td>
<td rowspan="2"><p>WakaTime username</p>
<img width="900" height="1" alt=""></td>
</tr>