-
Notifications
You must be signed in to change notification settings - Fork 35
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.
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
feat: add mermaid docs and sensible defaults #314
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Just a couple of changes on some darker themes that need dark
. Feel free to double check them.
I actually tested this while adding mermaid support but somehow it looked like crap for me. I definitely was using the wrong parameter combo because it looks so much better this way. Thanks!
@mfontanini, I used Here is But I can update all of them |
Hmm can you try a |
Hmm now that I remember... When I was testing this I was trying it with pie charts. It's possible those look like crap in dark mode, I'm not sure. I'm away from computer now so I can't test those. |
So weird, I wonder what exact combo I tried. Maybe I missed |
Thank you sir! |
Hello!
Changes:
transparent
(this seems to be how Github renders mermaid charts)I noticed that the
mermaid
theme parameters didn't make it into the documentation so I decided to add it.I also tried to add sensible mermaid theme defaults to better match the supported themes instead of always having to override the theme. For instance, on the
dark
theme the original mermaid defaults (bg: white, theme: default) are quite jarring:But updating to (bg: transparent, theme: dark) looks much nicer:
Thanks!