diff --git a/action.yml b/action.yml index 42d6ef44..505d91d8 100644 --- a/action.yml +++ b/action.yml @@ -1227,7 +1227,7 @@ inputs: default: plugin_chess_user: - description: AniList login + description: Chess platform login default: plugin_chess_platform: diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index a75dbeff..e797cbff 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -92,7 +92,7 @@ This currently improves the accuracy of the following statistics:

Skip base content

⚠️ Any plugin that relies on base content data may break! -Only use this option when using a plugin that can be configured with token: NOT_NEEDED

+Only use this option when using a plugin that can be configured with token: NOT_NEEDED

diff --git a/source/plugins/community/chess/README.md b/source/plugins/community/chess/README.md index c9a7ef97..fddbc6c3 100644 --- a/source/plugins/community/chess/README.md +++ b/source/plugins/community/chess/README.md @@ -60,7 +60,7 @@ All product and company names are trademarks™ or registered® trademarks of th

plugin_chess_user

-

AniList login

+

Chess platform login

diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index eb108cc0..f32bf234 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -92,7 +92,7 @@ All product and company names are trademarks™ or registered® trademarks of th

Displayed sections

diff --git a/source/plugins/core/README.md b/source/plugins/core/README.md index 6056cc83..e836dcd0 100644 --- a/source/plugins/core/README.md +++ b/source/plugins/core/README.md @@ -474,7 +474,7 @@ When doing so, any settings which defaults on user fetched values will not be te

user

GitHub username

-

Defaults to token owner username.

+

Defaults to token owner username.

@@ -498,7 +498,7 @@ When doing so, any settings which defaults on user fetched values will not be te

GitHub Token used to commit metrics

Leave this to ${{ github.token }} or ${{ secrets.GITHUB_TOKEN }}, which is a special auto-generated token restricted to current repository scope.

-

💡 When using output_action: gist, it will use token instead, since gists are outside of scope

+

💡 When using output_action: gist, it will use token instead, since gists are outside of scope

@@ -532,7 +532,7 @@ When doing so, any settings which defaults on user fetched values will not be te

committer_gist

Gist id

-

Specify an existing gist id (can be retrieved from its URL) when using output_action: gist.

+

Specify an existing gist id (can be retrieved from its URL) when using output_action: gist.

@@ -543,7 +543,7 @@ When doing so, any settings which defaults on user fetched values will not be te

filename

Output path

-

When using an asterisk (*), correct extension will automatically be applied according to config_output value

+

When using an asterisk (*), correct extension will automatically be applied according to config_output value

@@ -602,6 +602,9 @@ When doing so, any settings which defaults on user fetched values will not be te
  • always: always try to push changes
  • data-changed: skip changes if no data changed (e.g. like when only metadata changed)
    • +
    +

    ℹ️ This option is only revelant when config_output: svg is set

    +
    @@ -616,9 +619,9 @@ When doing so, any settings which defaults on user fetched values will not be te -

    Some templates may not support all options

    +

    Templates may not always honour all provided options

    @@ -675,6 +678,9 @@ This is mostly useful for custom templates.

    Extra CSS

    Custom CSS that will be injected in used template. Useful to avoid creating a new template just to tweak some styling

    +
    +

    💡 metrics tends to avoid using !important rules, which means that most styling can be overridden by this option when using !important

    +
    @@ -690,8 +696,11 @@ Useful to avoid creating a new template just to tweak some styling

    Extra JavaScript

    Custom JavaScript that will be executed during puppeteer rendering. Useful to avoid creating a new template just to tweak some content.

    -

    Note that is it executed within puppeteer context and not metrics context. +

    +

    ⚠️ Note that is it executed within puppeteer context and not within metrics context. +No access to fetched data or configuration will be offered through this context. It is run after transformations and optimizations, but just before resizing.

    +
    @@ -772,7 +781,7 @@ May increase filesize.

    Use GitHub custom emojis

    GitHub supports additional emojis which are not registered in Unicode standard (:octocat:, :shipit:, :trollface:, ...) See full list at https://api.github.com/emojis.

    -

    This option has no effect when token: NOT_NEEDED is set.

    +

    This option has no effect when [`token: NOT_NEEDED``](/source/plugins/core/README.md#token) is set.

    May increase filesize

    @@ -854,9 +863,9 @@ It can result in cropped or oversized outputs.

    Each value need to respect the following format:

    Percentage are relative to computed dimensions

    @@ -990,7 +999,7 @@ Be sure to disable this option when asking for help or submitting bug reports.

    quota_required_rest

    Minimum GitHub REST API requests quota required to run

    Action will cancel itself without any errors if requirements are not met

    -

    This option has no effect when token is set to NOT_NEEDED

    +

    This option has no effect when token: NOT_NEEDED is set

    @@ -1005,7 +1014,7 @@ Be sure to disable this option when asking for help or submitting bug reports.

    quota_required_graphql

    Minimum GitHub GraphQL API requests quota required to run

    Action will cancel itself without any errors if requirements are not met

    -

    This option has no effect when token is set to NOT_NEEDED

    +

    This option has no effect when token: NOT_NEEDED is set

    @@ -1020,7 +1029,7 @@ Be sure to disable this option when asking for help or submitting bug reports.

    quota_required_search

    Minimum GitHub Search API requests quota required to run

    Action will cancel itself without any errors if requirements are not met

    -

    This option has no effect when token is set to NOT_NEEDED

    +

    This option has no effect when token: NOT_NEEDED is set

    @@ -1071,7 +1080,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi

    debug

    Debug mode

    -

    This setting is automatically enable if a job fail (useful with plugins_errors_fatal: yes)

    +

    This setting is automatically enable if a job fail (useful with plugins_errors_fatal: yes)

    @@ -1130,7 +1139,9 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi

    dryrun

    Dry-run

    -

    Contrary to output_action: none, output file won't be available in /metrics_renders directory

    +
    +

    ⚠️ Unlike output_action: none, output file won't be available in /metrics_renders directory

    +
    @@ -1143,7 +1154,9 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi

    experimental_features

    Experimental features

    -

    No backward compatibility is guaranteed for these features

    +
    +

    ⚠️ No backward compatibility is guaranteed for these features

    +
    diff --git a/source/plugins/lines/README.md b/source/plugins/lines/README.md index 9cc8913c..4d914528 100644 --- a/source/plugins/lines/README.md +++ b/source/plugins/lines/README.md @@ -63,6 +63,9 @@ All product and company names are trademarks™ or registered® trademarks of th
  • repositories will display repositories with the most lines added and removed
  • history will display a graph displaying lines added and removed over time
    • +
    +

    ℹ️ base requires at least base: repositories to be set

    +