ci: auto-regenerate files [skip ci]
This commit is contained in:
lowlighter
39
README.md
39
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
[](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml) [](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml)
|
||||
|
||||
Generate metrics that can be embedded everywhere, including your GitHub profile readme! For users, organizations, and even repositories!
|
||||
Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories!
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
@@ -29,30 +29,18 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
|
||||
<th><a href="source/plugins/languages/README.md">🈷️ Most used languages</a></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<details open><summary>Full year isometric calendar</summary>
|
||||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg">
|
||||
</details>
|
||||
<details><summary>Half year isometric calendar</summary>
|
||||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg">
|
||||
</details>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
<td align="center">
|
||||
<details open><summary>Indepth analysis (clone and analyze repositories)</summary>
|
||||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.indepth.svg">
|
||||
</details>
|
||||
<details open><summary>Recently used (analyze recent activity events)</summary>
|
||||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.recent.svg">
|
||||
</details>
|
||||
<details><summary>Default algorithm</summary>
|
||||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg">
|
||||
</details>
|
||||
<details><summary>Default algorithm (with details)</summary>
|
||||
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg">
|
||||
</details>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
<td align="center">
|
||||
<details open><summary>Full year calendar</summary><img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg" alt=""></img></details>
|
||||
<details><summary>Half year calendar</summary><img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg" alt=""></img></details>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
<td align="center">
|
||||
<details open><summary>Indepth analysis (clone and analyze repositories)</summary><img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.indepth.svg" alt=""></img></details>
|
||||
<details open><summary>Recently used (analyze recent activity events)</summary><img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.recent.svg" alt=""></img></details>
|
||||
<details><summary>Default algorithm</summary><img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg" alt=""></img></details>
|
||||
<details><summary>Default algorithm (with details)</summary><img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg" alt=""></img></details>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="source/plugins/topics/README.md">📌 Starred topics</a></th>
|
||||
@@ -525,6 +513,7 @@ Plugins provide additional content and lets you customize your rendered metrics.
|
||||
* [💹 Stock prices](/source/plugins/stock/README.md)
|
||||
* [🐤 Latest tweets](/source/plugins/tweets/README.md)
|
||||
* [⏰ WakaTime plugin](/source/plugins/wakatime/README.md)
|
||||
|
||||
**🎲 Maintained by community**
|
||||
* [💉 Nightscout](/source/plugins/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars)
|
||||
* [💩 PoopMap plugin](/source/plugins/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat)
|
||||
|
||||
4
settings.example.json
generated
4
settings.example.json
generated
@@ -33,10 +33,10 @@
|
||||
"plugins.default": false, "//": "Default plugin state (advised to let 'false' unless in debug mode)",
|
||||
"plugins": { "//": "Global plugin configuration",
|
||||
"isocalendar":{
|
||||
"enabled": false, "//": "Display an isometric view of your commits calendar"
|
||||
"enabled": false, "//": "Enable isocalendar plugin"
|
||||
},
|
||||
"languages":{
|
||||
"enabled": false, "//": "Display most used languages metrics"
|
||||
"enabled": false, "//": "Enable languages plugin"
|
||||
},
|
||||
"topics":{
|
||||
"enabled": false, "//": "Display starred topics"
|
||||
|
||||
@@ -44,6 +44,7 @@ Plugins provide additional content and lets you customize your rendered metrics.
|
||||
* [💹 Stock prices](/source/plugins/stock/README.md)
|
||||
* [🐤 Latest tweets](/source/plugins/tweets/README.md)
|
||||
* [⏰ WakaTime plugin](/source/plugins/wakatime/README.md)
|
||||
|
||||
**🎲 Maintained by community**
|
||||
* [💉 Nightscout](/source/plugins/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars)
|
||||
* [💩 PoopMap plugin](/source/plugins/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat)
|
||||
|
||||
@@ -30,17 +30,78 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_achievements` | `boolean` **[no]** | Display achievements |
|
||||
| `plugin_achievements_threshold` | `string` **[C]** *{"S", "A", "B", "C", "X"}* | Display rank minimal threshold |
|
||||
| `plugin_achievements_secrets` | `boolean` **[yes]** | Display unlocked secrets achievements |
|
||||
| `plugin_achievements_display` | `string` **[detailed]** *{"detailed", "compact"}* | Achievements display style |
|
||||
| `plugin_achievements_limit` | `number` **[0]** *{0 ≤ 𝑥}* | Maximum number of achievements to display |
|
||||
| `plugin_achievements_ignored` | `array` *(comma-separated)* **[]** | Unlocked achievements to hide |
|
||||
| `plugin_achievements_only` | `array` *(comma-separated)* **[]** | Unlocked achievements to display |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_achievements</code></td>
|
||||
<td rowspan="2">Display achievements<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> C<br>
|
||||
<b>allowed values:</b><ul><li>S</li><li>A</li><li>B</li><li>C</li><li>X</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_achievements_secrets</code></td>
|
||||
<td rowspan="2">Display unlocked secrets achievements<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_achievements_display</code></td>
|
||||
<td rowspan="2">Achievements display style<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> detailed<br>
|
||||
<b>allowed values:</b><ul><li>detailed</li><li>compact</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_achievements_limit</code></td>
|
||||
<td rowspan="2">Maximum number of achievements to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 0<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -32,21 +32,105 @@ Use a full `repo` scope token to display **private** events.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_activity` | `boolean` **[no]** | Display recent activity |
|
||||
| `plugin_activity_limit` | `number` **[5]** *{1 ≤ 𝑥 ≤ 1000}* | Maximum number of events to display |
|
||||
| `plugin_activity_load` | `number` **[300]** *{100 ≤ 𝑥 ≤ 1000}* | Number of events to load |
|
||||
| `plugin_activity_days` | `number` **[14]** *{0 ≤ 𝑥 ≤ 365}* | Maximum event age |
|
||||
| `plugin_activity_filter` | `array` *(comma-separated)* **[all]** *{"all", "comment", "ref/create", "ref/delete", "release", "push", "issue", "pr", "review", "wiki", "fork", "star", "member", "public"}* | Events types to keep |
|
||||
| `plugin_activity_visibility` | `string` **[all]** *{"public", "all"}* | Set events visibility |
|
||||
| `plugin_activity_timestamps` | `boolean` **[no]** | Display events timestamps |
|
||||
| `plugin_activity_skipped` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Repositories to skip |
|
||||
| `plugin_activity_ignored` <sup>⏩</sup> | `undefined` **[]** | Actors to ignore |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ⏩ Value inherits from its related global-level option
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_activity</code></td>
|
||||
<td rowspan="2">Display recent activity<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 5<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(100 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 300<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_activity_days</code></td>
|
||||
<td rowspan="2">Maximum event age<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 365)</i>
|
||||
<b>default:</b> 14<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> all<br>
|
||||
<b>allowed values:</b><ul><li>all</li><li>comment</li><li>ref/create</li><li>ref/delete</li><li>release</li><li>push</li><li>issue</li><li>pr</li><li>review</li><li>wiki</li><li>fork</li><li>star</li><li>member</li><li>public</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_activity_visibility</code></td>
|
||||
<td rowspan="2">Set events visibility<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> all<br>
|
||||
<b>allowed values:</b><ul><li>public</li><li>all</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_activity_timestamps</code></td>
|
||||
<td rowspan="2">Display events timestamps<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_activity_skipped</code></td>
|
||||
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_activity_ignored</code></td>
|
||||
<td rowspan="2">Actors to ignore<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>users_ignored</code><br>
|
||||
<b>type:</b> <code>undefined</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -28,17 +28,82 @@ These sections can also be filtered by media type, which can be either `anime`,
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_anilist` | `boolean` **[no]** | Display data from your AniList account |
|
||||
| `plugin_anilist_medias` | `array` *(comma-separated)* **[anime, manga]** *{"anime", "manga"}* | Medias types to display |
|
||||
| `plugin_anilist_sections` | `array` *(comma-separated)* **[favorites]** *{"favorites", "watching", "reading", "characters"}* | Sections to display |
|
||||
| `plugin_anilist_limit` | `number` **[2]** *{0 ≤ 𝑥}* | Maximum number of entries to display per section |
|
||||
| `plugin_anilist_limit_characters` | `number` **[22]** *{0 ≤ 𝑥}* | Maximum number of entries to display in characters section |
|
||||
| `plugin_anilist_shuffle` | `boolean` **[yes]** | Shuffle AniList data |
|
||||
| `plugin_anilist_user` | `string` **[*→ User login*]** | AniList login |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_anilist</code></td>
|
||||
<td rowspan="2">Display data from your AniList account<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> anime, manga<br>
|
||||
<b>allowed values:</b><ul><li>anime</li><li>manga</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_anilist_sections</code></td>
|
||||
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> favorites<br>
|
||||
<b>allowed values:</b><ul><li>favorites</li><li>watching</li><li>reading</li><li>characters</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_anilist_limit</code></td>
|
||||
<td rowspan="2">Maximum number of entries to display per section<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 2<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 22<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_anilist_shuffle</code></td>
|
||||
<td rowspan="2">Shuffle AniList data<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_anilist_user</code></td>
|
||||
<td rowspan="2">AniList login<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> <code>→ User login</code><br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -27,21 +27,98 @@ These are all enabled by default, but you can explicitely opt out from them.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `base` | `array` *(comma-separated)* **[header, activity, community, repositories, metadata]** *{"header", "activity", "community", "repositories", "metadata"}* | Metrics base content |
|
||||
| `repositories` | `number` **[100]** *{0 ≤ 𝑥}* | Number of repositories to use |
|
||||
| `repositories_batch` | `number` **[100]** *{1 ≤ 𝑥 ≤ 100}* | Number of repositories to load at once by queries |
|
||||
| `repositories_forks` | `boolean` **[no]** | Include forks in metrics |
|
||||
| `repositories_affiliations` | `array` *(comma-separated)* **[owner]** *{"owner", "collaborator", "organization_member"}* | Repositories affiliations |
|
||||
| `repositories_skipped` <sup>⏭️</sup> | `array` *(comma-separated)* **[]** | Default repositories to skip |
|
||||
| `users_ignored` <sup>⏭️</sup> <sup>✨</sup> | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Default users to ignore |
|
||||
| `commits_authoring` <sup>⏭️</sup> | `array` *(comma-seperated)* **[*→ User login*]** | List of surnames or email addresses you use when authoring commits |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ⏭️ Value be inherited by its related plugin-level option
|
||||
* ✨ Currently in beta-testing on `master`/`main`
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>base</code></td>
|
||||
<td rowspan="2">Metrics base content<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> header, activity, community, repositories, metadata<br>
|
||||
<b>allowed values:</b><ul><li>header</li><li>activity</li><li>community</li><li>repositories</li><li>metadata</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>repositories</code></td>
|
||||
<td rowspan="2">Number of repositories to use<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 100<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 100)</i>
|
||||
<b>default:</b> 100<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>repositories_forks</code></td>
|
||||
<td rowspan="2">Include forks in metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>repositories_affiliations</code></td>
|
||||
<td rowspan="2">Repositories affiliations<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> owner<br>
|
||||
<b>allowed values:</b><ul><li>owner</li><li>collaborator</li><li>organization_member</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>repositories_skipped</code></td>
|
||||
<td rowspan="2">Default repositories to skip<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>users_ignored</code></td>
|
||||
<td rowspan="2">Default users to ignore<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> github-actions[bot], dependabot[bot], dependabot-preview[bot]<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-seperated)</i>
|
||||
<br>
|
||||
<b>default:</b> <code>→ User login</code><br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -14,18 +14,70 @@ Display a random code snippet from your recent activity history.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_code` | `boolean` **[no]** | Display a random code snippet from recent activity |
|
||||
| `plugin_code_lines` | `number` **[12]** | Maximum number of line that a code snippet can contain |
|
||||
| `plugin_code_load` | `number` **[100]** *{100 ≤ 𝑥 ≤ 1000}* | Number of events to load |
|
||||
| `plugin_code_visibility` | `string` **[public]** *{"public", "all"}* | Set events visibility |
|
||||
| `plugin_code_skipped` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Repositories to skip |
|
||||
| `plugin_code_languages` | `array` *(comma-separated)* **[]** | Restrict code snippet languages |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ⏩ Value inherits from its related global-level option
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_code</code></td>
|
||||
<td rowspan="2">Display a random code snippet from recent activity<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<b>default:</b> 12<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(100 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 100<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_code_visibility</code></td>
|
||||
<td rowspan="2">Set events visibility<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> public<br>
|
||||
<b>allowed values:</b><ul><li>public</li><li>all</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_code_skipped</code></td>
|
||||
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -37,25 +37,83 @@ Matching is performed in keys order.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_contributors` | `boolean` **[no]** | Display repository contributors |
|
||||
| `plugin_contributors_base` | `string` **[]** | Base reference |
|
||||
| `plugin_contributors_head` | `string` **[master]** | Head reference |
|
||||
| `plugin_contributors_ignored` <sup>⏩</sup> | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore |
|
||||
| `plugin_contributors_contributions` | `boolean` **[no]** | Display contributions |
|
||||
| `plugin_contributors_sections` | `array` *(comma-separated)* **[contributors]** *{"contributors", "categories"}* | Sections to display |
|
||||
| `plugin_contributors_categories` <sup>🧰</sup> | `json` **[{
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_contributors</code></td>
|
||||
<td rowspan="2">Display repository contributors<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_contributors_base</code></td>
|
||||
<td rowspan="2">Base reference<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_contributors_head</code></td>
|
||||
<td rowspan="2">Head reference<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> master<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_contributors_ignored</code></td>
|
||||
<td rowspan="2">Contributors to ignore<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>users_ignored</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> github-actions[bot], dependabot[bot], dependabot-preview[bot]<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_contributors_contributions</code></td>
|
||||
<td rowspan="2">Display contributions<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_contributors_sections</code></td>
|
||||
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> contributors<br>
|
||||
<b>allowed values:</b><ul><li>contributors</li><li>categories</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_contributors_categories</code></td>
|
||||
<td rowspan="2">Contributions categories<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>json</code>
|
||||
<br>
|
||||
<b>default:</b> {
|
||||
"📚 Documentation": ["README.md", "docs/**"],
|
||||
"💻 Code": ["source/**", "src/**"],
|
||||
"#️⃣ Others": ["*"]
|
||||
}
|
||||
]** | Contributions categories |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ⏩ Value inherits from its related global-level option
|
||||
* 🧰 Must be enabled in `settings.json` (for web instances)
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -5,55 +5,397 @@ Metrics also have general options that impact global metrics rendering.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `token` <sup>✔️</sup> <sup>🔐</sup> | `token` | GitHub Personal Token |
|
||||
| `user` | `string` **[]** | GitHub username |
|
||||
| `repo` | `string` **[]** | GitHub repository |
|
||||
| `committer_token` <sup>🔐</sup> | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics |
|
||||
| `committer_branch` | `string` **[]** | Branch used to commit rendered metrics |
|
||||
| `committer_message` | `string` **[Update ${filename} - [Skip GitHub Action]]** | Commit message |
|
||||
| `committer_gist` | `string` **[]** | Gist used to store metrics |
|
||||
| `filename` | `string` **[github-metrics.*]** | Rendered metrics output path |
|
||||
| `markdown` | `string` **[TEMPLATE.md]** | Rendered markdown output path |
|
||||
| `markdown_cache` | `string` **[.cache]** | Rendered markdown file cache |
|
||||
| `output_action` | `string` **[commit]** *{"none", "commit", "pull-request", "pull-request-merge", "pull-request-squash", "pull-request-rebase", "gist"}* | Output action |
|
||||
| `output_condition` | `string` **[always]** *{"always", "data-changed"}* | Output condition |
|
||||
| `optimize` | `array` *(comma-separated)* **[css, xml]** *{"css", "xml", "svg"}* | SVG optimization |
|
||||
| `setup_community_templates` <sup>🧰</sup> | `array` *(comma-separated)* **[]** | Additional community templates to setup |
|
||||
| `template` | `string` **[classic]** | Template to use |
|
||||
| `query` | `json` **[{}]** | Additional query parameters |
|
||||
| `extras_css` <sup>🧰</sup> | `string` **[]** | Extra CSS |
|
||||
| `config_timezone` <sup>⏭️</sup> | `string` **[]** | Timezone used |
|
||||
| `config_order` <sup>⏭️</sup> | `array` *(comma-separated)* **[]** | Configure content order |
|
||||
| `config_twemoji` <sup>⏭️</sup> | `boolean` **[no]** | Use twemojis instead of emojis |
|
||||
| `config_gemoji` <sup>⏭️</sup> | `boolean` **[yes]** | Use GitHub custom emojis |
|
||||
| `config_display` <sup>⏭️</sup> | `string` **[regular]** *{"regular", "large", "columns"}* | Render display width |
|
||||
| `config_animations` <sup>⏭️</sup> | `boolean` **[yes]** | SVG CSS animations |
|
||||
| `config_base64` <sup>⏭️</sup> | `boolean` **[yes]** | Encode images links into base64 data |
|
||||
| `config_padding` | `string` **[0, 8 + 11%]** | Image padding |
|
||||
| `config_output` | `string` **[auto]** *{"auto", "svg", "png", "jpeg", "json", "markdown", "markdown-pdf", "insights"}* | Output image format |
|
||||
| `retries` | `number` **[3]** *{1 ≤ 𝑥 ≤ 10}* | Number of retries |
|
||||
| `retries_delay` | `number` **[300]** *{0 ≤ 𝑥 ≤ 3600}* | Time to wait (in seconds) before each retry |
|
||||
| `retries_output_action` | `number` **[5]** *{1 ≤ 𝑥 ≤ 10}* | Number of retries (output action) |
|
||||
| `retries_delay_output_action` | `number` **[120]** *{0 ≤ 𝑥 ≤ 3600}* | Time to wait (in seconds) before each retry (output action) |
|
||||
| `delay` | `number` **[0]** *{0 ≤ 𝑥 ≤ 3600}* | Use this to avoid triggering abuse mechanics on large workflows |
|
||||
| `use_prebuilt_image` | `boolean` **[yes]** | Use pre-built image from GitHub registry |
|
||||
| `plugins_errors_fatal` <sup>🔧</sup> | `boolean` **[no]** | Die on plugins errors |
|
||||
| `debug` <sup>🔧</sup> | `boolean` **[no]** | Debug logs |
|
||||
| `verify` <sup>🔧</sup> | `boolean` **[no]** | Verify SVG |
|
||||
| `debug_flags` <sup>🔧</sup> | `array` *(space-separated)* **[]** *{"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags |
|
||||
| `dryrun` <sup>🔧</sup> | `boolean` **[no]** | Enable dry-run |
|
||||
| `experimental_features` <sup>🔧</sup> | `array` *(space-separated)* **[]** *{"--optimize-svg"}* | Experimental features |
|
||||
| `use_mocked_data` <sup>🔧</sup> | `boolean` **[no]** | Use mocked data instead of live APIs |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ✔️ Value must be provided
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
* ⏭️ Value be inherited by its related plugin-level option
|
||||
* 🔧 For development purposes, use with caution
|
||||
* 🧰 Must be enabled in `settings.json` (for web instances)
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>token</code></td>
|
||||
<td rowspan="2">GitHub Personal Token<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✔️ Required<br>
|
||||
🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>user</code></td>
|
||||
<td rowspan="2">GitHub username<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>repo</code></td>
|
||||
<td rowspan="2">GitHub repository<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br>
|
||||
<b>default:</b> ${{ github.token }}<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>committer_message</code></td>
|
||||
<td rowspan="2">Commit message<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> Update ${filename} - [Skip GitHub Action]<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>filename</code></td>
|
||||
<td rowspan="2">Rendered metrics output path<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> github-metrics.*<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>markdown</code></td>
|
||||
<td rowspan="2">Rendered markdown output path<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> TEMPLATE.md<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>markdown_cache</code></td>
|
||||
<td rowspan="2">Rendered markdown file cache<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> .cache<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>output_action</code></td>
|
||||
<td rowspan="2">Output action<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> commit<br>
|
||||
<b>allowed values:</b><ul><li>none</li><li>commit</li><li>pull-request</li><li>pull-request-merge</li><li>pull-request-squash</li><li>pull-request-rebase</li><li>gist</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>output_condition</code></td>
|
||||
<td rowspan="2">Output condition<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> always<br>
|
||||
<b>allowed values:</b><ul><li>always</li><li>data-changed</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>optimize</code></td>
|
||||
<td rowspan="2">SVG optimization<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> css, xml<br>
|
||||
<b>allowed values:</b><ul><li>css</li><li>xml</li><li>svg</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>setup_community_templates</code></td>
|
||||
<td rowspan="2">Additional community templates to setup<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>template</code></td>
|
||||
<td rowspan="2">Template to use<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> classic<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>query</code></td>
|
||||
<td rowspan="2">Additional query parameters<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>json</code>
|
||||
<br>
|
||||
<b>default:</b> {}<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>extras_css</code></td>
|
||||
<td rowspan="2">Extra CSS<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>config_timezone</code></td>
|
||||
<td rowspan="2">Timezone used<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>config_order</code></td>
|
||||
<td rowspan="2">Configure content order<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>config_gemoji</code></td>
|
||||
<td rowspan="2">Use GitHub custom emojis<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>config_display</code></td>
|
||||
<td rowspan="2">Render display width<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> regular<br>
|
||||
<b>allowed values:</b><ul><li>regular</li><li>large</li><li>columns</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>config_animations</code></td>
|
||||
<td rowspan="2">SVG CSS animations<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏭️ Global option<br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>config_padding</code></td>
|
||||
<td rowspan="2">Image padding<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> 0, 8 + 11%<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>config_output</code></td>
|
||||
<td rowspan="2">Output image format<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> auto<br>
|
||||
<b>allowed values:</b><ul><li>auto</li><li>svg</li><li>png</li><li>jpeg</li><li>json</li><li>markdown</li><li>markdown-pdf</li><li>insights</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>retries</code></td>
|
||||
<td rowspan="2">Number of retries<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 10)</i>
|
||||
<b>default:</b> 3<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 3600)</i>
|
||||
<b>default:</b> 300<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 10)</i>
|
||||
<b>default:</b> 5<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 3600)</i>
|
||||
<b>default:</b> 120<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 3600)</i>
|
||||
<b>default:</b> 0<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔧 For development
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>debug</code></td>
|
||||
<td rowspan="2">Debug logs<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔧 For development
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>verify</code></td>
|
||||
<td rowspan="2">Verify SVG<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔧 For development
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>debug_flags</code></td>
|
||||
<td rowspan="2">Debug flags<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔧 For development
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(space-separated)</i>
|
||||
<br>
|
||||
<b>allowed values:</b><ul><li>--cakeday</li><li>--hireable</li><li>--halloween</li><li>--error</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>dryrun</code></td>
|
||||
<td rowspan="2">Enable dry-run<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔧 For development
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>experimental_features</code></td>
|
||||
<td rowspan="2">Experimental features<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔧 For development
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(space-separated)</i>
|
||||
<br>
|
||||
<b>allowed values:</b><ul><li>--optimize-svg</li></ul></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔧 For development
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,15 +12,40 @@ The *discussions* plugin displays your GitHub discussions metrics.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_discussions` | `boolean` **[no]** | GitHub discussions metrics |
|
||||
| `plugin_discussions_categories` <sup>✨</sup> | `boolean` **[yes]** | Display discussion categories |
|
||||
| `plugin_discussions_categories_limit` <sup>✨</sup> | `number` **[0]** | Number of discussion categories to display |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ✨ Currently in beta-testing on `master`/`main`
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_discussions</code></td>
|
||||
<td rowspan="2">GitHub discussions metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_discussions_categories</code></td>
|
||||
<td rowspan="2">Display discussion categories<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<b>default:</b> 0<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -20,15 +20,41 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_followup` | `boolean` **[no]** | Display follow-up of repositories issues and pull requests |
|
||||
| `plugin_followup_sections` | `array` *(comma-separated)* **[repositories]** *{"repositories", "user"}* | Sections to display |
|
||||
| `plugin_followup_indepth` <sup>🧰</sup> | `boolean` **[no]** | Indepth follow-up processing |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🧰 Must be enabled in `settings.json` (for web instances)
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_followup</code></td>
|
||||
<td rowspan="2">Display follow-up of repositories issues and pull requests<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_followup_sections</code></td>
|
||||
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> repositories<br>
|
||||
<b>allowed values:</b><ul><li>repositories</li><li>user</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_followup_indepth</code></td>
|
||||
<td rowspan="2">Indepth follow-up processing<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,11 +12,20 @@ The *gists* plugin displays your [gists](https://gist.github.com) metrics.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_gists` | `boolean` **[no]** | Display gists metrics |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_gists</code></td>
|
||||
<td rowspan="2">Display gists metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -28,18 +28,72 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_habits` | `boolean` **[no]** | Display coding habits metrics |
|
||||
| `plugin_habits_from` | `number` **[200]** *{1 ≤ 𝑥 ≤ 1000}* | Number of events to use |
|
||||
| `plugin_habits_days` | `number` **[14]** *{1 ≤ 𝑥 ≤ 30}* | Maximum event age |
|
||||
| `plugin_habits_facts` | `boolean` **[yes]** | Display coding habits collected facts based on recent activity |
|
||||
| `plugin_habits_charts` <sup>🧰</sup> | `boolean` **[no]** | Display coding habits charts based on recent activity |
|
||||
| `plugin_habits_trim` | `boolean` **[no]** | Trim unused hours on daily chart |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🧰 Must be enabled in `settings.json` (for web instances)
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_habits</code></td>
|
||||
<td rowspan="2">Display coding habits metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 200<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_habits_days</code></td>
|
||||
<td rowspan="2">Maximum event age<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 30)</i>
|
||||
<b>default:</b> 14<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -18,12 +18,29 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_introduction` | `boolean` **[no]** | Display account or repository introduction |
|
||||
| `plugin_introduction_title` | `boolean` **[yes]** | Display introduction section title |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_introduction</code></td>
|
||||
<td rowspan="2">Display account or repository introduction<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -1,12 +1,78 @@
|
||||
<!--header-->
|
||||
<table>
|
||||
<tr><th colspan="2"><h3>📅 Isometric commit calendar</h3></th></tr>
|
||||
<tr><td colspan="2" align="center">This plugin displays an isometric view of your commit calendar along with a few additional statistics like current streak and average number of commit per day.</td></tr>
|
||||
<tr>
|
||||
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
|
||||
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/terminal"><code>📙 Terminal template</code></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>👤 Users</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>repo (optional)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" align="center">
|
||||
<details open><summary>Full year calendar</summary><img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg" alt=""></img></details>
|
||||
<details><summary>Half year calendar</summary><img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg" alt=""></img></details>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/header-->
|
||||
|
||||
## ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_isocalendar</code></td>
|
||||
<td rowspan="2">Enable isocalendar plugin<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_isocalendar_duration</code></td>
|
||||
<td rowspan="2">Time window<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> half-year<br>
|
||||
<b>allowed values:</b><ul><li>half-year</li><li>full-year</li></ul></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
## ℹ️ Examples workflows
|
||||
|
||||
<!--examples-->
|
||||
```yaml
|
||||
name: Half-year calendar
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.isocalendar.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_isocalendar: 'yes'
|
||||
|
||||
```
|
||||
```yaml
|
||||
name: Full-year calendar
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.isocalendar.fullyear.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_isocalendar: 'yes'
|
||||
plugin_isocalendar_duration: full-year
|
||||
|
||||
```
|
||||
<!--/examples-->
|
||||
|
||||
@@ -1,9 +1,200 @@
|
||||
<!--header-->
|
||||
<table>
|
||||
<tr><th colspan="2"><h3>🈷️ Most used languages</h3></th></tr>
|
||||
<tr><td colspan="2" align="center">This plugin can display which languages you use across all repositories you contributed to.</td></tr>
|
||||
<tr>
|
||||
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
|
||||
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a> <a href="/source/templates/terminal"><code>📙 Terminal template</code></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>repo (optional)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" align="center">
|
||||
<details open><summary>Indepth analysis (clone and analyze repositories)</summary><img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.indepth.svg" alt=""></img></details>
|
||||
<details open><summary>Recently used (analyze recent activity events)</summary><img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.recent.svg" alt=""></img></details>
|
||||
<details><summary>Default algorithm</summary><img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg" alt=""></img></details>
|
||||
<details><summary>Default algorithm (with details)</summary><img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg" alt=""></img></details>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/header-->
|
||||
|
||||
## ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages</code></td>
|
||||
<td rowspan="2">Enable languages plugin<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_ignored</code></td>
|
||||
<td rowspan="2">Ignored languages<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_skipped</code></td>
|
||||
<td rowspan="2">Skipped repositories<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_limit</code></td>
|
||||
<td rowspan="2">Display limit<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 8)</i>
|
||||
<b>default:</b> 8<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_threshold</code></td>
|
||||
<td rowspan="2">Display threshold (percentage)<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> 0%<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_colors</code></td>
|
||||
<td rowspan="2">Custom languages colors<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> github<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_aliases</code></td>
|
||||
<td rowspan="2">Custom languages names<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_sections</code></td>
|
||||
<td rowspan="2">Displayed sections<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> most-used<br>
|
||||
<b>allowed values:</b><ul><li>most-used</li><li>recently-used</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_details</code></td>
|
||||
<td rowspan="2">Additional details<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>allowed values:</b><ul><li>bytes-size</li><li>percentage</li><li>lines</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_indepth</code></td>
|
||||
<td rowspan="2">Indepth mode (⚠️ read documentation first)<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> false<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 30)</i>
|
||||
<b>default:</b> 15<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> markup, programming<br>
|
||||
<b>allowed values:</b><ul><li>data</li><li>markup</li><li>programming</li><li>prose</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_recent_categories</code></td>
|
||||
<td rowspan="2">Indepth mode - Displayed categories (recently-used section)<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> markup, programming<br>
|
||||
<b>allowed values:</b><ul><li>data</li><li>markup</li><li>programming</li><li>prose</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_languages_recent_load</code></td>
|
||||
<td rowspan="2">Events to load (recently-used section)<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(100 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 300<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 365)</i>
|
||||
<b>default:</b> 14<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
## 🔎 `indepth` mode
|
||||
@@ -136,4 +327,66 @@ To mitigate this, it is possible to use `plugin_languages_aliases` option and pr
|
||||
## ℹ️ Examples workflows
|
||||
|
||||
<!--examples-->
|
||||
```yaml
|
||||
name: Most used
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.languages.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_languages: 'yes'
|
||||
plugin_languages_ignored: >-
|
||||
html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
|
||||
gnuplot
|
||||
plugin_languages_limit: 4
|
||||
|
||||
```
|
||||
```yaml
|
||||
name: Most used (with details)
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.languages.details.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_languages: 'yes'
|
||||
plugin_languages_ignored: >-
|
||||
html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
|
||||
gnuplot
|
||||
plugin_languages_details: bytes-size, percentage
|
||||
plugin_languages_limit: 4
|
||||
|
||||
```
|
||||
```yaml
|
||||
name: Recently used
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.languages.recent.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_languages: 'yes'
|
||||
plugin_languages_ignored: >-
|
||||
html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
|
||||
gnuplot
|
||||
plugin_languages_sections: recently-used
|
||||
plugin_languages_details: bytes-size, percentage
|
||||
plugin_languages_limit: 4
|
||||
|
||||
```
|
||||
```yaml
|
||||
name: Indepth analysis
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
filename: metrics.plugin.languages.indepth.svg
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
base: ''
|
||||
plugin_languages: 'yes'
|
||||
plugin_languages_ignored: >-
|
||||
html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
|
||||
gnuplot
|
||||
plugin_languages_indepth: 'yes'
|
||||
plugin_languages_details: lines, bytes-size
|
||||
plugin_languages_limit: 4
|
||||
plugin_languages_analysis_timeout: 15
|
||||
|
||||
```
|
||||
<!--/examples-->
|
||||
|
||||
@@ -27,16 +27,47 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_licenses` <sup>🧰</sup> | `boolean` **[no]** | Display licenses informations |
|
||||
| `plugin_licenses_setup` | `string` **[]** | Command to setup target repository |
|
||||
| `plugin_licenses_ratio` | `boolean` **[no]** | Display used licenses ratio |
|
||||
| `plugin_licenses_legal` | `boolean` **[yes]** | Display legal informations about used licenses |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🧰 Must be enabled in `settings.json` (for web instances)
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_licenses</code></td>
|
||||
<td rowspan="2">Display licenses informations<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,14 +12,30 @@ The *lines* of code plugin displays the number of lines of code you have added a
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_lines` | `boolean` **[no]** | Display lines of code metrics |
|
||||
| `plugin_lines_skipped` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Repositories to skip |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ⏩ Value inherits from its related global-level option
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_lines</code></td>
|
||||
<td rowspan="2">Display lines of code metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_lines_skipped</code></td>
|
||||
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -208,22 +208,105 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_music` | `boolean` **[no]** | Display your music tracks |
|
||||
| `plugin_music_provider` | `string` **[]** *{"apple", "spotify", "lastfm", "youtube"}* | Music provider |
|
||||
| `plugin_music_token` <sup>🔐</sup> | `token` **[]** | Music provider personal token |
|
||||
| `plugin_music_mode` | `string` **[]** *{"playlist", "recent", "top"}* | Plugin mode |
|
||||
| `plugin_music_playlist` | `string` **[]** | Embed playlist url |
|
||||
| `plugin_music_limit` | `number` **[4]** *{1 ≤ 𝑥 ≤ 100}* | Maximum number of tracks to display |
|
||||
| `plugin_music_played_at` | `boolean` **[no]** | Display when the track was played |
|
||||
| `plugin_music_time_range` | `string` **[short]** *{"short", "medium", "long"}* | Time period for top mode |
|
||||
| `plugin_music_top_type` | `string` **[tracks]** *{"tracks", "artists"}* | Whether to show tracks or artists in top mode |
|
||||
| `plugin_music_user` | `string` **[*→ User login*]** | Music provider username |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_music</code></td>
|
||||
<td rowspan="2">Display your music tracks<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_music_provider</code></td>
|
||||
<td rowspan="2">Music provider<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>allowed values:</b><ul><li>apple</li><li>spotify</li><li>lastfm</li><li>youtube</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_music_token</code></td>
|
||||
<td rowspan="2">Music provider personal token<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_music_mode</code></td>
|
||||
<td rowspan="2">Plugin mode<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>allowed values:</b><ul><li>playlist</li><li>recent</li><li>top</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_music_playlist</code></td>
|
||||
<td rowspan="2">Embed playlist url<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 100)</i>
|
||||
<b>default:</b> 4<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> short<br>
|
||||
<b>allowed values:</b><ul><li>short</li><li>medium</li><li>long</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_music_top_type</code></td>
|
||||
<td rowspan="2">Whether to show tracks or artists in top mode<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> tracks<br>
|
||||
<b>allowed values:</b><ul><li>tracks</li><li>artists</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_music_user</code></td>
|
||||
<td rowspan="2">Music provider username<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> <code>→ User login</code><br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -19,17 +19,84 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_nightscout` | `boolean` **[no]** | Displays Blood Glucose |
|
||||
| `plugin_nightscout_url` | `string` **[https://example.herokuapp.com]** | Your Nightscout site URL |
|
||||
| `plugin_nightscout_datapoints` | `number` **[12]** *{0 ≤ 𝑥}* | How many datapoints to show on the graph. 0 and 1 disable the graph. |
|
||||
| `plugin_nightscout_lowalert` | `number` **[80]** *{0 ≤ 𝑥}* | When the blood sugar is considered low |
|
||||
| `plugin_nightscout_highalert` | `number` **[180]** *{0 ≤ 𝑥}* | When the blood sugar is considered high |
|
||||
| `plugin_nightscout_urgentlowalert` | `number` **[50]** *{0 ≤ 𝑥}* | When the blood sugar is considered urgently low |
|
||||
| `plugin_nightscout_urgenthighalert` | `number` **[250]** *{0 ≤ 𝑥}* | When the blood sugar is considered urgently high |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_nightscout</code></td>
|
||||
<td rowspan="2">Displays Blood Glucose<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> https://example.herokuapp.com<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 12<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 80<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 180<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 50<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 250<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -24,17 +24,57 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_notable` | `boolean` **[no]** | Display notable contributions in organizations |
|
||||
| `plugin_notable_filter` | `string` **[]** | Query filter |
|
||||
| `plugin_notable_from` | `string` **[organization]** *{"all", "organization", "user"}* | Filter by repository host account type |
|
||||
| `plugin_notable_repositories` | `boolean` **[no]** | Also display repository name |
|
||||
| `plugin_notable_indepth` <sup>🧰</sup> | `boolean` **[no]** | Indepth notable contributions processing |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🧰 Must be enabled in `settings.json` (for web instances)
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_notable</code></td>
|
||||
<td rowspan="2">Display notable contributions in organizations<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_notable_filter</code></td>
|
||||
<td rowspan="2">Query filter<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> organization<br>
|
||||
<b>allowed values:</b><ul><li>all</li><li>organization</li><li>user</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_notable_repositories</code></td>
|
||||
<td rowspan="2">Also display repository name<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -29,17 +29,56 @@ Expect 10 to 30 seconds to generate the results.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_pagespeed` | `boolean` **[no]** | Display a website Google PageSpeed metrics |
|
||||
| `plugin_pagespeed_url` | `string` **[*→ User attached website*]** | Audited website |
|
||||
| `plugin_pagespeed_detailed` | `boolean` **[no]** | Detailed audit result |
|
||||
| `plugin_pagespeed_screenshot` | `boolean` **[no]** | Display a screenshot of your website |
|
||||
| `plugin_pagespeed_token` <sup>🔐</sup> | `token` **[]** | PageSpeed token |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_pagespeed</code></td>
|
||||
<td rowspan="2">Display a website Google PageSpeed metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_pagespeed_url</code></td>
|
||||
<td rowspan="2">Audited website<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> <code>→ User attached website</code><br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_pagespeed_detailed</code></td>
|
||||
<td rowspan="2">Detailed audit result<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_pagespeed_token</code></td>
|
||||
<td rowspan="2">PageSpeed token<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -36,18 +36,90 @@ Sections will be ordered the same as specified in `plugin_people_types`.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_people` | `boolean` **[no]** | Display GitHub users from various affiliations |
|
||||
| `plugin_people_limit` | `number` **[24]** *{0 ≤ 𝑥}* | Maximum number of user to display |
|
||||
| `plugin_people_size` | `number` **[28]** *{8 ≤ 𝑥 ≤ 64}* | Size of displayed GitHub users' avatars |
|
||||
| `plugin_people_types` | `array` *(comma-separated)* **[followers, following]** *{"followers", "following", "followed", "sponsoring", "members", "sponsored", "sponsors", "contributors", "stargazers", "watchers", "thanks"}* | Affiliations to display |
|
||||
| `plugin_people_thanks` | `array` *(comma-separated)* **[]** | GitHub users to personally thanks |
|
||||
| `plugin_people_sponsors_custom` | `array` *(comma-separated)* **[]** | Custom GitHub sponsors |
|
||||
| `plugin_people_identicons` | `boolean` **[no]** | Use identicons instead of avatars |
|
||||
| `plugin_people_shuffle` | `boolean` **[no]** | Shuffle users |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_people</code></td>
|
||||
<td rowspan="2">Display GitHub users from various affiliations<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 24<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(8 ≤
|
||||
𝑥
|
||||
≤ 64)</i>
|
||||
<b>default:</b> 28<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_people_types</code></td>
|
||||
<td rowspan="2">Affiliations to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> followers, following<br>
|
||||
<b>allowed values:</b><ul><li>followers</li><li>following</li><li>followed</li><li>sponsoring</li><li>members</li><li>sponsored</li><li>sponsors</li><li>contributors</li><li>stargazers</li><li>watchers</li><li>thanks</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_people_thanks</code></td>
|
||||
<td rowspan="2">GitHub users to personally thanks<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_people_shuffle</code></td>
|
||||
<td rowspan="2">Shuffle users<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -42,15 +42,39 @@ You now have your PoopMap token! This token will not expire and it can only acce
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_poopmap` | `boolean` **[no]** | Display PoopMap stats |
|
||||
| `plugin_poopmap_token` <sup>🔐</sup> | `token` **[]** | PoopMap API token |
|
||||
| `plugin_poopmap_days` | `number` **[7]** *{"7", "30", "180", "365"}* | PoopMap time range |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_poopmap</code></td>
|
||||
<td rowspan="2">Display PoopMap stats<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_poopmap_token</code></td>
|
||||
<td rowspan="2">PoopMap API token<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_poopmap_days</code></td>
|
||||
<td rowspan="2">PoopMap time range<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<b>default:</b> 7<br>
|
||||
<b>allowed values:</b><ul><li>7</li><li>30</li><li>180</li><li>365</li></ul></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -17,16 +17,68 @@ The recent *posts* plugin displays recent articles you wrote on an external sour
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_posts` | `boolean` **[no]** | Display recent posts |
|
||||
| `plugin_posts_source` | `string` **[]** *{"dev.to", "hashnode"}* | Posts external source |
|
||||
| `plugin_posts_descriptions` | `boolean` **[no]** | Display posts descriptions |
|
||||
| `plugin_posts_covers` | `boolean` **[no]** | Display posts cover images |
|
||||
| `plugin_posts_limit` | `number` **[4]** *{1 ≤ 𝑥 ≤ 30}* | Maximum number of posts to display |
|
||||
| `plugin_posts_user` | `string` **[*→ User login*]** | Posts external source username |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_posts</code></td>
|
||||
<td rowspan="2">Display recent posts<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_posts_source</code></td>
|
||||
<td rowspan="2">Posts external source<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>allowed values:</b><ul><li>dev.to</li><li>hashnode</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_posts_descriptions</code></td>
|
||||
<td rowspan="2">Display posts descriptions<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 30)</i>
|
||||
<b>default:</b> 4<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> <code>→ User login</code><br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -43,14 +43,50 @@ To do so, open your repository project and retrieve the last URL endpoint, in th
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_projects` | `boolean` **[no]** | Display active projects |
|
||||
| `plugin_projects_limit` | `number` **[4]** *{0 ≤ 𝑥 ≤ 100}* | Maximum number of projects to display |
|
||||
| `plugin_projects_repositories` | `array` *(comma-separated)* **[]** | List of repository project identifiers to disaplay |
|
||||
| `plugin_projects_descriptions` | `boolean` **[no]** | Display projects descriptions |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_projects</code></td>
|
||||
<td rowspan="2">Display active projects<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 100)</i>
|
||||
<b>default:</b> 4<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_projects_descriptions</code></td>
|
||||
<td rowspan="2">Display projects descriptions<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,21 +12,109 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_reactions` | `boolean` **[no]** | Display average issue comments reactions |
|
||||
| `plugin_reactions_limit` | `number` **[200]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of issue comments to parse |
|
||||
| `plugin_reactions_limit_issues` | `number` **[100]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of issues and pull requests opened to parse |
|
||||
| `plugin_reactions_limit_discussions` | `number` **[100]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of discussions opened to parse |
|
||||
| `plugin_reactions_limit_discussions_comments` | `number` **[100]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of discussions comments opened to parse |
|
||||
| `plugin_reactions_days` | `number` **[0]** *{0 ≤ 𝑥}* | Maximum comments age |
|
||||
| `plugin_reactions_display` | `string` **[absolute]** *{"absolute", "relative"}* | Display mode |
|
||||
| `plugin_reactions_details` | `array` *(comma-separated)* **[]** *{"count", "percentage"}* | Additional details |
|
||||
| `plugin_reactions_ignored` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Users to ignore |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ⏩ Value inherits from its related global-level option
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_reactions</code></td>
|
||||
<td rowspan="2">Display average issue comments reactions<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 200<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 100<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 100<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 1000)</i>
|
||||
<b>default:</b> 100<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_reactions_days</code></td>
|
||||
<td rowspan="2">Maximum comments age<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 0<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_reactions_display</code></td>
|
||||
<td rowspan="2">Display mode<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> absolute<br>
|
||||
<b>allowed values:</b><ul><li>absolute</li><li>relative</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_reactions_details</code></td>
|
||||
<td rowspan="2">Additional details<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>allowed values:</b><ul><li>count</li><li>percentage</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_reactions_ignored</code></td>
|
||||
<td rowspan="2">Users to ignore<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>users_ignored</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -16,12 +16,29 @@ Because of limitations of using SVG inside of `<img>` tags, people won't be able
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_repositories` | `boolean` **[no]** | Display chosen featured repositories |
|
||||
| `plugin_repositories_featured` | `array` *(comma-separated)* **[]** | List of repositories to display |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_repositories</code></td>
|
||||
<td rowspan="2">Display chosen featured repositories<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,13 +12,40 @@ The *rss* plugin displays items from a specified RSS feed.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_rss` | `boolean` **[no]** | Display RSS feed |
|
||||
| `plugin_rss_source` | `string` **[]** | RSS feed source |
|
||||
| `plugin_rss_limit` | `number` **[4]** *{0 ≤ 𝑥 ≤ 30}* | Maximum number of items to display |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_rss</code></td>
|
||||
<td rowspan="2">Display RSS feed<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_rss_source</code></td>
|
||||
<td rowspan="2">RSS feed source<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 30)</i>
|
||||
<b>default:</b> 4<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -13,15 +13,55 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_screenshot` | `boolean` **[no]** | Display a screenshot of any website |
|
||||
| `plugin_screenshot_title` | `string` **[Screenshot]** | Screenshot title caption |
|
||||
| `plugin_screenshot_url` | `string` **[]** | Website to take screenshot |
|
||||
| `plugin_screenshot_selector` | `string` **[body]** | Selector to take in screenshot |
|
||||
| `plugin_screenshot_background` | `boolean` **[yes]** | Display or remove default page background |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_screenshot</code></td>
|
||||
<td rowspan="2">Display a screenshot of any website<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_screenshot_title</code></td>
|
||||
<td rowspan="2">Screenshot title caption<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> Screenshot<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> body<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -16,15 +16,64 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_skyline` | `boolean` **[no]** | Display GitHub Skyline 3D calendar |
|
||||
| `plugin_skyline_year` | `number` **[current-year]** *{2008 ≤ 𝑥}* | Displayed year |
|
||||
| `plugin_skyline_frames` | `number` **[60]** *{1 ≤ 𝑥 ≤ 120}* | Number of frames |
|
||||
| `plugin_skyline_quality` | `number` **[0.5]** *{0.1 ≤ 𝑥 ≤ 1}* | Image quality |
|
||||
| `plugin_skyline_compatibility` | `boolean` **[no]** | Compatibility mode |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_skyline</code></td>
|
||||
<td rowspan="2">Display GitHub Skyline 3D calendar<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_skyline_year</code></td>
|
||||
<td rowspan="2">Displayed year<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(2008 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> current-year<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_skyline_frames</code></td>
|
||||
<td rowspan="2">Number of frames<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 120)</i>
|
||||
<b>default:</b> 60<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_skyline_quality</code></td>
|
||||
<td rowspan="2">Image quality<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0.1 ≤
|
||||
𝑥
|
||||
≤ 1)</i>
|
||||
<b>default:</b> 0.5<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_skyline_compatibility</code></td>
|
||||
<td rowspan="2">Compatibility mode<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -17,12 +17,31 @@ The *sponsors* plugin lets you display your sponsors and introduction text from
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_sponsors` | `boolean` **[no]** | Display GitHub sponsors |
|
||||
| `plugin_sponsors_sections` | `array` *(comma-separated)* **[goal, about]** *{"goal", "about"}* | Sections to display |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_sponsors</code></td>
|
||||
<td rowspan="2">Display GitHub sponsors<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_sponsors_sections</code></td>
|
||||
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> goal, about<br>
|
||||
<b>allowed values:</b><ul><li>goal</li><li>about</li></ul></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -23,16 +23,74 @@ Your user id will be in both url and search bar.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_stackoverflow` | `boolean` **[no]** | Stackoverflow metrics |
|
||||
| `plugin_stackoverflow_user` | `number` **[0]** | Stackoverflow user id |
|
||||
| `plugin_stackoverflow_sections` | `array` *(comma-separated)* **[answers-top, questions-recent]** *{"answers-top", "answers-recent", "questions-top", "questions-recent"}* | Sections to display |
|
||||
| `plugin_stackoverflow_limit` | `number` **[2]** *{1 ≤ 𝑥 ≤ 30}* | Maximum number of entries to display per section |
|
||||
| `plugin_stackoverflow_lines` | `number` **[4]** *{0 ≤ 𝑥}* | Maximum number of lines to display per question or answer |
|
||||
| `plugin_stackoverflow_lines_snippet` | `number` **[2]** *{0 ≤ 𝑥}* | Maximum number of lines to display per code snippet |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stackoverflow</code></td>
|
||||
<td rowspan="2">Stackoverflow metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stackoverflow_user</code></td>
|
||||
<td rowspan="2">Stackoverflow user id<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<b>default:</b> 0<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stackoverflow_sections</code></td>
|
||||
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br>
|
||||
<b>default:</b> answers-top, questions-recent<br>
|
||||
<b>allowed values:</b><ul><li>answers-top</li><li>answers-recent</li><li>questions-top</li><li>questions-recent</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stackoverflow_limit</code></td>
|
||||
<td rowspan="2">Maximum number of entries to display per section<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 30)</i>
|
||||
<b>default:</b> 2<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 4<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 2<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,11 +12,20 @@ The *stargazers* plugin displays your stargazers evolution across all of your re
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_stargazers` | `boolean` **[no]** | Display stargazers metrics |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stargazers</code></td>
|
||||
<td rowspan="2">Display stargazers metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,18 +12,77 @@ The *starlists* plugin displays your recently star lists.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_starlists` <sup>✨</sup> | `boolean` **[no]** | Display star lists |
|
||||
| `plugin_starlists_limit` <sup>✨</sup> | `number` **[2]** *{1 ≤ 𝑥 ≤ 100}* | Number of star lists to display |
|
||||
| `plugin_starlists_limit_repositories` <sup>✨</sup> | `number` **[2]** *{0 ≤ 𝑥 ≤ 100}* | Number of repositories to display per star lists |
|
||||
| `plugin_starlists_shuffle_repositories` <sup>✨</sup> | `boolean` **[yes]** | Shuffle displayed repositories |
|
||||
| `plugin_starlists_ignored` <sup>✨</sup> | `array` *(comma-separated)* **[]** | Star lists to skip |
|
||||
| `plugin_starlists_only` <sup>✨</sup> | `array` *(comma-separated)* **[]** | Star lists to display |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ✨ Currently in beta-testing on `master`/`main`
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_starlists</code></td>
|
||||
<td rowspan="2">Display star lists<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 100)</i>
|
||||
<b>default:</b> 2<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 100)</i>
|
||||
<b>default:</b> 2<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> yes<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_starlists_only</code></td>
|
||||
<td rowspan="2">Star lists to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -12,12 +12,32 @@ The *stars* plugin displays your recently starred repositories.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_stars` | `boolean` **[no]** | Display recently starred repositories |
|
||||
| `plugin_stars_limit` | `number` **[4]** *{1 ≤ 𝑥 ≤ 100}* | Maximum number of stars to display |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stars</code></td>
|
||||
<td rowspan="2">Display recently starred repositories<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 100)</i>
|
||||
<b>default:</b> 4<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -21,17 +21,57 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_stock` | `boolean` **[no]** | Display stock prices of a given company |
|
||||
| `plugin_stock_token` <sup>🔐</sup> | `token` **[]** | Yahoo Finance token |
|
||||
| `plugin_stock_symbol` | `string` **[]** | Company stock symbol |
|
||||
| `plugin_stock_duration` | `string` **[1d]** *{"1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"}* | Time range to display |
|
||||
| `plugin_stock_interval` | `string` **[5m]** *{"1m", "2m", "5m", "15m", "60m", "1d"}* | Time intervals between records |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stock</code></td>
|
||||
<td rowspan="2">Display stock prices of a given company<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stock_token</code></td>
|
||||
<td rowspan="2">Yahoo Finance token<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stock_symbol</code></td>
|
||||
<td rowspan="2">Company stock symbol<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> 1d<br>
|
||||
<b>allowed values:</b><ul><li>1d</li><li>5d</li><li>1mo</li><li>3mo</li><li>6mo</li><li>1y</li><li>2y</li><li>5y</li><li>10y</li><li>ytd</li><li>max</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_stock_interval</code></td>
|
||||
<td rowspan="2">Time intervals between records<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> 5m<br>
|
||||
<b>allowed values:</b><ul><li>1m</li><li>2m</li><li>5m</li><li>15m</li><li>60m</li><li>1d</li></ul></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -14,11 +14,20 @@ An account on [GitHub Support Community](https://github.community/) is required
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_support` | `boolean` **[no]** | GitHub Community Support metrics |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_support</code></td>
|
||||
<td rowspan="2">GitHub Community Support metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -20,14 +20,52 @@ This uses puppeteer to navigate through your starred topics page.
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_topics` | `boolean` **[no]** | Display starred topics |
|
||||
| `plugin_topics_mode` | `string` **[starred]** *{"starred", "icons", "mastered"}* | Plugin mode |
|
||||
| `plugin_topics_sort` | `string` **[stars]** *{"stars", "activity", "starred", "random"}* | Sorting method of starred topics |
|
||||
| `plugin_topics_limit` | `number` **[15]** *{0 ≤ 𝑥 ≤ 20}* | Maximum number of topics to display |
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_topics</code></td>
|
||||
<td rowspan="2">Display starred topics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_topics_mode</code></td>
|
||||
<td rowspan="2">Plugin mode<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> starred<br>
|
||||
<b>allowed values:</b><ul><li>starred</li><li>icons</li><li>mastered</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_topics_sort</code></td>
|
||||
<td rowspan="2">Sorting method of starred topics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> stars<br>
|
||||
<b>allowed values:</b><ul><li>stars</li><li>activity</li><li>starred</li><li>random</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_topics_limit</code></td>
|
||||
<td rowspan="2">Maximum number of topics to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥
|
||||
≤ 20)</i>
|
||||
<b>default:</b> 15<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -17,14 +17,30 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_traffic` | `boolean` **[no]** | Display repositories traffic metrics |
|
||||
| `plugin_traffic_skipped` <sup>⏩</sup> | `array` *(comma-separated)* **[]** | Repositories to skip |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* ⏩ Value inherits from its related global-level option
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_traffic</code></td>
|
||||
<td rowspan="2">Display repositories traffic metrics<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_traffic_skipped</code></td>
|
||||
<td rowspan="2">Repositories to skip<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">⏩ Inherits <code>repositories_skipped</code><br>
|
||||
<b>type:</b> <code>array</code>
|
||||
<i>(comma-separated)</i>
|
||||
<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -29,17 +29,59 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_tweets` | `boolean` **[no]** | Display recent tweets |
|
||||
| `plugin_tweets_token` <sup>🔐</sup> | `token` **[]** | Twitter API token |
|
||||
| `plugin_tweets_attachments` | `boolean` **[no]** | Display tweets attchments |
|
||||
| `plugin_tweets_limit` | `number` **[2]** *{1 ≤ 𝑥 ≤ 10}* | Maximum number of tweets to display |
|
||||
| `plugin_tweets_user` | `string` **[*→ User attached twitter*]** | Twitter username |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_tweets</code></td>
|
||||
<td rowspan="2">Display recent tweets<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_tweets_token</code></td>
|
||||
<td rowspan="2">Twitter API token<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_tweets_attachments</code></td>
|
||||
<td rowspan="2">Display tweets attchments<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(1 ≤
|
||||
𝑥
|
||||
≤ 10)</i>
|
||||
<b>default:</b> 2<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_tweets_user</code></td>
|
||||
<td rowspan="2">Twitter username<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> <code>→ User attached twitter</code><br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -23,19 +23,78 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
|
||||
#### ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
|
||||
| ------ | -------------------------------- | ----------- |
|
||||
| `plugin_wakatime` | `boolean` **[no]** | Display WakaTime stats |
|
||||
| `plugin_wakatime_token` <sup>🔐</sup> | `token` **[]** | WakaTime API token |
|
||||
| `plugin_wakatime_days` | `string` **[7]** *{"7", "30", "180", "365"}* | WakaTime time range |
|
||||
| `plugin_wakatime_sections` | `array` **[time, projects, projects-graphs, languages, languages-graphs, editors, os]** *{"time", "projects", "projects-graphs", "languages", "languages-graphs", "editors", "editors-graphs", "os", "os-graphs"}* | Sections to display |
|
||||
| `plugin_wakatime_limit` | `number` **[5]** *{0 ≤ 𝑥}* | Maximum number of entries to display per graph |
|
||||
| `plugin_wakatime_url` | `string` **[https://wakatime.com]** | Address where to reach your Wakatime instance |
|
||||
| `plugin_wakatime_user` | `string` **[current]** | Your Wakatime user on the selfhosted Wakapi instance |
|
||||
|
||||
|
||||
Legend for option icons:
|
||||
* 🔐 Value should be stored in repository secrets
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_wakatime</code></td>
|
||||
<td rowspan="2">Display WakaTime stats<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||||
<br>
|
||||
<b>default:</b> no<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_wakatime_token</code></td>
|
||||
<td rowspan="2">WakaTime API token<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">🔐 Token<br>
|
||||
<b>type:</b> <code>token</code>
|
||||
<br></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_wakatime_days</code></td>
|
||||
<td rowspan="2">WakaTime time range<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> 7<br>
|
||||
<b>allowed values:</b><ul><li>7</li><li>30</li><li>180</li><li>365</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_wakatime_sections</code></td>
|
||||
<td rowspan="2">Sections to display<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||||
<br>
|
||||
<b>default:</b> time, projects, projects-graphs, languages, languages-graphs, editors, os<br>
|
||||
<b>allowed values:</b><ul><li>time</li><li>projects</li><li>projects-graphs</li><li>languages</li><li>languages-graphs</li><li>editors</li><li>editors-graphs</li><li>os</li><li>os-graphs</li></ul></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_wakatime_limit</code></td>
|
||||
<td rowspan="2">Maximum number of entries to display per graph<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<i>(0 ≤
|
||||
𝑥)</i>
|
||||
<b>default:</b> 5<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> https://wakatime.com<br></td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||||
<br>
|
||||
<b>default:</b> current<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
@@ -7,10 +7,10 @@
|
||||
<td><a href="/source/plugins/achievements" title="🏆 Achievements">🏆</a> <a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/anilist" title="🌸 Anilist watch list and reading list">🌸</a> <a href="/source/plugins/code" title="♐ Code snippet of the day">♐</a> <a href="/source/plugins/discussions" title="💬 Discussions">💬</a> <a href="/source/plugins/followup" title="🎟️ Follow-up of issues and pull requests">🎟️</a> <a href="/source/plugins/gists" title="🎫 Gists">🎫</a> <a href="/source/plugins/habits" title="💡 Coding habits">💡</a> <a href="/source/plugins/introduction" title="🙋 Introduction">🙋</a> <a href="/source/plugins/isocalendar" title="📅 Isometric commit calendar">📅</a> <a href="/source/plugins/languages" title="🈷️ Most used languages">🈷️</a> <a href="/source/plugins/lines" title="👨💻 Lines of code changed">👨💻</a> <a href="/source/plugins/music" title="🎼 Music plugin">🎼</a> <a href="/source/plugins/nightscout" title="💉 Nightscout">💉</a> <a href="/source/plugins/notable" title="🎩 Notable contributions">🎩</a> <a href="/source/plugins/pagespeed" title="⏱️ Website performances">⏱️</a> <a href="/source/plugins/people" title="🧑🤝🧑 People plugin">🧑🤝🧑</a> <a href="/source/plugins/poopmap" title="💩 PoopMap plugin">💩</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/projects" title="🗂️ Active projects">🗂️</a> <a href="/source/plugins/reactions" title="🎭 Comment reactions">🎭</a> <a href="/source/plugins/repositories" title="📓 Repositories">📓</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/screenshot" title="📸 Website screenshot">📸</a> <a href="/source/plugins/skyline" title="🌇 GitHub Skyline 3D calendar">🌇</a> <a href="/source/plugins/sponsors" title="💕 GitHub Sponsors">💕</a> <a href="/source/plugins/stackoverflow" title="🗨️ Stackoverflow plugin">🗨️</a> <a href="/source/plugins/stargazers" title="✨ Stargazers over last weeks">✨</a> <a href="/source/plugins/starlists" title="💫 Starlists">💫</a> <a href="/source/plugins/stars" title="🌟 Recently starred repositories">🌟</a> <a href="/source/plugins/stock" title="💹 Stock prices">💹</a> <a href="/source/plugins/support" title="💭 GitHub Community Support">💭</a> <a href="/source/plugins/topics" title="📌 Starred topics">📌</a> <a href="/source/plugins/traffic" title="🧮 Repositories traffic">🧮</a> <a href="/source/plugins/tweets" title="🐤 Latest tweets">🐤</a> <a href="/source/plugins/wakatime" title="⏰ WakaTime plugin">⏰</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>👤 Users, 👥 Organizations</td>
|
||||
<td><code>👤 Users</code> <code>👥 Organizations</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>*️⃣ SVG, *️⃣ PNG, *️⃣ JPEG, #️⃣ JSON</td>
|
||||
<td><code>*️⃣ SVG</code> <code>*️⃣ PNG</code> <code>*️⃣ JPEG</code> <code>#️⃣ JSON</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" align="center">
|
||||
|
||||
@@ -7,10 +7,10 @@
|
||||
<td><a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/topics" title="📌 Starred topics">📌</a> <a href="/source/plugins/tweets" title="🐤 Latest tweets">🐤</a> <code>✓ embed()</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>👤 Users, 👥 Organizations</td>
|
||||
<td><code>👤 Users</code> <code>👥 Organizations</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>#️⃣ JSON, 🔠 Markdown, 🔠 Markdown (PDF)</td>
|
||||
<td><code>#️⃣ JSON</code> <code>🔠 Markdown</code> <code>🔠 Markdown (PDF)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" align="center">
|
||||
|
||||
@@ -7,10 +7,10 @@
|
||||
<td><a href="/source/plugins/activity" title="📰 Recent activity">📰</a> <a href="/source/plugins/contributors" title="🏅 Repository contributors">🏅</a> <a href="/source/plugins/followup" title="🎟️ Follow-up of issues and pull requests">🎟️</a> <a href="/source/plugins/introduction" title="🙋 Introduction">🙋</a> <a href="/source/plugins/languages" title="🈷️ Most used languages">🈷️</a> <a href="/source/plugins/licenses" title="📜 Repository licenses">📜</a> <a href="/source/plugins/lines" title="👨💻 Lines of code changed">👨💻</a> <a href="/source/plugins/pagespeed" title="⏱️ Website performances">⏱️</a> <a href="/source/plugins/people" title="🧑🤝🧑 People plugin">🧑🤝🧑</a> <a href="/source/plugins/posts" title="✒️ Recent posts">✒️</a> <a href="/source/plugins/projects" title="🗂️ Active projects">🗂️</a> <a href="/source/plugins/rss" title="🗼 Rss feed">🗼</a> <a href="/source/plugins/screenshot" title="📸 Website screenshot">📸</a> <a href="/source/plugins/sponsors" title="💕 GitHub Sponsors">💕</a> <a href="/source/plugins/stargazers" title="✨ Stargazers over last weeks">✨</a> <a href="/source/plugins/stock" title="💹 Stock prices">💹</a> <a href="/source/plugins/traffic" title="🧮 Repositories traffic">🧮</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>📓 Repositories</td>
|
||||
<td><code>📓 Repositories</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>*️⃣ SVG, *️⃣ PNG, *️⃣ JPEG, #️⃣ JSON</td>
|
||||
<td><code>*️⃣ SVG</code> <code>*️⃣ PNG</code> <code>*️⃣ JPEG</code> <code>#️⃣ JSON</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" align="center">
|
||||
|
||||
@@ -7,10 +7,10 @@
|
||||
<td><a href="/source/plugins/gists" title="🎫 Gists">🎫</a> <a href="/source/plugins/isocalendar" title="📅 Isometric commit calendar">📅</a> <a href="/source/plugins/languages" title="🈷️ Most used languages">🈷️</a> <a href="/source/plugins/lines" title="👨💻 Lines of code changed">👨💻</a> <a href="/source/plugins/pagespeed" title="⏱️ Website performances">⏱️</a> <a href="/source/plugins/screenshot" title="📸 Website screenshot">📸</a> <a href="/source/plugins/traffic" title="🧮 Repositories traffic">🧮</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>👤 Users, 👥 Organizations</td>
|
||||
<td><code>👤 Users</code> <code>👥 Organizations</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>*️⃣ SVG, *️⃣ PNG, *️⃣ JPEG, #️⃣ JSON</td>
|
||||
<td><code>*️⃣ SVG</code> <code>*️⃣ PNG</code> <code>*️⃣ JPEG</code> <code>#️⃣ JSON</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" align="center">
|
||||
|
||||
Reference in New Issue
Block a user