docs(plugins): clarification, fix typos and style

This commit is contained in:
lowlighter
2022-07-04 23:18:01 -04:00
parent 3c00e64c57
commit 52ca4d04b7
47 changed files with 733 additions and 408 deletions

View File

@@ -1,6 +1,7 @@
name: "🌸 Anilist watch list and reading list"
name: 🌸 Anilist watch list and reading list
category: social
description: This plugin displays your favorites animes, mangas and characters from your [AniList](https://anilist.co) account.
description: |
This plugin displays favorites animes, mangas and characters from a [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
@@ -13,12 +14,21 @@ scopes: []
inputs:
plugin_anilist:
description: Enable aniList plugin
description: |
Enable aniList plugin
type: boolean
default: no
plugin_anilist_user:
type: string
description: |
AniList login
default: .user.login
preset: no
plugin_anilist_medias:
description: Display medias types
description: |
Medias types
type: array
format: comma-separated
default: anime, manga
@@ -29,7 +39,8 @@ inputs:
plugin_anilist_sections:
description: |
Displayed sections
- `favorites` will display favorites `plugin_anilist_medias`
- `favorites` will display favorites from `plugin_anilist_medias`
- `watching` will display animes currently in watching list
- `reading` will display manga currently in reading list
- `characters` will display liked characters
@@ -44,26 +55,25 @@ inputs:
- characters
plugin_anilist_limit:
description: Display limit (medias)
description: |
Display limit (medias)
type: number
default: 2
min: 0
zero: disable
plugin_anilist_limit_characters:
description: Display limit (characters)
description: |
Display limit (characters)
type: number
default: 22
min: 0
zero: disable
plugin_anilist_shuffle:
description: Shuffle data for varied outputs
description: |
Shuffle data
Can be used to create varied outputs
type: boolean
default: yes
plugin_anilist_user:
type: string
description: AniList login
default: .user.login
preset: no