Skip to content

Commit 1007e25

Browse files
committedJan 16, 2022
doc(plugins/anilist): update
1 parent ae8a76d commit 1007e25

File tree

2 files changed

+62
-55
lines changed

2 files changed

+62
-55
lines changed
 

‎source/plugins/anilist/README.md

+40-35
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
1-
### 🌸 Anilist watch list and reading list"
2-
3-
The *anilist* plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account.
4-
1+
<!--header-->
52
<table>
6-
<td align="center">
7-
<details open><summary>For anime watchers</summary>
8-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg">
9-
</details>
10-
<details><summary>For manga readers</summary>
11-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg">
12-
</details>
13-
<details open><summary>Favorites characters</summary>
14-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg">
15-
</details>
16-
<img width="900" height="1" alt="">
17-
</td>
3+
<tr><th colspan="2"><h3>🌸 Anilist watch list and reading list</h3></th></tr>
4+
<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>
5+
</td></tr>
6+
<tr>
7+
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
8+
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a></td>
9+
</tr>
10+
<tr>
11+
<td><code>👤 Users</code> <code>👥 Organizations</code></td>
12+
</tr>
13+
<tr>
14+
<td><i>No tokens are required for this plugin</i></td>
15+
</tr>
16+
<tr>
17+
<td colspan="2" align="center">
18+
<details open><summary>For anime watchers</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg" alt=""></img></details>
19+
<details open><summary>For manga readers</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg" alt=""></img></details>
20+
<details open><summary>For waifus simp</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg" alt=""></img></details>
21+
<img width="900" height="1" alt="">
22+
</td>
23+
</tr>
1824
</table>
25+
<!--/header-->
1926

20-
This plugin is composed of the following sections, which can be displayed or hidden through `plugin_anilist_sections` option:
21-
- `favorites` will display your favorites mangas and animes
22-
- `watching` will display animes currently in your watching list
23-
- `reading` will display manga currently in your reading list
24-
- `characters` will display characters you liked
25-
26-
These sections can also be filtered by media type, which can be either `anime`, `manga` or both.
27-
28-
#### ➡️ Available options
27+
## ➡️ Available options
2928

3029
<!--options-->
3130
<table>
@@ -34,7 +33,7 @@ These sections can also be filtered by media type, which can be either `anime`,
3433
</tr>
3534
<tr>
3635
<td nowrap="nowrap"><code>plugin_anilist</code></td>
37-
<td rowspan="2"><p>Display data from your AniList account</p>
36+
<td rowspan="2"><p>Enable aniList plugin</p>
3837
<img width="900" height="1" alt=""></td>
3938
</tr>
4039
<tr>
@@ -44,7 +43,7 @@ These sections can also be filtered by media type, which can be either `anime`,
4443
</tr>
4544
<tr>
4645
<td nowrap="nowrap"><code>plugin_anilist_medias</code></td>
47-
<td rowspan="2"><p>Medias types to display</p>
46+
<td rowspan="2"><p>Display medias types</p>
4847
<img width="900" height="1" alt=""></td>
4948
</tr>
5049
<tr>
@@ -56,7 +55,13 @@ These sections can also be filtered by media type, which can be either `anime`,
5655
</tr>
5756
<tr>
5857
<td nowrap="nowrap"><code>plugin_anilist_sections</code></td>
59-
<td rowspan="2"><p>Sections to display</p>
58+
<td rowspan="2"><p>Displayed sections</p>
59+
<ul>
60+
<li><code>favorites</code> will display favorites <code>plugin_anilist_medias</code></li>
61+
<li><code>watching</code> will display animes currently in watching list</li>
62+
<li><code>reading</code> will display manga currently in reading list</li>
63+
<li><code>characters</code> will display liked characters</li>
64+
</ul>
6065
<img width="900" height="1" alt=""></td>
6166
</tr>
6267
<tr>
@@ -68,31 +73,33 @@ These sections can also be filtered by media type, which can be either `anime`,
6873
</tr>
6974
<tr>
7075
<td nowrap="nowrap"><code>plugin_anilist_limit</code></td>
71-
<td rowspan="2"><p>Maximum number of entries to display per section</p>
76+
<td rowspan="2"><p>Display limit (medias)</p>
7277
<img width="900" height="1" alt=""></td>
7378
</tr>
7479
<tr>
7580
<td nowrap="nowrap"><b>type:</b> <code>number</code>
7681
<i>(0 ≤
7782
𝑥)</i>
7883
<br>
84+
<b>zero behaviour:</b> disable</br>
7985
<b>default:</b> 2<br></td>
8086
</tr>
8187
<tr>
8288
<td nowrap="nowrap"><code>plugin_anilist_limit_characters</code></td>
83-
<td rowspan="2"><p>Maximum number of entries to display in characters section</p>
89+
<td rowspan="2"><p>Display limit (characters)</p>
8490
<img width="900" height="1" alt=""></td>
8591
</tr>
8692
<tr>
8793
<td nowrap="nowrap"><b>type:</b> <code>number</code>
8894
<i>(0 ≤
8995
𝑥)</i>
9096
<br>
97+
<b>zero behaviour:</b> disable</br>
9198
<b>default:</b> 22<br></td>
9299
</tr>
93100
<tr>
94101
<td nowrap="nowrap"><code>plugin_anilist_shuffle</code></td>
95-
<td rowspan="2"><p>Shuffle AniList data</p>
102+
<td rowspan="2"><p>Shuffle data for varied outputs</p>
96103
<img width="900" height="1" alt=""></td>
97104
</tr>
98105
<tr>
@@ -113,9 +120,7 @@ These sections can also be filtered by media type, which can be either `anime`,
113120
</table>
114121
<!--/options-->
115122

