Skip to content

Commit

Permalink
ci: auto-regenerate files [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
lowlighter committed Jan 15, 2022
1 parent 696041e commit e4064ba
Show file tree
Hide file tree
Showing 47 changed files with 2,680 additions and 451 deletions.
39 changes: 14 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build, test, analyze and publish](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml) [![Metrics (examples)](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml/badge.svg)](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml)

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>
Expand All @@ -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>
Expand Down Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions settings.example.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions source/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
83 changes: 72 additions & 11 deletions source/plugins/achievements/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)*
Expand Down
114 changes: 99 additions & 15 deletions source/plugins/activity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)*
Expand Down
87 changes: 76 additions & 11 deletions source/plugins/anilist/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)*
Expand Down
Loading

0 comments on commit e4064ba

Please sign in to comment.