Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Auto-configure dark mode feature documented #24

Merged
merged 2 commits into from
Dec 2, 2020
Merged

docs: Auto-configure dark mode feature documented #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
907b1f3
add auto-configure dark mode to readme docs
kratsg Dec 1, 2020
e016e60
Add link to mkdocs-material documentation on prefers
kratsg Dec 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,23 @@ box1[An <b>important</b> <a href="http://google.com">link</a>]
```


### Auto-configure dark mode based on Host OS

Using a combination of the literal (`^`) functionality of this plugin and the
[prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
CSS media feature, one can have the plugin automatically enable dark mode.

```yaml
plugins:
- search
- mermaid2:
arguments:
theme: |
^(window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'
```

This works well with the `scheme: preference` option in
[mkdocs-material](https://squidfunk.github.io/mkdocs-material/) and referenced in [their documentation](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-scheme).

## Compatibility

Expand Down