116-
*[→ Full specification](metadata.yml)*
117-
118-
#### ℹ️ Examples workflows
123+
## ℹ️ Examples workflows
119124

120125
<!--examples-->
121126
```yaml
@@ -156,4 +161,4 @@ with:
156161
plugin_anilist_limit_characters: 22
157162

158163
```
159-
<!--/examples-->
164+
<!--/examples-->

‎source/plugins/anilist/metadata.yml

+22-20
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,67 @@
11
name: "🌸 Anilist watch list and reading list"
22
category: social
3+
description: This plugin lets you display your favorites animes, mangas and characters from your [AniList](https://anilist.co) account.
4+
examples:
5+
+for anime watchers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg
6+
+for manga readers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg
7+
+for waifus simp: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg
38
index: 4
49
supports:
510
- user
611
- organization
712
scopes: []
813
inputs:
914

10-
# Enable or disable plugin
1115
plugin_anilist:
12-
description: Display data from your AniList account
16+
description: Enable aniList plugin
1317
type: boolean
1418
default: no
1519

16-
# Types of medias to display
1720
plugin_anilist_medias:
18-
description: Medias types to display
21+
description: Display medias types
1922
type: array
2023
format: comma-separated
2124
default: anime, manga
2225
values:
2326
- anime
2427
- manga
2528

26-
# Sections to display
27-
# Values from "plugin_anilist_medias" may impact displayed sections
2829
plugin_anilist_sections:
29-
description: Sections to display
30+
description: |
31+
Displayed sections
32+
- `favorites` will display favorites `plugin_anilist_medias`
33+
- `watching` will display animes currently in watching list
34+
- `reading` will display manga currently in reading list
35+
- `characters` will display liked characters
3036
type: array
3137
format: comma-separated
3238
default: favorites
3339
example: favorites, watching, characters
3440
values:
35-
- favorites # Favorites animes and mangas (depending on plugin_anilist_medias values)
36-
- watching # Animes in your watching list
37-
- reading # Mangas in your reading list
38-
- characters # Favorites characters
41+
- favorites
42+
- watching
43+
- reading
44+
- characters
3945

40-
# Number of entries to display per section (this does not impacts characters section)
41-
# Set to 0 to disable limitations
4246
plugin_anilist_limit:
43-
description: Maximum number of entries to display per section
47+
description: Display limit (medias)
4448
type: number
4549
default: 2
4650
min: 0
51+
zero: disable
4752

48-
# Number of entries to display in characters section
49-
# Set to 0 to disable limitations
5053
plugin_anilist_limit_characters:
51-
description: Maximum number of entries to display in characters section
54+
description: Display limit (characters)
5255
type: number
5356
default: 22
5457
min: 0
58+
zero: disable
5559

56-
# Shuffle AniList data for varied outputs
5760
plugin_anilist_shuffle:
58-
description: Shuffle AniList data
61+
description: Shuffle data for varied outputs
5962
type: boolean
6063
default: yes
6164

62-
# Username on AniList
6365
plugin_anilist_user:
6466
type: string
6567
description: AniList login

0 commit comments

Comments
 (0)
Failed to load comments.