Add dark mode support for built-in themes #14052
Open
+1,011
−0
Conversation
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
This commit adds automatic dark mode support to Sphinx's built-in themes (basic, classic, haiku, nature, and sphinxdoc) using CSS prefers-color-scheme media queries. The dark mode activates automatically based on the user's system/browser theme preference. Additionally, an optional JavaScript toggle (theme_toggle.js) is provided in the basic theme to allow users to manually switch between light and dark modes, with the preference saved in localStorage. Features: - Dark mode CSS for basic, classic, haiku, nature, and sphinxdoc themes - Automatic activation via prefers-color-scheme media query - Optional manual toggle with theme_toggle.js - Improved contrast and readability in dark mode - Support for both automatic and manual theme switching
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This commit adds automatic dark mode support to Sphinx's built-in themes (basic, classic, haiku, nature, and sphinxdoc) using CSS prefers-color-scheme media queries. The dark mode activates automatically based on the user's system/browser theme preference.
Additionally, an optional JavaScript toggle (theme_toggle.js) is provided in the basic theme to allow users to manually switch between light and dark modes, with the preference saved in localStorage.
Features:
Testing:
References