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:
lowlighter
2022-01-15 18:01:41 -05:00
parent 6cb21b31ca
commit 1d5a8efea7
43 changed files with 481 additions and 252 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -1,6 +1,6 @@
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-metrics)
[![Build, test, analyze and publish](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml) [![Metrics (examples)](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml/badge.svg)](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml)
[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)
Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
@@ -21,7 +21,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
</tr>
<tr>
<th colspan="2" align="center">
<h3><a href="/source/plugins/README.md">🧩 Customizable with 38 plugins and 234 options!</a></h3>
<h3><a href="/README.md#-plugins">🧩 Customizable with 38 plugins and 234 options!</a></h3>
</th>
</tr>
<tr>
@@ -47,15 +47,11 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
<th><a href="source/plugins/stars/README.md">🌟 Recently starred repositories</a></th>
</tr>
<tr>
<td align="center">
<details open><summary>With icons</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.icons.svg">
</details>
<details open><summary>With labels</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.svg">
</details>
<img width="900" height="1" alt="">
</td>
<td align="center">
<details open><summary>With icons</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.icons.svg" alt=""></img></details>
<details open><summary>With labels</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.svg" alt=""></img></details>
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stars.svg">
<img width="900" height="1" alt="">
@@ -362,13 +358,13 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
</tr>
<tr>
<th colspan="2" align="center">
<a href="/#-plugins">🎲 See also community plugins</a>
<a href="/README.md#-pluginss">🎲 See also community plugins</a>
</th>
</tr>
<tr>
<th colspan="2" align="center">
<h3><a href="/source/templates/README.md">🖼️ And even more with 4+ templates!</a></h3>
<h3><a href="/README.md#%EF%B8%8F-templates">🖼️ And even more with 4+ templates!</a></h3>
</th>
</tr>
<tr>
@@ -424,7 +420,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
<tr>
<td align="center" colspan="2">
<b>Power user?</b><br>
<a href="https://github.com/lowlighter/metrics/fork">Fork this repository</a> and edit HTML, CSS, JS and <a href="https://github.com/mde/ejs"> for even more customization!
<a href="https://github.com/lowlighter/metrics/fork">Fork this repository</a> and edit HTML, CSS, JS and <a href="https://github.com/mde/ejs">EJS</a> for even more customization!
</td>
</tr>
</table>
@@ -448,14 +444,16 @@ There are several ways to setup metrics, each having its advantages and disadvan
* [💕 Using the shared instance *(~1 min)*](/.github/readme/partials/documentation/setup/shared.md)
* ✔️ Easily configurable and previewable
* ➖ Limited features *(compute-intensive features are disabled)*
* 🐳 Using command line with docker *(~5 min)* *(documentation not available yet)*
* [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
* ✔️ Create another shared instance
* ➖ Requires some sysadmin knowlegde
* [🐳 Using command line with docker *(~5 min)*](/.github/readme/partials/documentation/setup/docker.md)
* ✔️ Suited for one-time rendering
* [🏗️ Deploying your own web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
* ➖ Mostly intended for development, or to create another shared instance
* [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md)
Additional resources for setup:
* [🏦 Configuring metrics for organizations](/.github/readme/partials/documentation/organizations.md)
* 🧰 Template/Plugin compatibility matrix *(documentation not available yet)*
* [🏦 Configure metrics for organizations](/.github/readme/partials/documentation/organizations.md)
* [🧰 Template/Plugin compatibility matrix](/.github/readme/partials/documentation/compatibility.md)
## 🖼️ Templates
Templates lets you change general appearance of rendered metrics.
@@ -469,7 +467,7 @@ Templates lets you change general appearance of rendered metrics.
## 🧩 Plugins
Plugins provide additional content and lets you customize your rendered metrics.
Plugins provide additional content and lets you customize rendered metrics.
**📦 Maintained by core team**

2
settings.example.json generated
View File

@@ -39,7 +39,7 @@
"enabled": false, "//": "Enable languages plugin"
},
"topics":{
"enabled": false, "//": "Display starred topics"
"enabled": false, "//": "Enable topics plugin"
},
"stars":{
"enabled": false, "//": "Display recently starred repositories"

2
source/plugins/README.md
View File

@@ -1,6 +1,6 @@
## 🧩 Plugins
Plugins provide additional content and lets you customize your rendered metrics.
Plugins provide additional content and lets you customize rendered metrics.
**📦 Maintained by core team**

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

@@ -36,7 +36,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements</code></td>
<td rowspan="2">Display achievements<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display achievements</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -45,7 +46,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_threshold</code></td>
<td rowspan="2">Display rank minimal threshold<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display rank minimal threshold</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -55,7 +57,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_secrets</code></td>
<td rowspan="2">Display unlocked secrets achievements<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display unlocked secrets achievements</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -64,7 +67,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_display</code></td>
<td rowspan="2">Achievements display style<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Achievements display style</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -74,7 +78,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_limit</code></td>
<td rowspan="2">Maximum number of achievements to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of achievements to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -85,7 +90,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_ignored</code></td>
<td rowspan="2">Unlocked achievements to hide<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Unlocked achievements to hide</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -94,7 +100,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_achievements_only</code></td>
<td rowspan="2">Unlocked achievements to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Unlocked achievements to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>

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

@@ -38,7 +38,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity</code></td>
<td rowspan="2">Display recent activity<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display recent activity</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -47,7 +48,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_limit</code></td>
<td rowspan="2">Maximum number of events to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of events to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -59,7 +61,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_load</code></td>
<td rowspan="2">Number of events to load<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of events to load</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -71,7 +74,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_days</code></td>
<td rowspan="2">Maximum event age<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum event age</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -83,7 +87,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_filter</code></td>
<td rowspan="2">Events types to keep<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Events types to keep</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -94,7 +99,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_visibility</code></td>
<td rowspan="2">Set events visibility<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Set events visibility</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -104,7 +110,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_timestamps</code></td>
<td rowspan="2">Display events timestamps<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display events timestamps</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -113,7 +120,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_skipped</code></td>
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Repositories to skip</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
@@ -123,7 +131,8 @@ Use a full `repo` scope token to display **private** events.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_activity_ignored</code></td>
<td rowspan="2">Actors to ignore<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Actors to ignore</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>users_ignored</code><br>

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

@@ -34,7 +34,8 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist</code></td>
<td rowspan="2">Display data from your AniList account<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display data from your AniList account</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -43,7 +44,8 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_medias</code></td>
<td rowspan="2">Medias types to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Medias types to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -54,7 +56,8 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_sections</code></td>
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Sections to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -65,7 +68,8 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_limit</code></td>
<td rowspan="2">Maximum number of entries to display per section<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of entries to display per section</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -76,7 +80,8 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_limit_characters</code></td>
<td rowspan="2">Maximum number of entries to display in characters section<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of entries to display in characters section</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -87,7 +92,8 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_shuffle</code></td>
<td rowspan="2">Shuffle AniList data<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Shuffle AniList data</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -96,7 +102,8 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_user</code></td>
<td rowspan="2">AniList login<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>AniList login</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>

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

@@ -33,7 +33,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>base</code></td>
<td rowspan="2">Metrics base content<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Metrics base content</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -44,7 +45,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>repositories</code></td>
<td rowspan="2">Number of repositories to use<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of repositories to use</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -55,7 +57,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_batch</code></td>
<td rowspan="2">Number of repositories to load at once by queries<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of repositories to load at once by queries</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -67,7 +70,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_forks</code></td>
<td rowspan="2">Include forks in metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Include forks in metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -76,7 +80,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_affiliations</code></td>
<td rowspan="2">Repositories affiliations<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Repositories affiliations</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -87,7 +92,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>repositories_skipped</code></td>
<td rowspan="2">Default repositories to skip<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Default repositories to skip</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -97,7 +103,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>users_ignored</code></td>
<td rowspan="2">Default users to ignore<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Default users to ignore</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -109,7 +116,8 @@ These are all enabled by default, but you can explicitely opt out from them.
</tr>
<tr>
<td nowrap="nowrap"><code>commits_authoring</code></td>
<td rowspan="2">List of surnames or email addresses you use when authoring commits<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>List of surnames or email addresses you use when authoring commits</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>

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

@@ -20,7 +20,8 @@ Display a random code snippet from your recent activity history.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code</code></td>
<td rowspan="2">Display a random code snippet from recent activity<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display a random code snippet from recent activity</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -29,7 +30,8 @@ Display a random code snippet from your recent activity history.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_lines</code></td>
<td rowspan="2">Maximum number of line that a code snippet can contain<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of line that a code snippet can contain</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -38,7 +40,8 @@ Display a random code snippet from your recent activity history.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_load</code></td>
<td rowspan="2">Number of events to load<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of events to load</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -50,7 +53,8 @@ Display a random code snippet from your recent activity history.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_visibility</code></td>
<td rowspan="2">Set events visibility<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Set events visibility</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -60,7 +64,8 @@ Display a random code snippet from your recent activity history.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_skipped</code></td>
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Repositories to skip</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
@@ -70,7 +75,8 @@ Display a random code snippet from your recent activity history.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_code_languages</code></td>
<td rowspan="2">Restrict code snippet languages<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Restrict code snippet languages</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>

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

@@ -43,7 +43,8 @@ Matching is performed in keys order.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors</code></td>
<td rowspan="2">Display repository contributors<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display repository contributors</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -52,7 +53,8 @@ Matching is performed in keys order.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_base</code></td>
<td rowspan="2">Base reference<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Base reference</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -60,7 +62,8 @@ Matching is performed in keys order.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_head</code></td>
<td rowspan="2">Head reference<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Head reference</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -69,7 +72,8 @@ Matching is performed in keys order.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_ignored</code></td>
<td rowspan="2">Contributors to ignore<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Contributors to ignore</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>users_ignored</code><br>
@@ -80,7 +84,8 @@ Matching is performed in keys order.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_contributions</code></td>
<td rowspan="2">Display contributions<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display contributions</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -89,7 +94,8 @@ Matching is performed in keys order.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_sections</code></td>
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Sections to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -100,7 +106,8 @@ Matching is performed in keys order.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_contributors_categories</code></td>
<td rowspan="2">Contributions categories<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Contributions categories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>

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

@@ -11,7 +11,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>token</code></td>
<td rowspan="2">GitHub Personal Token<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>GitHub Personal Token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✔️ Required<br>
@@ -21,7 +22,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>user</code></td>
<td rowspan="2">GitHub username<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>GitHub username</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -29,7 +31,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>repo</code></td>
<td rowspan="2">GitHub repository<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>GitHub repository</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -37,7 +40,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>committer_token</code></td>
<td rowspan="2">GitHub Token used to commit metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>GitHub Token used to commit metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
@@ -47,7 +51,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>committer_branch</code></td>
<td rowspan="2">Branch used to commit rendered metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Branch used to commit rendered metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -55,7 +60,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>committer_message</code></td>
<td rowspan="2">Commit message<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Commit message</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -64,7 +70,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>committer_gist</code></td>
<td rowspan="2">Gist used to store metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Gist used to store metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -72,7 +79,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>filename</code></td>
<td rowspan="2">Rendered metrics output path<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Rendered metrics output path</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -81,7 +89,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>markdown</code></td>
<td rowspan="2">Rendered markdown output path<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Rendered markdown output path</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -90,7 +99,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>markdown_cache</code></td>
<td rowspan="2">Rendered markdown file cache<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Rendered markdown file cache</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -99,7 +109,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>output_action</code></td>
<td rowspan="2">Output action<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Output action</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -109,7 +120,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>output_condition</code></td>
<td rowspan="2">Output condition<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Output condition</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -119,7 +131,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>optimize</code></td>
<td rowspan="2">SVG optimization<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>SVG optimization</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -130,7 +143,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>setup_community_templates</code></td>
<td rowspan="2">Additional community templates to setup<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Additional community templates to setup</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -140,7 +154,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>template</code></td>
<td rowspan="2">Template to use<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Template to use</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -149,7 +164,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>query</code></td>
<td rowspan="2">Additional query parameters<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Additional query parameters</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>json</code>
@@ -158,7 +174,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>extras_css</code></td>
<td rowspan="2">Extra CSS<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Extra CSS</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -167,7 +184,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_timezone</code></td>
<td rowspan="2">Timezone used<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Timezone used</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -176,7 +194,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_order</code></td>
<td rowspan="2">Configure content order<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Configure content order</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -186,7 +205,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_twemoji</code></td>
<td rowspan="2">Use twemojis instead of emojis<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Use twemojis instead of emojis</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -196,7 +216,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_gemoji</code></td>
<td rowspan="2">Use GitHub custom emojis<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Use GitHub custom emojis</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -206,7 +227,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_display</code></td>
<td rowspan="2">Render display width<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Render display width</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -217,7 +239,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_animations</code></td>
<td rowspan="2">SVG CSS animations<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>SVG CSS animations</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -227,7 +250,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_base64</code></td>
<td rowspan="2">Encode images links into base64 data<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Encode images links into base64 data</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏭️ Global option<br>
@@ -237,7 +261,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_padding</code></td>
<td rowspan="2">Image padding<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Image padding</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -246,7 +271,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>config_output</code></td>
<td rowspan="2">Output image format<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Output image format</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -256,7 +282,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>retries</code></td>
<td rowspan="2">Number of retries<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of retries</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -268,7 +295,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>retries_delay</code></td>
<td rowspan="2">Time to wait (in seconds) before each retry<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Time to wait (in seconds) before each retry</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -280,7 +308,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>retries_output_action</code></td>
<td rowspan="2">Number of retries (output action)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of retries (output action)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -292,7 +321,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>retries_delay_output_action</code></td>
<td rowspan="2">Time to wait (in seconds) before each retry (output action)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Time to wait (in seconds) before each retry (output action)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -304,7 +334,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>delay</code></td>
<td rowspan="2">Use this to avoid triggering abuse mechanics on large workflows<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Use this to avoid triggering abuse mechanics on large workflows</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -316,7 +347,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>use_prebuilt_image</code></td>
<td rowspan="2">Use pre-built image from GitHub registry<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Use pre-built image from GitHub registry</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -325,7 +357,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>plugins_errors_fatal</code></td>
<td rowspan="2">Die on plugins errors<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Die on plugins errors</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔧 For development<br>
@@ -335,7 +368,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>debug</code></td>
<td rowspan="2">Debug logs<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Debug logs</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔧 For development<br>
@@ -345,7 +379,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>verify</code></td>
<td rowspan="2">Verify SVG<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Verify SVG</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔧 For development<br>
@@ -355,7 +390,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>debug_flags</code></td>
<td rowspan="2">Debug flags<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Debug flags</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔧 For development<br>
@@ -366,7 +402,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>dryrun</code></td>
<td rowspan="2">Enable dry-run<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Enable dry-run</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔧 For development<br>
@@ -376,7 +413,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>experimental_features</code></td>
<td rowspan="2">Experimental features<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Experimental features</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔧 For development<br>
@@ -387,7 +425,8 @@ Metrics also have general options that impact global metrics rendering.
</tr>
<tr>
<td nowrap="nowrap"><code>use_mocked_data</code></td>
<td rowspan="2">Use mocked data instead of live APIs<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Use mocked data instead of live APIs</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔧 For development<br>

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

@@ -18,7 +18,8 @@ The *discussions* plugin displays your GitHub discussions metrics.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_discussions</code></td>
<td rowspan="2">GitHub discussions metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>GitHub discussions metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -27,7 +28,8 @@ The *discussions* plugin displays your GitHub discussions metrics.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_discussions_categories</code></td>
<td rowspan="2">Display discussion categories<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display discussion categories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
@@ -37,7 +39,8 @@ The *discussions* plugin displays your GitHub discussions metrics.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_discussions_categories_limit</code></td>
<td rowspan="2">Number of discussion categories to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of discussion categories to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>

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

@@ -26,7 +26,8 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_followup</code></td>
<td rowspan="2">Display follow-up of repositories issues and pull requests<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display follow-up of repositories issues and pull requests</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -35,7 +36,8 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_followup_sections</code></td>
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Sections to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -46,7 +48,8 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_followup_indepth</code></td>
<td rowspan="2">Indepth follow-up processing<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Indepth follow-up processing</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>

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

@@ -18,7 +18,8 @@ The *gists* plugin displays your [gists](https://gist.github.com) metrics.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_gists</code></td>
<td rowspan="2">Display gists metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display gists metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -34,7 +34,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits</code></td>
<td rowspan="2">Display coding habits metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display coding habits metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -43,7 +44,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_from</code></td>
<td rowspan="2">Number of events to use<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of events to use</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -55,7 +57,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_days</code></td>
<td rowspan="2">Maximum event age<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum event age</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -67,7 +70,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_facts</code></td>
<td rowspan="2">Display coding habits collected facts based on recent activity<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display coding habits collected facts based on recent activity</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -76,7 +80,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_charts</code></td>
<td rowspan="2">Display coding habits charts based on recent activity<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display coding habits charts based on recent activity</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -86,7 +91,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_habits_trim</code></td>
<td rowspan="2">Trim unused hours on daily chart<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Trim unused hours on daily chart</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -24,7 +24,8 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_introduction</code></td>
<td rowspan="2">Display account or repository introduction<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display account or repository introduction</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -33,7 +34,8 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_introduction_title</code></td>
<td rowspan="2">Display introduction section title<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display introduction section title</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -31,7 +31,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_isocalendar</code></td>
<td rowspan="2">Enable isocalendar plugin<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Enable isocalendar plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -40,7 +41,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_isocalendar_duration</code></td>
<td rowspan="2">Time window<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Time window</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>

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

@@ -33,7 +33,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages</code></td>
<td rowspan="2">Enable languages plugin<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Enable languages plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -42,7 +43,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_ignored</code></td>
<td rowspan="2">Ignored languages<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Ignored languages</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -51,7 +53,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_skipped</code></td>
<td rowspan="2">Skipped repositories<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
@@ -61,7 +64,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_limit</code></td>
<td rowspan="2">Display limit<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display limit</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -74,7 +78,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_threshold</code></td>
<td rowspan="2">Display threshold (percentage)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display threshold (percentage)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -83,7 +88,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_colors</code></td>
<td rowspan="2">Custom languages colors<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Custom languages colors</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -93,7 +99,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_aliases</code></td>
<td rowspan="2">Custom languages names<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Custom languages names</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -101,7 +108,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_sections</code></td>
<td rowspan="2">Displayed sections<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Displayed sections</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -113,7 +121,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_details</code></td>
<td rowspan="2">Additional details<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Additional details</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -124,7 +133,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_indepth</code></td>
<td rowspan="2">Indepth mode (⚠️ read documentation first)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Indepth mode (⚠️ read documentation first)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -134,7 +144,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_analysis_timeout</code></td>
<td rowspan="2">Indepth mode - Analysis timeout<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Indepth mode - Analysis timeout</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -147,7 +158,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_categories</code></td>
<td rowspan="2">Indepth mode - Displayed categories (most-used section)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Indepth mode - Displayed categories (most-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -159,7 +171,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_recent_categories</code></td>
<td rowspan="2">Indepth mode - Displayed categories (recently-used section)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Indepth mode - Displayed categories (recently-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -171,7 +184,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_recent_load</code></td>
<td rowspan="2">Events to load (recently-used section)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Events to load (recently-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -184,7 +198,8 @@
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_languages_recent_days</code></td>
<td rowspan="2">Events maximum age (day, recently-used section)<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Events maximum age (day, recently-used section)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>

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

@@ -33,7 +33,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses</code></td>
<td rowspan="2">Display licenses informations<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display licenses informations</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
@@ -43,7 +44,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses_setup</code></td>
<td rowspan="2">Command to setup target repository<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Command to setup target repository</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -51,7 +53,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses_ratio</code></td>
<td rowspan="2">Display used licenses ratio<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display used licenses ratio</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -60,7 +63,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_licenses_legal</code></td>
<td rowspan="2">Display legal informations about used licenses<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display legal informations about used licenses</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -18,7 +18,8 @@ The *lines* of code plugin displays the number of lines of code you have added a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_lines</code></td>
<td rowspan="2">Display lines of code metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display lines of code metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -27,7 +28,8 @@ The *lines* of code plugin displays the number of lines of code you have added a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_lines_skipped</code></td>
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Repositories to skip</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>

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

@@ -214,7 +214,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music</code></td>
<td rowspan="2">Display your music tracks<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display your music tracks</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -223,7 +224,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_provider</code></td>
<td rowspan="2">Music provider<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Music provider</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -232,7 +234,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_token</code></td>
<td rowspan="2">Music provider personal token<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Music provider personal token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
@@ -241,7 +244,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_mode</code></td>
<td rowspan="2">Plugin mode<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Plugin mode</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -250,7 +254,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_playlist</code></td>
<td rowspan="2">Embed playlist url<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Embed playlist url</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -258,7 +263,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_limit</code></td>
<td rowspan="2">Maximum number of tracks to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of tracks to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -270,7 +276,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_played_at</code></td>
<td rowspan="2">Display when the track was played<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display when the track was played</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -279,7 +286,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_time_range</code></td>
<td rowspan="2">Time period for top mode<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Time period for top mode</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -289,7 +297,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_top_type</code></td>
<td rowspan="2">Whether to show tracks or artists in top mode<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Whether to show tracks or artists in top mode</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -299,7 +308,8 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_music_user</code></td>
<td rowspan="2">Music provider username<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Music provider username</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>

21
source/plugins/nightscout/README.md
View File

@@ -25,7 +25,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout</code></td>
<td rowspan="2">Displays Blood Glucose<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Displays Blood Glucose</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -34,7 +35,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_url</code></td>
<td rowspan="2">Your Nightscout site URL<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Your Nightscout site URL</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -43,7 +45,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_datapoints</code></td>
<td rowspan="2">How many datapoints to show on the graph. 0 and 1 disable the graph.<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>How many datapoints to show on the graph. 0 and 1 disable the graph.</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -54,7 +57,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_lowalert</code></td>
<td rowspan="2">When the blood sugar is considered low<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>When the blood sugar is considered low</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -65,7 +69,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_highalert</code></td>
<td rowspan="2">When the blood sugar is considered high<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>When the blood sugar is considered high</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -76,7 +81,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_urgentlowalert</code></td>
<td rowspan="2">When the blood sugar is considered urgently low<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>When the blood sugar is considered urgently low</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -87,7 +93,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_nightscout_urgenthighalert</code></td>
<td rowspan="2">When the blood sugar is considered urgently high<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>When the blood sugar is considered urgently high</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>

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

@@ -30,7 +30,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable</code></td>
<td rowspan="2">Display notable contributions in organizations<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display notable contributions in organizations</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -39,7 +40,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_filter</code></td>
<td rowspan="2">Query filter<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Query filter</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -47,7 +49,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_from</code></td>
<td rowspan="2">Filter by repository host account type<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Filter by repository host account type</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -57,7 +60,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_repositories</code></td>
<td rowspan="2">Also display repository name<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Also display repository name</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -66,7 +70,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_notable_indepth</code></td>
<td rowspan="2">Indepth notable contributions processing<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Indepth notable contributions processing</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>

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

@@ -35,7 +35,8 @@ Expect 10 to 30 seconds to generate the results.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed</code></td>
<td rowspan="2">Display a website Google PageSpeed metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display a website Google PageSpeed metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -44,7 +45,8 @@ Expect 10 to 30 seconds to generate the results.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_url</code></td>
<td rowspan="2">Audited website<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Audited website</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -53,7 +55,8 @@ Expect 10 to 30 seconds to generate the results.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_detailed</code></td>
<td rowspan="2">Detailed audit result<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Detailed audit result</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -62,7 +65,8 @@ Expect 10 to 30 seconds to generate the results.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_screenshot</code></td>
<td rowspan="2">Display a screenshot of your website<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display a screenshot of your website</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -71,7 +75,8 @@ Expect 10 to 30 seconds to generate the results.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_pagespeed_token</code></td>
<td rowspan="2">PageSpeed token<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>PageSpeed token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>

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

@@ -42,7 +42,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people</code></td>
<td rowspan="2">Display GitHub users from various affiliations<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display GitHub users from various affiliations</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -51,7 +52,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_limit</code></td>
<td rowspan="2">Maximum number of user to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of user to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -62,7 +64,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_size</code></td>
<td rowspan="2">Size of displayed GitHub users' avatars<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Size of displayed GitHub users&#39; avatars</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -74,7 +77,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_types</code></td>
<td rowspan="2">Affiliations to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Affiliations to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -85,7 +89,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_thanks</code></td>
<td rowspan="2">GitHub users to personally thanks<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>GitHub users to personally thanks</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -94,7 +99,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_sponsors_custom</code></td>
<td rowspan="2">Custom GitHub sponsors<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Custom GitHub sponsors</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -103,7 +109,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_identicons</code></td>
<td rowspan="2">Use identicons instead of avatars<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Use identicons instead of avatars</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -112,7 +119,8 @@ Sections will be ordered the same as specified in `plugin_people_types`.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_people_shuffle</code></td>
<td rowspan="2">Shuffle users<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Shuffle users</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

9
source/plugins/poopmap/README.md
View File

@@ -48,7 +48,8 @@ You now have your PoopMap token! This token will not expire and it can only acce
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_poopmap</code></td>
<td rowspan="2">Display PoopMap stats<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display PoopMap stats</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -57,7 +58,8 @@ You now have your PoopMap token! This token will not expire and it can only acce
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_poopmap_token</code></td>
<td rowspan="2">PoopMap API token<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>PoopMap API token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
@@ -66,7 +68,8 @@ You now have your PoopMap token! This token will not expire and it can only acce
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_poopmap_days</code></td>
<td rowspan="2">PoopMap time range<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>PoopMap time range</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>

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

@@ -23,7 +23,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts</code></td>
<td rowspan="2">Display recent posts<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display recent posts</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -32,7 +33,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_source</code></td>
<td rowspan="2">Posts external source<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Posts external source</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -41,7 +43,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_descriptions</code></td>
<td rowspan="2">Display posts descriptions<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display posts descriptions</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -50,7 +53,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_covers</code></td>
<td rowspan="2">Display posts cover images<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display posts cover images</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -59,7 +63,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_limit</code></td>
<td rowspan="2">Maximum number of posts to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of posts to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -71,7 +76,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_posts_user</code></td>
<td rowspan="2">Posts external source username<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Posts external source username</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>

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

@@ -49,7 +49,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects</code></td>
<td rowspan="2">Display active projects<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display active projects</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -58,7 +59,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects_limit</code></td>
<td rowspan="2">Maximum number of projects to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of projects to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -70,7 +72,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects_repositories</code></td>
<td rowspan="2">List of repository project identifiers to disaplay<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>List of repository project identifiers to disaplay</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -79,7 +82,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_projects_descriptions</code></td>
<td rowspan="2">Display projects descriptions<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display projects descriptions</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -18,7 +18,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions</code></td>
<td rowspan="2">Display average issue comments reactions<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display average issue comments reactions</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -27,7 +28,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit</code></td>
<td rowspan="2">Maximum number of issue comments to parse<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of issue comments to parse</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -39,7 +41,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_issues</code></td>
<td rowspan="2">Maximum number of issues and pull requests opened to parse<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of issues and pull requests opened to parse</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -51,7 +54,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_discussions</code></td>
<td rowspan="2">Maximum number of discussions opened to parse<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of discussions opened to parse</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -63,7 +67,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_discussions_comments</code></td>
<td rowspan="2">Maximum number of discussions comments opened to parse<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of discussions comments opened to parse</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -75,7 +80,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_days</code></td>
<td rowspan="2">Maximum comments age<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum comments age</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -86,7 +92,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_display</code></td>
<td rowspan="2">Display mode<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display mode</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -96,7 +103,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_details</code></td>
<td rowspan="2">Additional details<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Additional details</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -106,7 +114,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_ignored</code></td>
<td rowspan="2">Users to ignore<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Users to ignore</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>users_ignored</code><br>

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

@@ -22,7 +22,8 @@ Because of limitations of using SVG inside of `<img>` tags, people won't be able
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_repositories</code></td>
<td rowspan="2">Display chosen featured repositories<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display chosen featured repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -31,7 +32,8 @@ Because of limitations of using SVG inside of `<img>` tags, people won't be able
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_repositories_featured</code></td>
<td rowspan="2">List of repositories to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>List of repositories to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>

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

@@ -18,7 +18,8 @@ The *rss* plugin displays items from a specified RSS feed.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_rss</code></td>
<td rowspan="2">Display RSS feed<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display RSS feed</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -27,7 +28,8 @@ The *rss* plugin displays items from a specified RSS feed.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_rss_source</code></td>
<td rowspan="2">RSS feed source<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>RSS feed source</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -35,7 +37,8 @@ The *rss* plugin displays items from a specified RSS feed.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_rss_limit</code></td>
<td rowspan="2">Maximum number of items to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of items to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>

15
source/plugins/screenshot/README.md
View File

@@ -19,7 +19,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot</code></td>
<td rowspan="2">Display a screenshot of any website<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display a screenshot of any website</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -28,7 +29,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_title</code></td>
<td rowspan="2">Screenshot title caption<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Screenshot title caption</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -37,7 +39,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_url</code></td>
<td rowspan="2">Website to take screenshot<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Website to take screenshot</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -45,7 +48,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_selector</code></td>
<td rowspan="2">Selector to take in screenshot<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Selector to take in screenshot</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -54,7 +58,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_screenshot_background</code></td>
<td rowspan="2">Display or remove default page background<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display or remove default page background</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -22,7 +22,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline</code></td>
<td rowspan="2">Display GitHub Skyline 3D calendar<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display GitHub Skyline 3D calendar</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -31,7 +32,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_year</code></td>
<td rowspan="2">Displayed year<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Displayed year</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -42,7 +44,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_frames</code></td>
<td rowspan="2">Number of frames<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of frames</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -54,7 +57,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_quality</code></td>
<td rowspan="2">Image quality<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Image quality</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -66,7 +70,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_skyline_compatibility</code></td>
<td rowspan="2">Compatibility mode<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Compatibility mode</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -23,7 +23,8 @@ The *sponsors* plugin lets you display your sponsors and introduction text from
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_sponsors</code></td>
<td rowspan="2">Display GitHub sponsors<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display GitHub sponsors</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -32,7 +33,8 @@ The *sponsors* plugin lets you display your sponsors and introduction text from
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_sponsors_sections</code></td>
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Sections to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>

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

@@ -29,7 +29,8 @@ Your user id will be in both url and search bar.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow</code></td>
<td rowspan="2">Stackoverflow metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Stackoverflow metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -38,7 +39,8 @@ Your user id will be in both url and search bar.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_user</code></td>
<td rowspan="2">Stackoverflow user id<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Stackoverflow user id</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -47,7 +49,8 @@ Your user id will be in both url and search bar.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_sections</code></td>
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Sections to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -58,7 +61,8 @@ Your user id will be in both url and search bar.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_limit</code></td>
<td rowspan="2">Maximum number of entries to display per section<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of entries to display per section</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -70,7 +74,8 @@ Your user id will be in both url and search bar.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_lines</code></td>
<td rowspan="2">Maximum number of lines to display per question or answer<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of lines to display per question or answer</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -81,7 +86,8 @@ Your user id will be in both url and search bar.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stackoverflow_lines_snippet</code></td>
<td rowspan="2">Maximum number of lines to display per code snippet<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of lines to display per code snippet</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>

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

@@ -18,7 +18,8 @@ The *stargazers* plugin displays your stargazers evolution across all of your re
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stargazers</code></td>
<td rowspan="2">Display stargazers metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display stargazers metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -18,7 +18,8 @@ The *starlists* plugin displays your recently star lists.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists</code></td>
<td rowspan="2">Display star lists<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display star lists</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
@@ -28,7 +29,8 @@ The *starlists* plugin displays your recently star lists.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_limit</code></td>
<td rowspan="2">Number of star lists to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of star lists to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
@@ -41,7 +43,8 @@ The *starlists* plugin displays your recently star lists.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_limit_repositories</code></td>
<td rowspan="2">Number of repositories to display per star lists<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Number of repositories to display per star lists</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
@@ -54,7 +57,8 @@ The *starlists* plugin displays your recently star lists.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_shuffle_repositories</code></td>
<td rowspan="2">Shuffle displayed repositories<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Shuffle displayed repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
@@ -64,7 +68,8 @@ The *starlists* plugin displays your recently star lists.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_ignored</code></td>
<td rowspan="2">Star lists to skip<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Star lists to skip</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
@@ -74,7 +79,8 @@ The *starlists* plugin displays your recently star lists.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_starlists_only</code></td>
<td rowspan="2">Star lists to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Star lists to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>

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

@@ -18,7 +18,8 @@ The *stars* plugin displays your recently starred repositories.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stars</code></td>
<td rowspan="2">Display recently starred repositories<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display recently starred repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -27,7 +28,8 @@ The *stars* plugin displays your recently starred repositories.
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stars_limit</code></td>
<td rowspan="2">Maximum number of stars to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of stars to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>

15
source/plugins/stock/README.md
View File

@@ -27,7 +27,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock</code></td>
<td rowspan="2">Display stock prices of a given company<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display stock prices of a given company</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -36,7 +37,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_token</code></td>
<td rowspan="2">Yahoo Finance token<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Yahoo Finance token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
@@ -45,7 +47,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_symbol</code></td>
<td rowspan="2">Company stock symbol<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Company stock symbol</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -53,7 +56,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_duration</code></td>
<td rowspan="2">Time range to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Time range to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -63,7 +67,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_stock_interval</code></td>
<td rowspan="2">Time intervals between records<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Time intervals between records</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>

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

@@ -20,7 +20,8 @@ An account on [GitHub Support Community](https://github.community/) is required
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_support</code></td>
<td rowspan="2">GitHub Community Support metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>GitHub Community Support metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>

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

@@ -23,7 +23,8 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_traffic</code></td>
<td rowspan="2">Display repositories traffic metrics<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display repositories traffic metrics</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -32,7 +33,8 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_traffic_skipped</code></td>
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Repositories to skip</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>

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

@@ -35,7 +35,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets</code></td>
<td rowspan="2">Display recent tweets<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display recent tweets</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -44,7 +45,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_token</code></td>
<td rowspan="2">Twitter API token<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Twitter API token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
@@ -53,7 +55,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_attachments</code></td>
<td rowspan="2">Display tweets attchments<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display tweets attchments</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -62,7 +65,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_limit</code></td>
<td rowspan="2">Maximum number of tweets to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of tweets to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -74,7 +78,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_tweets_user</code></td>
<td rowspan="2">Twitter username<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Twitter username</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>

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

@@ -29,7 +29,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime</code></td>
<td rowspan="2">Display WakaTime stats<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Display WakaTime stats</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
@@ -38,7 +39,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_token</code></td>
<td rowspan="2">WakaTime API token<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>WakaTime API token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
@@ -47,7 +49,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_days</code></td>
<td rowspan="2">WakaTime time range<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>WakaTime time range</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -57,7 +60,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_sections</code></td>
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Sections to display</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>array</code>
@@ -67,7 +71,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_limit</code></td>
<td rowspan="2">Maximum number of entries to display per graph<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Maximum number of entries to display per graph</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>number</code>
@@ -78,7 +83,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_url</code></td>
<td rowspan="2">Address where to reach your Wakatime instance<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Address where to reach your Wakatime instance</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>
@@ -87,7 +93,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_wakatime_user</code></td>
<td rowspan="2">Your Wakatime user on the selfhosted Wakapi instance<img width="900" height="1" alt=""></td>
<td rowspan="2"><p>Your Wakatime user on the selfhosted Wakapi instance</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap"><b>type:</b> <code>string</code>

1
tests/cases/starlists.plugin.yml
View File

@@ -7,3 +7,4 @@
plugin_starlists_only: 🤘 TC39
use_mocked_data: 'yes'
verify: 'yes'
timeout: 1800000