diff --git a/.github/readme/partials/documentation/compatibility.md b/.github/readme/partials/documentation/compatibility.md index 06f50aa9..d1833e9c 100644 --- a/.github/readme/partials/documentation/compatibility.md +++ b/.github/readme/partials/documentation/compatibility.md @@ -5,18 +5,18 @@
| â Back to plugins index | |||||||||||||||||||||||||||||||||||||||||||||||||||||
đ Achievements | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This plugin displays several highlights about what you achieved on GitHub. + | |||||||||||||||||||||||||||||||||||||||||||||||||||||
This plugin displays several highlights about what an account has achieved on GitHub. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| Supported features â Full specification |
@@ -43,7 +43,7 @@
|||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- Display rank threshold + | Rank threshold filter Use |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
- Display secrets achievements + | Secrets achievements |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
- Hide specified achievements -Use names without the rank adjective (i.e. without "great", "super" or "master") + | Ignored achievements +Use achievements names without their rank adjective (i.e. without "great", "super" or "master") |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
- Restrict display to specified achievements -Use names without the rank adjective (i.e. without "great", "super" or "master") -This option is equivalent to | Showcased achievements +Use achievements names without their rank adjective (i.e. without "great", "super" or "master") +This option is equivalent to |
|||||||||||||||||||||||||||||||||||||||||||||||||||
| â Back to plugins index | ||||||||||||||||||||||||
đ° Recent activity | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This plugin displays your recent activity on GitHub. + | ||||||||||||||||||||||||
This plugin displays recent activity on GitHub. | ||||||||||||||||||||||||
| Supported features â Full specification |
@@ -83,7 +83,7 @@
||||||||||||||||||||||||
|
Events visibility -Lets you hide private activity when using a Can be used to toggle private activity visibility when using a token with |
|||||||||||||||||||||||
|
- Display events timestamps + | Events timestamps |
||||||||||||||||||||||
|
Ignored users -Useful to ignore bots activity +Can be used to ignore bots activity |
|||||||||||||||||||||||
| â Back to plugins index | ||
đ¸ Anilist watch list and reading list | ||
|---|---|---|
This plugin displays your favorites animes, mangas and characters from your AniList account. + | ||
This plugin displays favorites animes, mangas and characters from a AniList account. | ||
| Supported features â Full specification |
@@ -41,10 +41,21 @@
type: boolean
default: no |
+ |
|
+ AniList login + |
+ |
| â¯ī¸ Cannot be preset +type: string
++default: â User login |
||
|
- Display medias types + | Medias types |
|
Displayed sections
| |
|
- Shuffle data for varied outputs + | Shuffle data +Can be used to create varied outputs |
|
- AniList login - |
- |
| â¯ī¸ Cannot be preset -type: string
--default: â User login |
- ||
Base content
The following sections are supported:
header, which usually contains username, two-week commits calendars and a few additional dataheader, which usually contains username, two-weeks commits calendars and a few additional dataactivity, which contains recent activity (commits, pull requests, issues, etc.)community, which contains community stats (following, sponsors, organizations, etc.)repositories, which contains repository stats (license, forks, stars, etc.)settings.jsonsettings.json:
+boolean
base_hireableDisplay Available for hire! in header section
Show Available for hire! in header section
repositoriesRepositories to fetch
+Fetched repositories
A higher value result in more accurate metrics but can hit GitHub API rate-limit more easily (especially with a lot of plugins enabled)
repositories_batchRepositories to fetch at a time
-If you receive Something went wrong while executing your query (which is usually caused by API timeout),
-try lowering this value.
Fetched repositories per query
+If you receive Something went wrong while executing your query (which is usually caused by API timeouts), lowering this value may help.
+This setting may not be supported by all plugins.
organization_member: repositories from an organization where user is a memberSome plugin outputs may be affected by this setting too.
-Set to "" to disable and fetch all repositories related to you.
-Broad affiliation will result in less representative metrics.
Set to "" to disable and fetch all repositories related to given account.
+Broad affiliations will result in less representative metrics.
users_ignoredDefault ignored users
-Note that email are supported only commits-related elements.
+Note that emails are only supported in commits-related elements.