Mdbook Mermaid dark mode support #35
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Expectation:
When switching to a dark theme in mdbook the mermaid diagrams also switch to a dark theme.
What happens:
Mermaid diagrams do not honor the theme and render in light mode being not very readable in dark mode.
I am happy to help if you point me to the right start.
This is more of a styling question and can be done independently of this plugin.
Looks like mermaid doesn't have any auto-switching but it does have theming, so you can build the auto-switch yourself.
I think mdbook-mermaid would need to implement a switching that at least provides a default mapping from the default mdbook themes to the light or dark mermaid themes.
I would see mdbook-mermaid as a mermaid bridge for mdbook that should integrate mermaid diagrams into mdbook and not produce diagrams that you can't read in one of the default themes.
Similar as they do it for mermaid-live as described in this comment: https://github.com/mermaid-js/mermaid/issues/2644#issuecomment-1029648289
I would be absolutely willing to implement this if you could hint me in the right direction.
mdbook-mermaid currently doesn't handle any theming on its own at all.
mdbook handles theming by applying a class to the
<html>event.You might need to either:
Both things can be tried out in your own project by modifying the additional JS or CSS files.
If that leads to a more general solution we might be able to bring this back into this plugin.