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

doc(plugins/anilist): update

Browse Source
This commit is contained in:
lowlighter
2022-01-15 19:25:21 -05:00
parent ae8a76de9c
commit 1007e25d35
2 changed files with 62 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,31 +1,30 @@
### 🌸 Anilist watch list and reading list"
The *anilist* plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account.
<!--header-->
<table>
<td align="center">
<details open><summary>For anime watchers</summary>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg">
</details>
<details><summary>For manga readers</summary>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg">
</details>
<details open><summary>Favorites characters</summary>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg">
</details>
<img width="900" height="1" alt="">
</td>
<tr><th colspan="2"><h3>🌸 Anilist watch list and reading list</h3></th></tr>
<tr><td colspan="2" align="center"><p>This plugin lets you display your favorites animes, mangas and characters from your <a href="https://anilist.co">AniList</a> account.</p>
</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></td>
</tr>
<tr>
<td><code>👤 Users</code> <code>👥 Organizations</code></td>
</tr>
<tr>
<td><i>No tokens are required for this plugin</i></td>
</tr>
<tr>
<td colspan="2" align="center">
<details open><summary>For anime watchers</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg" alt=""></img></details>
<details open><summary>For manga readers</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg" alt=""></img></details>
<details open><summary>For waifus simp</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg" alt=""></img></details>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
This plugin is composed of the following sections, which can be displayed or hidden through `plugin_anilist_sections` option:
- `favorites` will display your favorites mangas and animes
- `watching` will display animes currently in your watching list
- `reading` will display manga currently in your reading list
- `characters` will display characters you liked
These sections can also be filtered by media type, which can be either `anime`, `manga` or both.
#### ➡️ Available options
## ➡️ Available options
<!--options-->
<table>
@@ -34,7 +33,7 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist</code></td>
<td rowspan="2"><p>Display data from your AniList account</p>
<td rowspan="2"><p>Enable aniList plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -44,7 +43,7 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_medias</code></td>
<td rowspan="2"><p>Medias types to display</p>
<td rowspan="2"><p>Display medias types</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -56,7 +55,13 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_sections</code></td>
<td rowspan="2"><p>Sections to display</p>
<td rowspan="2"><p>Displayed sections</p>
<ul>
<li><code>favorites</code> will display favorites <code>plugin_anilist_medias</code></li>
<li><code>watching</code> will display animes currently in watching list</li>
<li><code>reading</code> will display manga currently in reading list</li>
<li><code>characters</code> will display liked characters</li>
</ul>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -68,7 +73,7 @@ These sections can also be filtered by media type, which can be either `anime`,
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_limit</code></td>
<td rowspan="2"><p>Maximum number of entries to display per section</p>
<td rowspan="2"><p>Display limit (medias)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -76,11 +81,12 @@ These sections can also be filtered by media type, which can be either `anime`,
<i>(0 ≤
𝑥)</i>
<br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 2<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_limit_characters</code></td>
<td rowspan="2"><p>Maximum number of entries to display in characters section</p>
<td rowspan="2"><p>Display limit (characters)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -88,11 +94,12 @@ These sections can also be filtered by media type, which can be either `anime`,
<i>(0 ≤
𝑥)</i>
<br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 22<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_anilist_shuffle</code></td>
<td rowspan="2"><p>Shuffle AniList data</p>
<td rowspan="2"><p>Shuffle data for varied outputs</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -113,9 +120,7 @@ These sections can also be filtered by media type, which can be either `anime`,
</table>
<!--/options-->
*[→ Full specification](metadata.yml)*
#### ℹ️ Examples workflows
## ℹ️ Examples workflows
<!--examples-->
```yaml

42
source/plugins/anilist/metadata.yml
View File

@@ -1,5 +1,10 @@
name: "🌸 Anilist watch list and reading list"
category: social
description: This plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account.
examples:
+for anime watchers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg
+for manga readers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg
+for waifus simp: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg
index: 4
supports:
- user
@@ -7,15 +12,13 @@ supports:
scopes: []
inputs:
# Enable or disable plugin
plugin_anilist:
description: Display data from your AniList account
description: Enable aniList plugin
type: boolean
default: no
# Types of medias to display
plugin_anilist_medias:
description: Medias types to display
description: Display medias types
type: array
format: comma-separated
default: anime, manga
@@ -23,43 +26,42 @@ inputs:
- anime
- manga
# Sections to display
# Values from "plugin_anilist_medias" may impact displayed sections
plugin_anilist_sections:
description: Sections to display
description: |
Displayed sections
- `favorites` will display favorites `plugin_anilist_medias`
- `watching` will display animes currently in watching list
- `reading` will display manga currently in reading list
- `characters` will display liked characters
type: array
format: comma-separated
default: favorites
example: favorites, watching, characters
values:
- favorites # Favorites animes and mangas (depending on plugin_anilist_medias values)
- watching # Animes in your watching list
- reading # Mangas in your reading list
- characters # Favorites characters
- favorites
- watching
- reading
- characters
# Number of entries to display per section (this does not impacts characters section)
# Set to 0 to disable limitations
plugin_anilist_limit:
description: Maximum number of entries to display per section
description: Display limit (medias)
type: number
default: 2
min: 0
zero: disable
# Number of entries to display in characters section
# Set to 0 to disable limitations
plugin_anilist_limit_characters:
description: Maximum number of entries to display in characters section
description: Display limit (characters)
type: number
default: 22
min: 0
zero: disable
# Shuffle AniList data for varied outputs
plugin_anilist_shuffle:
description: Shuffle AniList data
description: Shuffle data for varied outputs
type: boolean
default: yes
# Username on AniList
plugin_anilist_user:
type: string
description: AniList login