feature (theme): add light/dark mode toggle across all mkdocs configs#939
Open
AarishShah wants to merge 1 commit intoOWASP:masterfrom
Open
feature (theme): add light/dark mode toggle across all mkdocs configs#939AarishShah wants to merge 1 commit intoOWASP:masterfrom
AarishShah wants to merge 1 commit intoOWASP:masterfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Adds a light/dark mode toggle to the OWASP Top 10 documentation site by configuring the
paletteoption in the MkDocs Material theme.Changes
Added a
paletteblock to:Two schemes:
default: light mode with a☀️toggle to switch to darkslate: dark mode with a🌙toggle to switch to lightNo dependencies added.
Reason
The OWASP Top 10 site currently has no dark mode. The MkDocs Material theme
supports this natively with a simple config change which has been applied.
Testing
Tested locally:
2021/:python -m mkdocs servefrom2021/directory, all language builds passed2025/:python -m mkdocs servefrom2025/directory, English build passed