Document auto theme change in README #2074
Assignees
Labels
documentation
Improvements or additions to documentation.
hacktoberfest
help wanted
Extra attention is needed.
Comments
rickstaa
added
documentation
|
Hi, i would like work on this |
|
@asifurrahaman754 Great that you want to take this on! I think it will help many people if this feature is clearly documented. I assigned you to this issue. 🚀 |
|
I just added one default [](https://github.com/anuraghazra/github-readme-stats) |
|
Given your comment in #764 (comment) I was wondering if you still want to be assigned to this issue? |
|
Oh, yes i forgot to tell u, u can assigned this to someone |
|
No problem. Thanks for letting me know. 👍🏻 |
|
For people taking this on, I think you can add a |
|
For this issue, I was looking for the following:
|
|
I want to get assigned to this. |
|
I would like to contribute to this issue |
|
@cjdomacena Unfortunately, I already assigned @lostgirljourney to this issue some hours ago. 😅 |
|
@lostgirljourney How is your Hacktoberfest PR going 😃? Feel free to tag me if anything is unclear. No hurries 👍🏻. |
|
hey @rickstaa, sorry for delay, caught in office work. but i am on it. |
|
@lostgirljourney No worries! Take your time 👍🏻. |
rickstaa
added a commit
that referenced
this issue
Oct 28, 2022
* Document auto theme change in README #2074 * Document auto theme change in README Document auto theme change in README #2074 (update-1) * Document auto theme change updates #2074 * docs: improve dynamic theme documentation Co-authored-by: rickstaa <[email protected]>
|
Done in #2229. |
AlexvZyl
added a commit
to AlexvZyl/github-readme-stats
that referenced
this issue
Apr 29, 2023
* ci: add e2e vercel test action (anuraghazra#2054) * ci: add e2e vercel test action This commit adds several end-to-end tests that can be used to test whether the Vercel Preview deployment successfully returns the cards. * test: add additional e2e card tests * test: improve e2e card tests This commit makes sure that the tests also check whether a valid cards are returned from the preview deployment. * ci: improve theme-preview actiot push (anuraghazra#2065) This commit makes sure that: - The theme-preview action can test multiple themes. - Fails if something goes wrong. - Requests changes if the theme does not adhere to the guidelines. - Approves the PR if the theme adheres to the guidelines. * ci: improve theme preview action (anuraghazra#2088) This commit makes sure that 4,5,6,8 digit hex colors are also accepted. It further also includes the border_color attribute in the tests. * ci: fix e2e test * chore: Update workflows to cache dependencies (anuraghazra#2083) * ci(label-pr): upgrade actions/labeler to v4 (anuraghazra#2080) Co-authored-by: rickstaa <[email protected]> * ci: fix e2e test * ci: add stale theme pull request closer action push (anuraghazra#2067) This commit adds the `stale-theme-pr-closer` closer action. This action is used to close theme pull requests with an `invalid` label that has been stale for a given number of `STALE_DAYS`. * feat: add transparent theme Adds a transparent theme with a contrast ratio of 4.5 on both black and white (see https://ux.stackexchange.com/a/86226). * feat: remove border color from transparent theme * ci: fix e2e test * feat: added default options to readme (anuraghazra#2051) * feat: added default options to readme * Update readme.md Co-authored-by: Rick Staa <[email protected]> * fix: added default values for stats card * style: some small readme changes Co-authored-by: Rick Staa <[email protected]> * ci: increase top-issues dashboard update frequency * style: improve code style * docs(theme): Auto update theme readme (anuraghazra#2091) Co-authored-by: Github Readme Stats Bot <[email protected]> * ci: fix small bugs in theme-preview action (anuraghazra#2093) * ci: fix small bugs in theme-preview action * ci: format code * ci: fix small bug in theme-preview action * docs: fix link to go India logo svg (anuraghazra#2085) * docs: format readme * docs: fix india care logo * Added Contributors Badge (anuraghazra#2096) * update default values in readme (anuraghazra#2094) * update default values in readme * docs: improve formatting * docs: improve readme punctation Co-authored-by: rickstaa <[email protected]> * fix: adding docstrings to the files where it was missing (anuraghazra#2101) * fix: adding docstrings to missing files * style: format code * style: improve formatting Co-authored-by: Jagruti Tiwari <[email protected]> Co-authored-by: rickstaa <[email protected]> * feat: default values for wakatime and language (anuraghazra#2103) * default values for wakatime and language * docs: update formatting Co-authored-by: rickstaa <[email protected]> * docs: improve readme syntax (anuraghazra#2106) * Update the Vercel deployement guide (anuraghazra#2102) * Update the Vercel deployement guide Updated Readme.md - The guide on deploying your own Vercel instance * docs: fix some small grammer errors Co-authored-by: rickstaa <[email protected]> * Fix card length during error (anuraghazra#2105) * Fix card length during error Fixes anuraghazra#1774 The size of the box should be 550px to allow 25px padding from both sides I found the width of the text using `getComputedTextLength()` method * fix: improve error card size Co-authored-by: rickstaa <[email protected]> * fix: fetch all repos for for the stats card (anuraghazra#2100) * fetch all stars * stop fetching when there are repos with zero stars * remove not needed parameters from the query * add docstring * removed not needed mock * style: update formatting Co-authored-by: rickstaa <[email protected]> * docs: fix readme logo alignment (anuraghazra#2112) * fix: temporary disable multi page star fetch * ci: improve theme preview action This commit makes sure that theme PRs that contain invalid JSON are labeled `invalid` and changes are requested. * style: improve formatting * style: improve small syntax error * Add format script to pre-commit hook (anuraghazra#2146) * Add format script to pre-commit hook * build: add husky prepare step * build: add lint-staged * build: add lint-staged Co-authored-by: rickstaa <[email protected]> * test: fix tests * docs: update readme * docs: add admonition boxes * docs: improve admonition boxes * docs: improve caching documentation * fix: adding doc strings to files in src folder where it was missing (anuraghazra#2129) * fix: adding doc strings to files in src folder where it was missing * refactor: add docstrings * style: run formatter Co-authored-by: rickstaa <[email protected]> * fix: improve graphql error handling * ci: updated issue template (anuraghazra#2127) * Updated issue templates * style: improve template formatting * style: update formatting Co-authored-by: rickstaa <[email protected]> * style: improve templates formatting * style: update formatting * test: burst cache in e2e tests (anuraghazra#2154) * test: increase stats card e2e timeout * test: cleanup tests * ci: add question template * ci: add issues template config and remove question template * fix: prevent errors from being cached (anuraghazra#2160) * test: add cache on error test * docs: add fork update guide * docs: improve syntax * refactor: add extra links to issues template * refactor: improve issues template (anuraghazra#2180) * refactor: improve issues template formatting * test: increase e2e test timeout * build: create npm package (anuraghazra#2151) * build: create npm package This commit makes sure that the common modules of the GRS package can be imported as an npm package. * feat: export card render functions * style: update formatting * fix: fix I18n import error * fix: improve json import (anuraghazra#2190) * Revert "fix: improve json import (anuraghazra#2190)" (anuraghazra#2191) This reverts commit 65424fa. * fix: text overlapped on zh-tw locale (anuraghazra#2192) * ci: fix stale closer action review sort bug (anuraghazra#2201) This commit makes sure the PR staleness is checked by the latest review that is done. * ci: increase invalid theme close time (anuraghazra#2210) This commits increases the theme invalid close time to 20 days. * fix: improve error caching behavoir (anuraghazra#2211) This commit ensures that the GraphQL Pat error is not cached in any browser. See anuraghazra#1471 (comment). * refactor: make issue templates required (anuraghazra#2226) * refactor: fix GitHub capitalization (anuraghazra#2232) * docs: document auto theme change anuraghazra#2074 (anuraghazra#2229) * Document auto theme change in README anuraghazra#2074 * Document auto theme change in README Document auto theme change in README anuraghazra#2074 (update-1) * Document auto theme change updates anuraghazra#2074 * docs: improve dynamic theme documentation Co-authored-by: rickstaa <[email protected]> * Update readme.md * Fix truncation of compact wakatime progress bar when langs_count is set (anuraghazra#2228) * refactor: use default value for languages * fix: truncated compact progress bar * test: add test for truncated compact progress bar with langs_count set * Corrections of Polish expressions in translations.js (anuraghazra#2240) * ci: update theme stale close message * ci: update theme stale close message * Missing term in calculation of TOTAL_VALUES. (anuraghazra#2116) * fix: added missing term in calculation of TOTAL_VALUES. * fix: fix rank test * refactor: update code formatting * refactor: update code formatting Co-authored-by: rickstaa <[email protected]> * Updates the brazilian readme (anuraghazra#2245) * feat: allow users to pass ring_color param (anuraghazra#2075) * fix: prevent crash if undefined color is passed to func fallbackColor * feat: allow users to pass ring_color param Before this commit, the ring color was always equal to the title color. This commit allows the user to pass a ring_color property to allow him to style the ring color the way he pleases to. If no ring_color is passed we default to the title color. * docs: improves ring color documentation * fix: improve code style Co-authored-by: rickstaa <[email protected]> * feat: added Date Night theme to index.js (anuraghazra#2264) * Added Date Night theme to index.js * My theme name should be in snake_case now * test: update snapshots * refactor: migrate to using arrow functions (anuraghazra#2033) * fix: improve boolean parse behaviour (anuraghazra#2029) * refactor: remove unused dotenv calls (anuraghazra#2059) As explained in the Vercel documentation vercel ignores dot files (see vercel/vercel#3962 (comment)). It instead loads the env variables defined in the vercel instance. As a result we can therefore remove dotenv. * fix: fix retry max-out bug (anuraghazra#2121) * fix: fix retry max-out bug This commit makes sure that the retry function tests all PATs. * style: format code * test: fix retry tests * style: format code * feat: improve card loading speed (anuraghazra#2124) * feat: improve card loading times This commit adds the `stale-while-revalidate` option to speed up the card loading times. * mend * feat: add INCLUDE_ORGS env variable (anuraghazra#2275) This commit adds an INCLUDE_ORGS ENV variable that can be used to include results from organizations into the GRS cards for self-deployed Vercel instances. **Warning** This is a hidden feature since we can not officially support this on the Public Vercel instance due to GraphQL and Vercel rate/timeout limits. You can set this env variable via Vercel's ENV variable menu (see https://vercel.com/docs/concepts/projects/environment-variables). * Revert "feat: add INCLUDE_ORGS env variable (anuraghazra#2275)" (anuraghazra#2276) This reverts commit ada9cf4. * fix: fix repoContrib confusion (anuraghazra#2269) (anuraghazra#2274) This commit prevents confusion about the Contributed to stat. Currently, only the last year's results are shown, but it looks like it is the all-time contribution count (see anuraghazra#2269). This commit adds a ' (last year)' suffix to prevent this confusion from happening. * feat: fix 'include_all_commits' inner card margin (anuraghazra#2283) * build(deps): bump json5 from 2.2.1 to 2.2.3 (anuraghazra#2373) Bumps [json5](https://github.com/json5/json5) from 2.2.1 to 2.2.3. - [Release notes](https://github.com/json5/json5/releases) - [Changelog](https://github.com/json5/json5/blob/main/CHANGELOG.md) - [Commits](json5/json5@v2.2.1...v2.2.3) --- updated-dependencies: - dependency-name: json5 dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: update snapshots * Add loading Animation to Most used Language card (anuraghazra#2197) * add: text animation * compact progress done * cleaned code * non compact animation done * tests fixed + prettier * revert: vercel.json * remove: unnecessary import * added parameter in docs * style: improve syntax Co-authored-by: rickstaa <[email protected]> * ci: fix theme readme generation action (anuraghazra#2271) * Revert "build(deps): bump json5 from 2.2.1 to 2.2.3 (anuraghazra#2373)" (anuraghazra#2393) This reverts commit 42fdff6. * Revert "ci: fix theme readme generation action (anuraghazra#2271)" (anuraghazra#2394) This reverts commit 5ae959b. * Revert "Add loading Animation to Most used Language card (anuraghazra#2197)" (anuraghazra#2396) This reverts commit 77dcdab. * fix: retryer fixed (anuraghazra#2400) * Revert "Revert "ci: fix theme readme generation action (anuraghazra#2271)" (anuraghazra#2394)" (anuraghazra#2418) This reverts commit 70f0264. * refactor: update code formatting * Revert "Revert "Add loading Animation to Most used Language card (anuraghazra#2197)" (anuraghazra#2396)" (anuraghazra#2419) This reverts commit 4b8198f. * Update readme.md (anuraghazra#2442) * test: fix e2e tests * test: update snapshots * test: fix e2e test data * test: update e2e test data * feat: fix e2e tests * fix: fix e2e test data * feat: enable multi page star fetching for private vercel instances (anuraghazra#2159) * feat: enable multi-page stars' fetching for private vercel instances This commit enables multi-page stars' support from fetching on private Vercel instances. This feature can be disabled on the public Vercel instance by adding the `FETCH_SINGLE_PAGE_STARS=true` as an env variable in the public Vercel instance. This variable will not be present when people deploy their own Vercel instance, causing the code to fetch multiple star pages. * fix: improve stats multi-page fetching behavoir This commit makes sure that the GraphQL api is only called one time per 100 repositories. The old method added one unnecesairy GraphQL call. * docs: update documentation * style: improve code syntax Co-authored-by: Matteo Pierro <[email protected]> * lol happy new year * docs: remove rate limit documentation for now Remove the `FETCH_SINGLE_PAGE_STARS` from documentation for now since it might confuse people. * fix: fix error in automatic merge * feat: make sure env variable is read Co-authored-by: Matteo Pierro <[email protected]> Co-authored-by: Anurag <[email protected]> * chore: resolve conflict (anuraghazra#2453) * test: fix e2e tests * test: update snapshots * test: fix e2e test data * test: update e2e test data Co-authored-by: rickstaa <[email protected]> * fix: change prod deployment branch to vercel branch to fix maxDuration bug (anuraghazra#2424) * Create deploy-prep.yml * Create deploy-prep.py * Update vercel.json * Update deploy-prep.yml * Update vercel.json * Added coauthor Co-authored-by: Dou Xiaobo <[email protected]> * Update deploy-prep.yml * refactor: format code * Added if condition to disable deployments on forks Co-authored-by: Rick Staa <[email protected]> * Update deploy-prep.yml Co-authored-by: Dou Xiaobo <[email protected]> Co-authored-by: Anurag Hazra <[email protected]> Co-authored-by: rickstaa <[email protected]> * fix: fixes card overflow problem anuraghazra#2452 (anuraghazra#2460) This commit makes sure that the card width is formatted correctly. * ci: prevent certain actions from running on forks (anuraghazra#2466) * feat: add PAT monitoring functions (anuraghazra#2178) * feat: add PAT monitoring functions This commit adds two monitoring functions that can be used to check whether the PATs are functioning correctly: - status/up: Returns whether the PATs are rate limited. - status/pat-info: Returns information about the PATs. * feat: add shields.io dynamic badge json response This commit adds the ability to set the return format of the `/api/status/up` cloud function. When this format is set to `shields` a dynamic shields.io badge json is returned. * feat: add 'json' type to up monitor * feat: cleanup status functions * ci: decrease pat-info rate limiting time * feat: decrease monitoring functions rate limits * refactor: pat code * feat: add PAT monitoring functions This commit adds two monitoring functions that can be used to check whether the PATs are functioning correctly: - status/up: Returns whether the PATs are rate limited. - status/pat-info: Returns information about the PATs. * feat: add shields.io dynamic badge json response This commit adds the ability to set the return format of the `/api/status/up` cloud function. When this format is set to `shields` a dynamic shields.io badge json is returned. * feat: add 'json' type to up monitor * feat: cleanup status functions * ci: decrease pat-info rate limiting time * feat: decrease monitoring functions rate limits * refactor: pat code * test: fix pat-info tests * Update api/status/pat-info.js Co-authored-by: Anurag Hazra <[email protected]> * test: fix broken tests * chore: fix suspended account * chore: simplify and refactor * chore: fix test * chore: add resetIn field --------- Co-authored-by: Anurag <[email protected]> * chore: minor changes in pat info (anuraghazra#2481) * ci: add update languages action (anuraghazra#2484) * ci: add update languages action * ci: make sure PR is created when upstream languages are updated * Add `rose` theme (anuraghazra#2480) Co-authored-by: 강민지 <[email protected]> * Support hide_progress for top-langs feature (anuraghazra#2514) * Add support for hide_progress in top languages feature * Fix mistake * Add documents for all languages * Remove unnecessary value check * Update top-languages-card.js * Revert document for all languages except English * Update documentation * Update documentation --------- Co-authored-by: Zohan Subhash <[email protected]> * add holi_theme (anuraghazra#2539) * add holi_theme * add holi_theme * Add one_dark_pro (anuraghazra#2507) This colors were taken from One Dark Pro theme in VSCode extention. Please add it and I will use it in my profile Co-authored-by: Zohan Subhash <[email protected]> * fix: fix JSON themes bug. (anuraghazra#2544) This fixes a JSON bug that was introduced in anuraghazra#2507. * Add auto-labelling for documentation updates (anuraghazra#2526) * ci: fix unsafe directory bug (anuraghazra#2518) This commit fixes a bug that was introduced due to a upstream change in the git package. See https://stackoverflow.com/questions/71849415/i-cannot-add-the-parent-directory-to-safe-directory-in-git/71904131#71904131 for more information. * Update readme.md (anuraghazra#2414) fix: missing "&" in show_icons=true in Showing icons section * test: update snapshots (anuraghazra#2519) * fix: for issue anuraghazra#2534 (anuraghazra#2536) * Add option to deploy using other services (anuraghazra#2525) * Create express.js * Update readme.md * Update readme.md * ci: update e2e tests (anuraghazra#2548) * ci: fix a bug in the theme preview action (anuraghazra#2549) * refactor: format code (anuraghazra#2550) * refactor: update languages JSON (anuraghazra#2554) Co-authored-by: rickstaa <[email protected]> * Preview theme workflow fix (anuraghazra#2557) * Fix octokit error * ci: make octokit instance global --------- Co-authored-by: rickstaa <[email protected]> * ci: preview theme workflow fix (anuraghazra#2559) * Fix octokit error * ci: make octokit instance global * Fix preview theme (move declarations to global) * refactor: make constants uppercase --------- Co-authored-by: rickstaa <[email protected]> * refactor: fix code comments and change 'up' rate limit (anuraghazra#2560) * Preview action fix (anuraghazra#2561) * Fix error * refactor: remove unused code --------- Co-authored-by: Rick Staa <[email protected]> * ci: fix theme preview action (anuraghazra#2563) * fix theme preview (anuraghazra#2564) * ci: fix theme preview action * fix: fix some bugs in the 'theme-preveiw' action * ci: fixes theme preview action (anuraghazra#2566) * ci: improve theme preview action (anuraghazra#2572) * Added "Shadow" set (Red, Green, Blue, transparent BG) (anuraghazra#2529) * Added "Shadow" set (Red, Green, Blue, transparent BG) 3 additional themes sticking primarily to flat colors, which the exception of icons and border being slightly darker. All 3 themes also have transparent backgrounds that will show differently per-user via GiHub's own light and dark themes. Transparency should also still provide easy readability for both. * Test Just want to see if we can make the themes have a transparent background. * Shadows moved under Transparent --------- Co-authored-by: Zohan Subhash <[email protected]> * ci: fix theme docs generate bug (anuraghazra#2573) * update my theme (anuraghazra#2576) * refactor: update languages JSON (anuraghazra#2596) Co-authored-by: rickstaa <[email protected]> * Add format stats option (anuraghazra#2155) * feat: added `format_stats` option (anuraghazra#2128) * refactor: change `format_stats` to `short_values` (anuraghazra#2128) * test: create shorten values test (anuraghazra#2128) * Update readme.md Co-authored-by: Rick Staa <[email protected]> * refactor: rename ``short_values`` to ``number_format`` * Update readme.md Co-authored-by: Rick Staa <[email protected]> * Update src/cards/stats-card.js Co-authored-by: Rick Staa <[email protected]> * refactor: format codebase --------- Co-authored-by: Rick Staa <[email protected]> * add github_dark_dimmed theme (anuraghazra#2594) * feat(theme): add github_dark_dimmed theme * feat(theme): change github_dark_dimmed icon color * contrast ratio adjustment contrast ratio adjustment on github_dark_dimmed theme * feat(theme): readme preview * feat(theme): github themes next to each other * github themes next to each other * feat(RankIcon): add rank_icon option (anuraghazra#2628) * feat(theme): add github_dark_dimmed theme * feat(theme): change github_dark_dimmed icon color * contrast ratio adjustment contrast ratio adjustment on github_dark_dimmed theme * feat(theme): readme preview * feat(theme): github themes next to each other * github themes next to each other * feat(RankIcon): add rank icon option * feat(RankIcon): extract rankIcon to icons file * feat(RankIcon): update readme * feat(RankIcon): test coverage * Update readme.md Co-authored-by: Rick Staa <[email protected]> --------- Co-authored-by: Rick Staa <[email protected]> * Updated the custom error there was a Typo. (anuraghazra#2618) "Something went while trying to retrieve the stats data using the GraphQL API." -> "Something went wrong while trying to retrieve the stats data using the GraphQL API." * Fix typos inside wakatime test name (anuraghazra#2617) * removed redundant comparison (anuraghazra#957) * dev (anuraghazra#1782) * fix path to powered by vercel image (anuraghazra#1792) * Synchonize cache seconds min value inside docs translations with main readme (anuraghazra#2616) * New top language algorithm implementation (anuraghazra#1732) * Reduced vercel maxDuration * Implemented new algorithm for Top Langs * Revert "Reduced vercel maxDuration" This reverts commit b0bc626. * Added documentation * Fixed broken implementation * Update fetchTopLanguages.test.js Changed tests * Now uses the general formula The parameters p and q can be set by the user. * Updated tests and added new test * Added new test New test for order by repo count. * Updated documentation Added explanation and examples for new options. * Updated documentation This was overwritten in the merge commit. * docs: improve docs and fix tests * Renamed parameters Renamed `p` and `q` to `size_weight` and `count_weight`, respectively. * Updated the documentation Changes introduced in f2516d6 --------- Co-authored-by: rickstaa <[email protected]> * feat: improve CONTRIBUTING.md (anuraghazra#2609) * docs: update give logo (anuraghazra#2605) * Fixed typo in word color inside README (anuraghazra#2652) * Fixed docs typo inside src/common/utils.js (anuraghazra#2651) * Fixed several typos inside preview theme script (anuraghazra#2650) * Fixed todo inside stats card data fetcher (anuraghazra#2649) * docs: fix README language card usage order (anuraghazra#2659) --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Rick Staa <[email protected]> Co-authored-by: Jongwoo Han <[email protected]> Co-authored-by: Oscar Dominguez <[email protected]> Co-authored-by: Jagruti Tiwari <[email protected]> Co-authored-by: Anurag Hazra <[email protected]> Co-authored-by: Github Readme Stats Bot <[email protected]> Co-authored-by: ianbromwichuos <[email protected]> Co-authored-by: Manan1612 <[email protected]> Co-authored-by: Ayushi Vishwakarma <[email protected]> Co-authored-by: Jagruti Tiwari <[email protected]> Co-authored-by: Aditya Shelke <[email protected]> Co-authored-by: Akshat Goel <[email protected]> Co-authored-by: nekiwo <[email protected]> Co-authored-by: Matteo Pierro <[email protected]> Co-authored-by: Taehyun Hwang <[email protected]> Co-authored-by: Shivam Kotak <[email protected]> Co-authored-by: Brian Choromanski <[email protected]> Co-authored-by: Kurt <[email protected]> Co-authored-by: Frieder Bluemle <[email protected]> Co-authored-by: Falguni Sarkar <[email protected]> Co-authored-by: Ray Chan <[email protected]> Co-authored-by: Tymoteusz Marzec <[email protected]> Co-authored-by: Fabian Joswig <[email protected]> Co-authored-by: Ítalo Sousa <[email protected]> Co-authored-by: Pranav Joglekar <[email protected]> Co-authored-by: Bradley Jester <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Huzaifa Khilawala <[email protected]> Co-authored-by: Zohan Subhash <[email protected]> Co-authored-by: Dou Xiaobo <[email protected]> Co-authored-by: 강민지 <[email protected]> Co-authored-by: 강민지 <[email protected]> Co-authored-by: Amir <[email protected]> Co-authored-by: Mohamed Hassan <[email protected]> Co-authored-by: Oleksandr Perlov <[email protected]> Co-authored-by: Cateline Mnemosyne <[email protected]> Co-authored-by: Raphael Gonçalves <[email protected]> Co-authored-by: Rehman <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: rickstaa <[email protected]> Co-authored-by: Etanarvazac Revorix <[email protected]> Co-authored-by: Eduardo Zaniboni <[email protected]> Co-authored-by: Caeden Perelli-Harris <[email protected]> Co-authored-by: Fabiano Couto <[email protected]> Co-authored-by: LOKESH SINGH <[email protected]> Co-authored-by: Alexandr Garbuzov <[email protected]> Co-authored-by: kitswas <[email protected]>
devantler
pushed a commit
to devantler/github-readme-stats
that referenced
this issue
May 1, 2023
* Document auto theme change in README anuraghazra#2074 * Document auto theme change in README Document auto theme change in README anuraghazra#2074 (update-1) * Document auto theme change updates anuraghazra#2074 * docs: improve dynamic theme documentation Co-authored-by: rickstaa <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
As explained in #690, it is not yet possible to switch the theme automatically on the Vercel instance. Nevertheless, there are multiple ways to get the card to switch themes on the client side. The methods for doing this (i.e.
transparent background,#gh-dark-mode-onlyandsource media) need to be explained in the README so that users are aware these options exist.Describe the solution you'd like
It would be great if README would have a section for setting up dynamic themes. This section should explain:
transparenttheme.bg_color=00000000to set a transparent background.<picture>element to switch the theme automatically based on the set GitHub theme. This option, however, requires the user to refresh the page before the card theme is updated.The text was updated successfully, but these errors were encountered: