From a6623c4ab51f8632e4c1932d0e937d672ddae3db Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 19:16:20 +0200 Subject: [PATCH 1/8] docs: drop stale "Responsive Card Theme" cross-references --- apps/frontend/src/content/docs/docs/customization/theming.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/apps/frontend/src/content/docs/docs/customization/theming.md b/apps/frontend/src/content/docs/docs/customization/theming.md index 552f4318fe2d5..c4085d94ebd22 100644 --- a/apps/frontend/src/content/docs/docs/customization/theming.md +++ b/apps/frontend/src/content/docs/docs/customization/theming.md @@ -43,8 +43,6 @@ You can use [GitHub's media feature](https://github.blog/changelog/2022-05-19-sp ``` -For example the image at the top of the Responsive Card Theme section works like this - it follows the theme you set for this page. - ### Set light and dark mode in one card Use the `theme_light` and `theme_dark` or `*_light` / `*_dark` color parameters to embed both modes in a single card URL. See [Light & Dark Mode Parameters](#light--dark-mode-parameters) below for full details. The card will then display in light mode or dark mode based on your browser / operating system settings. @@ -73,8 +71,6 @@ You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-sp [![Anurag's GitHub stats-Light](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme=light_github#gh-light-mode-only)](https://github.com/stats-organization/github-stats-extended#gh-light-mode-only) ``` -For example the image at the top of the Responsive Card Theme section works like this - it follows the theme you set for this page. - ### Use the transparent theme We have included a `transparent` theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the `&theme=transparent` parameter like so: From 3ed9e70ee8d2062d75d5e699f33d5740465eebf1 Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 19:16:59 +0200 Subject: [PATCH 2/8] docs: render light/dark example from the current deployment --- apps/frontend/src/content/docs/docs/customization/theming.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/frontend/src/content/docs/docs/customization/theming.md b/apps/frontend/src/content/docs/docs/customization/theming.md index c4085d94ebd22..cec2c216b3483 100644 --- a/apps/frontend/src/content/docs/docs/customization/theming.md +++ b/apps/frontend/src/content/docs/docs/customization/theming.md @@ -58,7 +58,7 @@ However, unlike with the "media" feature or the theme context tag, if a user cho
👀 Show example -![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github) +![Anurag's GitHub stats](/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github)
From ef25a976c437b2c3b00db7567c309b7b17de453e Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 19:17:39 +0200 Subject: [PATCH 3/8] docs: nest light/dark parameters under the single-card approach --- .../docs/docs/customization/theming.md | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/apps/frontend/src/content/docs/docs/customization/theming.md b/apps/frontend/src/content/docs/docs/customization/theming.md index cec2c216b3483..48f9c4862677b 100644 --- a/apps/frontend/src/content/docs/docs/customization/theming.md +++ b/apps/frontend/src/content/docs/docs/customization/theming.md @@ -45,7 +45,7 @@ You can use [GitHub's media feature](https://github.blog/changelog/2022-05-19-sp ### Set light and dark mode in one card -Use the `theme_light` and `theme_dark` or `*_light` / `*_dark` color parameters to embed both modes in a single card URL. See [Light & Dark Mode Parameters](#light--dark-mode-parameters) below for full details. The card will then display in light mode or dark mode based on your browser / operating system settings. +Use the `theme_light` and `theme_dark` or `*_light` / `*_dark` color parameters to embed both modes in a single card URL. See [Light & Dark Mode Parameters](#light--dark-mode-parameters) for full details. The card will then display in light mode or dark mode based on your browser / operating system settings. This approach doesn't use any GitHub-specific features, so it works even when embedding the card outside of GitHub. Or on your GitHub sponsorship page, which doesn't support the other, GitHub-specific approaches. @@ -62,6 +62,30 @@ However, unlike with the "media" feature or the theme context tag, if a user cho +### Light & Dark Mode Parameters + +You can use the `theme_light`, `theme_dark`, and `*_light` / `*_dark` color parameters to customize the look of your card for different modes. + +**Priority (lowest → highest):** + +- default theme +- `theme` +- `theme_light` / `theme_dark` +- general color parameters +- `*_light` / `*_dark` color parameters + +for example: + +```md +![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github) +``` + +You can mix different parameter types. For example, set a light theme and a dark theme, but choose a custom title color: + +```md +![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github&title_color=aabbcc) +``` + ### Use GitHub's theme context tag You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) tags to switch the theme based on the user's GitHub theme. This is done by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme: @@ -100,27 +124,3 @@ You can use the `bg_color` parameter to make any of [the available themes](/fron ![Anurag's GitHub stats](/api?username=anuraghazra&show_icons=true&bg_color=00000000) - -## Light & Dark Mode Parameters - -You can use the `theme_light`, `theme_dark`, and `*_light` / `*_dark` color parameters to customize the look of your card for different modes. - -**Priority (lowest → highest):** - -- default theme -- `theme` -- `theme_light` / `theme_dark` -- general color parameters -- `*_light` / `*_dark` color parameters - -for example: - -```md -![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github) -``` - -You can mix different parameter types. For example, set a light theme and a dark theme, but choose a custom title color: - -```md -![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github&title_color=aabbcc) -``` From 221d71e1e9820bb6ea6ae92ca1161c93599a5763 Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 19:18:07 +0200 Subject: [PATCH 4/8] docs: distinguish the contributions stat from contribs --- apps/frontend/src/content/docs/docs/cards/stats.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/apps/frontend/src/content/docs/docs/cards/stats.md b/apps/frontend/src/content/docs/docs/cards/stats.md index a7ec08a8e9538..1e6ade47fca86 100644 --- a/apps/frontend/src/content/docs/docs/cards/stats.md +++ b/apps/frontend/src/content/docs/docs/cards/stats.md @@ -32,6 +32,11 @@ You can pass a query parameter `&show=` to show any specific additional stats wi ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show=contributions,reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage,prs_authored,prs_commented,prs_reviewed,issues_authored,issues_commented) ``` +:::note +`contributions` is the total number of contributions across all years, while the +`contribs` item hidden via `&hide=` is the number of repositories contributed to. +::: + ## Showing icons To enable icons, you can pass `&show_icons=true` in the query param, like so: From 755da34360f6148e57856fc25b6c92cf635e094a Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 19:18:27 +0200 Subject: [PATCH 5/8] docs: link the light/dark footnote to the precedence rules --- .../src/content/docs/docs/customization/common-options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/frontend/src/content/docs/docs/customization/common-options.md b/apps/frontend/src/content/docs/docs/customization/common-options.md index ffddc281ea5a4..40278d06124bd 100644 --- a/apps/frontend/src/content/docs/docs/customization/common-options.md +++ b/apps/frontend/src/content/docs/docs/customization/common-options.md @@ -17,7 +17,7 @@ Every card accepts the options below, on top of the exclusive options listed on | `locale` | Sets the language in the card, you can check full list of available locales [here](/frontend/docs/customization/locales/). | enum | `en` | | `border_radius` | Corner rounding on the card. | number | `4.5` | -1: These parameters support light and dark mode. You can use `*_light` and `*_dark` variants to specify different values for light and dark mode. For example, `title_color_light` and `title_color_dark` will set the title color for light and dark mode respectively. +1: These parameters support light and dark mode. You can use `*_light` and `*_dark` variants to specify different values for light and dark mode. For example, `title_color_light` and `title_color_dark` will set the title color for light and dark mode respectively. See [Light & Dark Mode Parameters](/frontend/docs/customization/theming/#light--dark-mode-parameters) for the precedence rules. :::caution[Warning] We use caching to decrease the load on our servers (see [this discussion](https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425)). Cards generated by [https://github-stats-extended.vercel.app/](https://github-stats-extended.vercel.app/frontend) are usually cached for a few days. If you need your card data to update more frequently, you can [deploy your own instance](/frontend/docs/deploy/) and set the [`CACHE_SECONDS`](/frontend/docs/deploy/#available-environment-variables) environment variable to your preferred value. Alternatively, you can use the [GitHub Actions workflow](/frontend/docs/deploy/#github-action) to update your cards on a schedule. From d7a3bcee5322e169c764da957db944cb87877fd6 Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 20:56:54 +0200 Subject: [PATCH 6/8] docs: tighten the theming prose --- .../docs/docs/customization/theming.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/apps/frontend/src/content/docs/docs/customization/theming.md b/apps/frontend/src/content/docs/docs/customization/theming.md index 48f9c4862677b..eeaec841742aa 100644 --- a/apps/frontend/src/content/docs/docs/customization/theming.md +++ b/apps/frontend/src/content/docs/docs/customization/theming.md @@ -4,7 +4,7 @@ title: Theming With inbuilt themes, you can customize the look of the card without doing any [manual customization](/frontend/docs/customization/common-options/). -Use `&theme=THEME_NAME` parameter like so : +Pass `&theme=THEME_NAME`: ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical) @@ -16,20 +16,22 @@ GitHub Stats Extended comes with several built-in themes (e.g. `radical`, `merko GitHub Stats Extended Themes -We recommend using `light_github` for light mode and `dark_github` for dark mode. These themes match GitHub's default light and dark themes, ensuring that your stats card looks consistent with the rest of your profile. For repository cards and gist cards we recommend using `light_github_repocard` and `dark_github_repocard`, which use a different icon color. +:::tip +Use `light_github` and `dark_github` to match GitHub's own light and dark themes. For repository and gist cards use `light_github_repocard` and `dark_github_repocard`, which differ only in icon color. +::: -You can look at a preview for [all available themes](/frontend/docs/customization/themes/) or checkout the [theme config file](https://github.com/stats-organization/github-stats-extended/blob/master/packages/core/src/themes/index.ts). Please note that we paused the addition of new themes to decrease maintenance efforts; all pull requests related to new themes will be closed. +Preview [all available themes](/frontend/docs/customization/themes/) or read the [theme config file](https://github.com/stats-organization/github-stats-extended/blob/master/packages/core/src/themes/index.ts). We have paused the addition of new themes to reduce maintenance effort; pull requests adding one will be closed. ## Light and Dark Mode Anurag's GitHub stats Anurag's GitHub stats -There are several methods you can use to create dynamic themes on the client side. +There are several ways to switch a card between modes on the client side. ### Use GitHub's media feature (recommended) -You can use [GitHub's media feature](https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/) in HTML to specify which image to display in light or dark mode. This is done using the HTML `` element in combination with the `prefers-color-scheme` media feature. +[GitHub's media feature](https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/) picks the image from a `` element using the `prefers-color-scheme` media query. ```html @@ -45,11 +47,9 @@ You can use [GitHub's media feature](https://github.blog/changelog/2022-05-19-sp ### Set light and dark mode in one card -Use the `theme_light` and `theme_dark` or `*_light` / `*_dark` color parameters to embed both modes in a single card URL. See [Light & Dark Mode Parameters](#light--dark-mode-parameters) for full details. The card will then display in light mode or dark mode based on your browser / operating system settings. +`theme_light` / `theme_dark` and the `*_light` / `*_dark` color parameters put both modes in a single card URL, which then follows the viewer's browser or OS setting. See [Light & Dark Mode Parameters](#light--dark-mode-parameters) for the details. -This approach doesn't use any GitHub-specific features, so it works even when embedding the card outside of GitHub. Or on your GitHub sponsorship page, which doesn't support the other, GitHub-specific approaches. - -However, unlike with the "media" feature or the theme context tag, if a user chooses a GitHub theme different from their browser/OS setting, the card will not be able to detect this. Since GitHub re-uploads the cards and serves them from their [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), we can not infer the GitHub theme with this approach, only the browser/OS theme. +Nothing here is GitHub-specific, so it also works outside GitHub — including sponsorship pages, where the other approaches do not. The trade-off: GitHub serves the card from its [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), so a GitHub theme that differs from the browser/OS setting cannot be detected. ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github) @@ -64,7 +64,7 @@ However, unlike with the "media" feature or the theme context tag, if a user cho ### Light & Dark Mode Parameters -You can use the `theme_light`, `theme_dark`, and `*_light` / `*_dark` color parameters to customize the look of your card for different modes. +These parameters style each mode separately. **Priority (lowest → highest):** @@ -74,13 +74,13 @@ You can use the `theme_light`, `theme_dark`, and `*_light` / `*_dark` color para - general color parameters - `*_light` / `*_dark` color parameters -for example: +For example: ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github) ``` -You can mix different parameter types. For example, set a light theme and a dark theme, but choose a custom title color: +Types can be mixed — a light and a dark theme, plus one fixed title color: ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github&title_color=aabbcc) @@ -88,7 +88,7 @@ You can mix different parameter types. For example, set a light theme and a dark ### Use GitHub's theme context tag -You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) tags to switch the theme based on the user's GitHub theme. This is done by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme: +Appending `#gh-dark-mode-only` or `#gh-light-mode-only` to an image URL shows it only to viewers on that [GitHub theme](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/): ```md [![Anurag's GitHub stats-Dark](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark_github#gh-dark-mode-only)](https://github.com/stats-organization/github-stats-extended#gh-dark-mode-only) @@ -97,7 +97,7 @@ You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-sp ### Use the transparent theme -We have included a `transparent` theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the `&theme=transparent` parameter like so: +The `transparent` theme has no background, so it sits well on GitHub's light and dark themes: ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent) @@ -112,7 +112,7 @@ We have included a `transparent` theme that has a transparent background. This t ### Add transparent alpha channel to a themes bg\_color -You can use the `bg_color` parameter to make any of [the available themes](/frontend/docs/customization/themes/) transparent. This is done by setting the `bg_color` to a color with a transparent alpha channel (i.e. `bg_color=00000000`): +Any of [the available themes](/frontend/docs/customization/themes/) turns transparent when `bg_color` carries an alpha channel (i.e. `bg_color=00000000`): ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000) From ea64f6a0e34de3680f51b4279df9f5777537f54b Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 21:15:17 +0200 Subject: [PATCH 7/8] docs: put the light/dark caveats in note callouts --- .../frontend/src/content/docs/docs/customization/theming.md | 6 +++++- apps/frontend/src/content/docs/docs/fork.md | 4 +++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/apps/frontend/src/content/docs/docs/customization/theming.md b/apps/frontend/src/content/docs/docs/customization/theming.md index eeaec841742aa..d05affdf39b75 100644 --- a/apps/frontend/src/content/docs/docs/customization/theming.md +++ b/apps/frontend/src/content/docs/docs/customization/theming.md @@ -49,7 +49,11 @@ There are several ways to switch a card between modes on the client side. `theme_light` / `theme_dark` and the `*_light` / `*_dark` color parameters put both modes in a single card URL, which then follows the viewer's browser or OS setting. See [Light & Dark Mode Parameters](#light--dark-mode-parameters) for the details. -Nothing here is GitHub-specific, so it also works outside GitHub — including sponsorship pages, where the other approaches do not. The trade-off: GitHub serves the card from its [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), so a GitHub theme that differs from the browser/OS setting cannot be detected. +Nothing here is GitHub-specific, so it also works outside GitHub — including sponsorship pages, where the other approaches do not. + +:::note +GitHub serves the card from its [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), so a GitHub theme that differs from the browser/OS setting cannot be detected. +::: ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&show_icons=true&theme_light=light_github&theme_dark=dark_github) diff --git a/apps/frontend/src/content/docs/docs/fork.md b/apps/frontend/src/content/docs/docs/fork.md index da4e77e150760..f5ce028e6ebd5 100644 --- a/apps/frontend/src/content/docs/docs/fork.md +++ b/apps/frontend/src/content/docs/docs/fork.md @@ -50,7 +50,9 @@ GitHub-Stats-Extended adds `light_github` and `dark_github` [themes](/frontend/d GitHub-Stats-Extended adds an optional stat showing the total number of [contributions](https://docs.github.com/en/account-and-profile/reference/profile-contributions-reference#what-counts-as-a-contribution) (commits, pull requests, issues, etc.) across all years of a user's GitHub history. Add `&show=contributions` to your stats card URL to enable it. Whether private contributions are counted depends on [your GitHub profile visibility settings](https://docs.github.com/en/account-and-profile/how-tos/contribution-settings/manage-visibility-settings-for-private-contributions-and-achievements#changing-the-visibility-of-your-private-contributions). -Note that the pre-existing "Contributed to" stat indicates the number of repositories a user has contributed to, not the number of contributions. +:::note +The pre-existing "Contributed to" stat indicates the number of repositories a user has contributed to, not the number of contributions. +::: ### Customization of top languages card From f0699811ec67edc95f71a2398242ff44e79e07ea Mon Sep 17 00:00:00 2001 From: Marco Pasqualetti Date: Tue, 25 Aug 2026 21:15:38 +0200 Subject: [PATCH 8/8] docs: tighten the light/dark and contributions prose --- apps/frontend/src/content/docs/docs/cards/stats.md | 6 +++--- .../src/content/docs/docs/cards/top-languages.md | 2 +- .../docs/docs/customization/common-options.md | 2 +- apps/frontend/src/content/docs/docs/fork.md | 12 ++++++------ 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/apps/frontend/src/content/docs/docs/cards/stats.md b/apps/frontend/src/content/docs/docs/cards/stats.md index 1e6ade47fca86..33b4290d06fa5 100644 --- a/apps/frontend/src/content/docs/docs/cards/stats.md +++ b/apps/frontend/src/content/docs/docs/cards/stats.md @@ -33,8 +33,8 @@ You can pass a query parameter `&show=` to show any specific additional stats wi ``` :::note -`contributions` is the total number of contributions across all years, while the -`contribs` item hidden via `&hide=` is the number of repositories contributed to. +`contributions` counts contributions across all years; +the `contribs` item under `&hide=` counts repositories contributed to. ::: ## Showing icons @@ -88,7 +88,7 @@ You can customize the appearance and behavior of the stats card using the [commo | `show` | Shows [additional items](#showing-additional-individual-stats) on the stats card (i.e. `contributions`, `reviews`, `discussions_started`, `discussions_answered`, `prs_merged` or `prs_merged_percentage`. And the following, which support the `repo` and `owner` filters: `prs_authored`, `prs_commented`, `prs_reviewed`, `issues_authored` or `issues_commented`). | string (comma-separated values) | `null` | | `commits_year` | Filters and counts only commits made in the specified year. | integer _(YYYY)_ | ` (one year to date)` | -1: This parameter supports light and dark mode. You can use `ring_color_light` and `ring_color_dark` to specify different colors for light and dark mode. +1: Supports light and dark mode via `ring_color_light` and `ring_color_dark`. :::caution[Warning] Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `Anurag's GitHub Stats` should become `Anurag%27s%20GitHub%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically. diff --git a/apps/frontend/src/content/docs/docs/cards/top-languages.md b/apps/frontend/src/content/docs/docs/cards/top-languages.md index 707e343c0951c..e98898fdcb764 100644 --- a/apps/frontend/src/content/docs/docs/cards/top-languages.md +++ b/apps/frontend/src/content/docs/docs/cards/top-languages.md @@ -48,7 +48,7 @@ You can customize the appearance and behavior of the top languages card using th | `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` | | `stats_format` | Switches between two available formats for language's stats `percentages` and `bytes`. | enum | `percentages` | -1: This parameter supports light and dark mode. You can use `prog_bar_bg_color_light` and `prog_bar_bg_color_dark` to specify different colors for light and dark mode. +1: Supports light and dark mode via `prog_bar_bg_color_light` and `prog_bar_bg_color_dark`. :::caution[Warning] Language names and custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, `Most Used Languages` should become `Most%20Used%20Languages`, etc.) You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically. diff --git a/apps/frontend/src/content/docs/docs/customization/common-options.md b/apps/frontend/src/content/docs/docs/customization/common-options.md index 40278d06124bd..40da81c1cd1bc 100644 --- a/apps/frontend/src/content/docs/docs/customization/common-options.md +++ b/apps/frontend/src/content/docs/docs/customization/common-options.md @@ -17,7 +17,7 @@ Every card accepts the options below, on top of the exclusive options listed on | `locale` | Sets the language in the card, you can check full list of available locales [here](/frontend/docs/customization/locales/). | enum | `en` | | `border_radius` | Corner rounding on the card. | number | `4.5` | -1: These parameters support light and dark mode. You can use `*_light` and `*_dark` variants to specify different values for light and dark mode. For example, `title_color_light` and `title_color_dark` will set the title color for light and dark mode respectively. See [Light & Dark Mode Parameters](/frontend/docs/customization/theming/#light--dark-mode-parameters) for the precedence rules. +1: Support light and dark mode via `*_light` / `*_dark` variants (e.g. `title_color_light`). See [Light & Dark Mode Parameters](/frontend/docs/customization/theming/#light--dark-mode-parameters) for the precedence rules. :::caution[Warning] We use caching to decrease the load on our servers (see [this discussion](https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425)). Cards generated by [https://github-stats-extended.vercel.app/](https://github-stats-extended.vercel.app/frontend) are usually cached for a few days. If you need your card data to update more frequently, you can [deploy your own instance](/frontend/docs/deploy/) and set the [`CACHE_SECONDS`](/frontend/docs/deploy/#available-environment-variables) environment variable to your preferred value. Alternatively, you can use the [GitHub Actions workflow](/frontend/docs/deploy/#github-action) to update your cards on a schedule. diff --git a/apps/frontend/src/content/docs/docs/fork.md b/apps/frontend/src/content/docs/docs/fork.md index f5ce028e6ebd5..c730fb7893edb 100644 --- a/apps/frontend/src/content/docs/docs/fork.md +++ b/apps/frontend/src/content/docs/docs/fork.md @@ -34,29 +34,29 @@ GitHub-Stats-Extended fetches up to 1000 of your starred repositories to accurat ### Light and dark mode in a single card URL -GitHub-Stats-Extended adds `theme_light`, `theme_dark`, and `*_light` / `*_dark` color parameter variants (e.g. `title_color_light`, `title_color_dark`) that let you embed both light and dark mode in a single card URL. The card will automatically switch between the two based on the viewer's browser or OS theme setting. +GitHub-Stats-Extended adds `theme_light`, `theme_dark` and the `*_light` / `*_dark` color variants (e.g. `title_color_light`), which hold both modes in one card URL. The card then follows the viewer's browser or OS setting. ```md ![Anurag's GitHub stats](https://github-stats-extended.vercel.app/api?username=anuraghazra&theme_light=light_github&theme_dark=dark_github) ``` -This approach works on any platform, not just GitHub - and on GitHub sponsorship pages, which don't support the other approaches to light/dark theming. See [Set light and dark mode in one card](/frontend/docs/customization/theming/#set-light-and-dark-mode-in-one-card) for full documentation. +It works anywhere, including GitHub sponsorship pages, where the other light/dark approaches do not. See [Set light and dark mode in one card](/frontend/docs/customization/theming/#set-light-and-dark-mode-in-one-card) for the details. ### GitHub-themed light and dark themes -GitHub-Stats-Extended adds `light_github` and `dark_github` [themes](/frontend/docs/customization/themes/) that exactly match GitHub's default light and dark UI colors. For repo and gist cards, use `light_github_repocard` and `dark_github_repocard` instead, which use a different icon color. +GitHub-Stats-Extended adds `light_github` and `dark_github` [themes](/frontend/docs/customization/themes/) matching GitHub's own UI colors. Repo and gist cards have `light_github_repocard` and `dark_github_repocard`, which differ only in icon color. ### New Contributions stat -GitHub-Stats-Extended adds an optional stat showing the total number of [contributions](https://docs.github.com/en/account-and-profile/reference/profile-contributions-reference#what-counts-as-a-contribution) (commits, pull requests, issues, etc.) across all years of a user's GitHub history. Add `&show=contributions` to your stats card URL to enable it. Whether private contributions are counted depends on [your GitHub profile visibility settings](https://docs.github.com/en/account-and-profile/how-tos/contribution-settings/manage-visibility-settings-for-private-contributions-and-achievements#changing-the-visibility-of-your-private-contributions). +GitHub-Stats-Extended adds an optional stat counting every [contribution](https://docs.github.com/en/account-and-profile/reference/profile-contributions-reference#what-counts-as-a-contribution) — commits, pull requests, issues — across all years of a user's history; enable it with `&show=contributions`. Private contributions count only if [your profile visibility settings](https://docs.github.com/en/account-and-profile/how-tos/contribution-settings/manage-visibility-settings-for-private-contributions-and-achievements#changing-the-visibility-of-your-private-contributions) allow it. :::note -The pre-existing "Contributed to" stat indicates the number of repositories a user has contributed to, not the number of contributions. +The pre-existing "Contributed to" stat counts repositories, not contributions. ::: ### Customization of top languages card -GitHub-Stats-Extended allows you to display your top languages without any numbers via the `hide_values` parameter. And the `prog_bar_bg_color` parameter allows you to customize the background color of the progress bars, e.g. by setting it to transparent: +GitHub-Stats-Extended can show your top languages without numbers via `hide_values`, and `prog_bar_bg_color` sets the bar background — here transparent: anuraghazra's top languages without numbers anuraghazra's top languages without numbers