docs: updated workflows examples and options descriptions (#772) [skip ci]

This commit is contained in:
Simon Lecoq
2022-01-14 04:49:14 +01:00
committed by GitHub
parent 44e3992ca9
commit 4d06539136
80 changed files with 2292 additions and 450 deletions

View File

@@ -25,19 +25,63 @@ This plugin is composed of the following sections, which can be displayed or hid
These sections can also be filtered by media type, which can be either `anime`, `manga` or both.
#### ➡️ 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 |
Legend for option icons:
* 🔐 Value should be stored in repository secrets
* ✨ New feature currently in testing on `master`/`main`
<!--/options-->
*[→ Full specification](metadata.yml)*
#### Examples workflows
[➡️ Available options for this plugin](metadata.yml)
<!--examples-->
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_anilist: yes
plugin_anilist_medias: anime, manga # Display both animes and mangas
plugin_anilist_sections: favorites, characters # Display only favorites and characters sections
plugin_anilist_limit: 2 # Limit to 2 entry per section (characters section excluded)
plugin_anilist_limit_characters: 22 # Limit to 22 characters in characters section
plugin_anilist_shuffle: yes # Shuffle data for more varied outputs
plugin_anilist_user: .user.login # Use same username as GitHub login
name: Favorites anime and currently watching
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.anilist.svg
token: NOT_NEEDED
plugin_anilist: 'yes'
plugin_anilist_medias: anime
plugin_anilist_sections: favorites, watching
plugin_anilist_limit: 1
```
```yaml
name: Favorites manga and currently reading
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.anilist.manga.svg
token: NOT_NEEDED
plugin_anilist: 'yes'
plugin_anilist_medias: manga
plugin_anilist_sections: favorites, reading
plugin_anilist_limit: 1
```
```yaml
name: Favorites characters
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.anilist.characters.svg
token: NOT_NEEDED
plugin_anilist: 'yes'
plugin_anilist_sections: characters
plugin_anilist_limit_characters: 22
```
<!--/examples-->