docs: respect system colorscheme#10667
Merged
Viicos merged 1 commit intopydantic:mainfrom Oct 21, 2024
Merged
Conversation
The docs now use the systems color preference by default. A new third option was added to the theme picker, which automatically adjusts the light/dark mode.
CodSpeed Performance ReportMerging #10667 will not alter performanceComparing Summary
|
Contributor
Coverage report
This PR does not seem to contain any modification to coverable code. |
Contributor
Author
|
please review |
Viicos
approved these changes
Oct 21, 2024
Member
Viicos
left a comment
There was a problem hiding this comment.
Thanks for adding the video example. This looks good
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Change Summary
Screen.Recording.2024-10-20.at.22.45.41.mov
This PR makes the docs respect the systems color preference by default. As can be seen in the video, it currently defaults to light mode, even if I've set my OS to dark mode.
This also adds a new option to the theme picker next to the search. This means the cycle is now
Related issue number
Not an issue, but the dark mode seems to have been introduced in #2913. The convention that the button icon and alt text reflects the action instead of the current state is retained. The latest comment on the referenced PR also indicates that other users also expect the systems color preference to be the default.
Other Related Things
Here is a link to the docs of Mkdocs Material, where they describe the automatic dark/light mode: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
Checklist
Unit tests for the changes existDocumentation reflects the changes where applicableSelected Reviewer: @sydney-runkle