diff --git a/.github/readme/imgs/example_action_update.dark.png b/.github/readme/imgs/example_action_update.dark.png new file mode 100644 index 00000000..a31a49d1 Binary files /dev/null and b/.github/readme/imgs/example_action_update.dark.png differ diff --git a/.github/readme/imgs/example_action_update.light.png b/.github/readme/imgs/example_action_update.light.png new file mode 100644 index 00000000..1be3969f Binary files /dev/null and b/.github/readme/imgs/example_action_update.light.png differ diff --git a/.github/readme/imgs/example_action_update.png b/.github/readme/imgs/example_action_update.png deleted file mode 100644 index 8805818d..00000000 Binary files a/.github/readme/imgs/example_action_update.png and /dev/null differ diff --git a/.github/readme/imgs/example_github_profile.dark.png b/.github/readme/imgs/example_github_profile.dark.png new file mode 100644 index 00000000..b5c0d524 Binary files /dev/null and b/.github/readme/imgs/example_github_profile.dark.png differ diff --git a/.github/readme/imgs/example_github_profile.light.png b/.github/readme/imgs/example_github_profile.light.png new file mode 100644 index 00000000..35e73280 Binary files /dev/null and b/.github/readme/imgs/example_github_profile.light.png differ diff --git a/.github/readme/imgs/example_github_profile.png b/.github/readme/imgs/example_github_profile.png deleted file mode 100644 index b580945e..00000000 Binary files a/.github/readme/imgs/example_github_profile.png and /dev/null differ diff --git a/.github/readme/imgs/setup_personal_repository.dark.png b/.github/readme/imgs/setup_personal_repository.dark.png new file mode 100644 index 00000000..8cd8fbcf Binary files /dev/null and b/.github/readme/imgs/setup_personal_repository.dark.png differ diff --git a/.github/readme/imgs/setup_personal_repository.light.png b/.github/readme/imgs/setup_personal_repository.light.png new file mode 100644 index 00000000..53558cae Binary files /dev/null and b/.github/readme/imgs/setup_personal_repository.light.png differ diff --git a/.github/readme/imgs/setup_personal_repository.png b/.github/readme/imgs/setup_personal_repository.png deleted file mode 100644 index 88d74873..00000000 Binary files a/.github/readme/imgs/setup_personal_repository.png and /dev/null differ diff --git a/.github/readme/imgs/setup_personal_token.dark.png b/.github/readme/imgs/setup_personal_token.dark.png new file mode 100644 index 00000000..8c35dba2 Binary files /dev/null and b/.github/readme/imgs/setup_personal_token.dark.png differ diff --git a/.github/readme/imgs/setup_personal_token.light.png b/.github/readme/imgs/setup_personal_token.light.png new file mode 100644 index 00000000..155692c6 Binary files /dev/null and b/.github/readme/imgs/setup_personal_token.light.png differ diff --git a/.github/readme/imgs/setup_personal_token.png b/.github/readme/imgs/setup_personal_token.png deleted file mode 100644 index 728f2143..00000000 Binary files a/.github/readme/imgs/setup_personal_token.png and /dev/null differ diff --git a/.github/readme/imgs/setup_private_contributions.dark.png b/.github/readme/imgs/setup_private_contributions.dark.png new file mode 100644 index 00000000..060db6a6 Binary files /dev/null and b/.github/readme/imgs/setup_private_contributions.dark.png differ diff --git a/.github/readme/imgs/setup_private_contributions.light.png b/.github/readme/imgs/setup_private_contributions.light.png new file mode 100644 index 00000000..11672045 Binary files /dev/null and b/.github/readme/imgs/setup_private_contributions.light.png differ diff --git a/.github/readme/imgs/setup_private_contributions.png b/.github/readme/imgs/setup_private_contributions.png deleted file mode 100644 index c4e9fca6..00000000 Binary files a/.github/readme/imgs/setup_private_contributions.png and /dev/null differ diff --git a/.github/readme/imgs/setup_public_membership_org.dark.png b/.github/readme/imgs/setup_public_membership_org.dark.png new file mode 100644 index 00000000..7de5390c Binary files /dev/null and b/.github/readme/imgs/setup_public_membership_org.dark.png differ diff --git a/.github/readme/imgs/setup_public_membership_org.light.png b/.github/readme/imgs/setup_public_membership_org.light.png new file mode 100644 index 00000000..33cad565 Binary files /dev/null and b/.github/readme/imgs/setup_public_membership_org.light.png differ diff --git a/.github/readme/imgs/setup_public_membership_org.png b/.github/readme/imgs/setup_public_membership_org.png deleted file mode 100644 index 9de7bb0f..00000000 Binary files a/.github/readme/imgs/setup_public_membership_org.png and /dev/null differ diff --git a/.github/readme/imgs/setup_repository_secret.dark.png b/.github/readme/imgs/setup_repository_secret.dark.png new file mode 100644 index 00000000..6cae665e Binary files /dev/null and b/.github/readme/imgs/setup_repository_secret.dark.png differ diff --git a/.github/readme/imgs/setup_repository_secret.light.png b/.github/readme/imgs/setup_repository_secret.light.png new file mode 100644 index 00000000..cdecab51 Binary files /dev/null and b/.github/readme/imgs/setup_repository_secret.light.png differ diff --git a/.github/readme/imgs/setup_repository_secret.png b/.github/readme/imgs/setup_repository_secret.png deleted file mode 100644 index 3cafae20..00000000 Binary files a/.github/readme/imgs/setup_repository_secret.png and /dev/null differ diff --git a/.github/readme/imgs/setup_token_org_read_scope.dark.png b/.github/readme/imgs/setup_token_org_read_scope.dark.png new file mode 100644 index 00000000..948bffff Binary files /dev/null and b/.github/readme/imgs/setup_token_org_read_scope.dark.png differ diff --git a/.github/readme/imgs/setup_token_org_read_scope.light.png b/.github/readme/imgs/setup_token_org_read_scope.light.png new file mode 100644 index 00000000..b66178ed Binary files /dev/null and b/.github/readme/imgs/setup_token_org_read_scope.light.png differ diff --git a/.github/readme/imgs/setup_token_org_read_scope.png b/.github/readme/imgs/setup_token_org_read_scope.png deleted file mode 100644 index ab92ac51..00000000 Binary files a/.github/readme/imgs/setup_token_org_read_scope.png and /dev/null differ diff --git a/.github/readme/imgs/setup_token_repo_scope.dark.png b/.github/readme/imgs/setup_token_repo_scope.dark.png new file mode 100644 index 00000000..9cbfa379 Binary files /dev/null and b/.github/readme/imgs/setup_token_repo_scope.dark.png differ diff --git a/.github/readme/imgs/setup_token_repo_scope.light.png b/.github/readme/imgs/setup_token_repo_scope.light.png new file mode 100644 index 00000000..8a1e9287 Binary files /dev/null and b/.github/readme/imgs/setup_token_repo_scope.light.png differ diff --git a/.github/readme/imgs/setup_token_repo_scope.png b/.github/readme/imgs/setup_token_repo_scope.png deleted file mode 100644 index 7c839852..00000000 Binary files a/.github/readme/imgs/setup_token_repo_scope.png and /dev/null differ diff --git a/.github/readme/partials/documentation/organizations.md b/.github/readme/partials/documentation/organizations.md index e47ecdd8..abcc53e6 100644 --- a/.github/readme/partials/documentation/organizations.md +++ b/.github/readme/partials/documentation/organizations.md @@ -8,7 +8,8 @@ While *metrics* targets mainly user accounts, it's possible to render metrics fo Setup is mostly the same as for user accounts. A personal access token from an user account is required excepted that `read:org` scope must be enabled, **whether you are member of the target organization or not**. -![Add read:org scope to personal token](/.github/readme/imgs/setup_token_org_read_scope.png) +![Add read:org scope to personal token](/.github/readme/imgs/setup_token_org_read_scope.light.png#gh-light-mode-only) +![Add read:org scope to personal token](/.github/readme/imgs/setup_token_org_read_scope.dark.png#gh-dark-mode-only) `user` option will need to be set to organization name instead. @@ -33,7 +34,8 @@ It is possible to host workflows in the `.github` repository of organizations, a By default, GitHub only display public memberships. Membership visibility canbe managed in the `People` tab of your organization. -![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.png) +![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.light.png#gh-light-mode-only) +![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.dark.png#gh-dark-mode-only) > ⚠️ Seeing your organization membership in your profile **does not** mean that it is visible from other users! You can check this by viewing your profile in an private browser window. diff --git a/.github/readme/partials/documentation/setup/action.md b/.github/readme/partials/documentation/setup/action.md index 9f542515..29e2a756 100644 --- a/.github/readme/partials/documentation/setup/action.md +++ b/.github/readme/partials/documentation/setup/action.md @@ -6,11 +6,13 @@ Setup a GitHub Action which runs periodically and pushes generated images to a r Create a repository with the same name as your GitHub login (if it doesn't exist). -![Setup personal repository](/.github/readme/imgs/setup_personal_repository.png) +![Setup personal repository](/.github/readme/imgs/setup_personal_repository.light.png#gh-light-mode-only) +![Setup personal repository](/.github/readme/imgs/setup_personal_repository.dark.png#gh-dark-mode-only) Its `README.md` will be displayed on your user profile: -![GitHub Profile Example](/.github/readme/imgs/example_github_profile.png) +![GitHub Profile Example](/.github/readme/imgs/example_github_profile.light.png#gh-light-mode-only) +![GitHub Profile Example](/.github/readme/imgs/example_github_profile.dark.png#gh-dark-mode-only) ## 1️ Create a GitHub personal token @@ -27,11 +29,13 @@ A a general rule, the following scopes may be required: > 💡 For security reasons, it is advised to always use the least amount of scopes. It is possible to prevent security issues by [forking this repository](https://github.com/lowlighter/metrics/fork) and using it in your workflow instead (more information available in step 3) -![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.png) +![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.light.png#gh-light-mode-only) +![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.dark.png#gh-dark-mode-only) A scope-less token can still display private contributions by enabling `Include private contributions on my profile` in account settings: -![Enable "Include private contributions on my profile`"](/.github/readme/imgs/setup_private_contributions.png) +![Enable "Include private contributions on my profile`"](/.github/readme/imgs/setup_private_contributions.light.png#gh-light-mode-only) +![Enable "Include private contributions on my profile`"](/.github/readme/imgs/setup_private_contributions.dark.png#gh-dark-mode-only) When a plugin has not enough scopes to operate (and `plugins_errors_fatal` is disabled), an error will be reported in the rendering like below: @@ -41,7 +45,8 @@ When a plugin has not enough scopes to operate (and `plugins_errors_fatal` is di Go to the `Settings` of your repository and to create a new secret and paste your freshly generated GitHub token there. -![Setup a repository secret](/.github/readme/imgs/setup_repository_secret.png) +![Setup a repository secret](/.github/readme/imgs/setup_repository_secret.light.png#gh-light-mode-only) +![Setup a repository secret](/.github/readme/imgs/setup_repository_secret.dark.png#gh-dark-mode-only) ## 3️ Setup GitHub Action workflow @@ -67,7 +72,8 @@ jobs: Rendered metrics will be committed to repository on each run. -![Action update example](/.github/readme/imgs/example_action_update.png) +![Action update example](/.github/readme/imgs/example_action_update.light.png#gh-light-mode-only) +![Action update example](/.github/readme/imgs/example_action_update.dark.png#gh-dark-mode-only) ### 3️.1️ Choosing between `@latest`, `@master`/`@main`, a fork or a pinned version diff --git a/.github/readme/partials/documentation/setup/shared.md b/.github/readme/partials/documentation/setup/shared.md index 701b688f..9fe6d4a9 100644 --- a/.github/readme/partials/documentation/setup/shared.md +++ b/.github/readme/partials/documentation/setup/shared.md @@ -6,11 +6,13 @@ For convenience, a free shared instance is available at [metrics.lecoq.io](https Create a repository with the same name as your GitHub login (if it doesn't exist). -![Setup personal repository](/.github/readme/imgs/setup_personal_repository.png) +![Setup personal repository](/.github/readme/imgs/setup_personal_repository.light.png#gh-light-mode-only) +![Setup personal repository](/.github/readme/imgs/setup_personal_repository.dark.png#gh-dark-mode-only) Its `README.md` will be displayed on your user profile: -![GitHub Profile Example](/.github/readme/imgs/example_github_profile.png) +![GitHub Profile Example](/.github/readme/imgs/example_github_profile.light.png#gh-light-mode-only) +![GitHub Profile Example](/.github/readme/imgs/example_github_profile.dark.png#gh-dark-mode-only) ## 2️ Configure *metrics* diff --git a/.github/readme/partials/documentation/setup/web.md b/.github/readme/partials/documentation/setup/web.md index 25669bd7..be880d5c 100644 --- a/.github/readme/partials/documentation/setup/web.md +++ b/.github/readme/partials/documentation/setup/web.md @@ -14,7 +14,8 @@ No additional scopes are required. > 💡 For security reasons, it is advised to use a scope-less token for web instances. -![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.png) +![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.light.png#gh-light-mode-only) +![Setup a GitHub personal token](/.github/readme/imgs/setup_personal_token.dark.png#gh-dark-mode-only) ## 2️ Configure *metrics*