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.js support #130

Open
brownsarahm opened this issue Feb 23, 2023 · 1 comment
Open

Mermaid.js support #130

brownsarahm opened this issue Feb 23, 2023 · 1 comment

Comments

@brownsarahm
Copy link

We've been looking for good ways to include diagrams and I think mermaid is a good solution now.

I cannot figure out how to determine if it is supported or how to support it in the workbench, I think this is related to #115 conceptually. I know how to dig through a python based system for its dependencies and I have had trouble figuring out the packaging strucutre and dependencies for this.

For example, I knew for incorporating mermaid into jupyterbook, I needed to look for a sphinx extension that supported mermaid.

@zkamvar
Copy link
Contributor

zkamvar commented Mar 6, 2023

Luckily, support in The Workbench can be added by updating the HTML headers (see the MathJax implementation) and JavaScript in {varnish}: carpentries/varnish#34

The only downside is that the diagrams will not show offline, only the code block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants