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.

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

Mermaid support #495

Open
garrett opened this issue Feb 17, 2022 · 0 comments
Open

Mermaid support #495

garrett opened this issue Feb 17, 2022 · 0 comments
Assignees

Comments

@garrett
Copy link
Member

garrett commented Feb 17, 2022

As GitHub has Mermaid support for issues, pull requests, and rendered Markdown (on the site), we might want to support Mermaid in-page on the website as well.

The best way to do this would be in-browser, client-side, so we can preserve the GitHub Pages ease of use, including forked previews.

https://github.com/mermaid-js/mermaid/blob/develop/docs/usage.md#using-mermaid has instructions.

We'd want to include a mermaid.js inside our website repo (not use a CDN) and point it to rendered code blocks. I'm not sure if we can do that directly via the JS and/or have to do some special handling in Jekyll templates.

It's probably mostly straightforward?

@garrett garrett self-assigned this Feb 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant