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

feat: support for mermaid diagrams #145

Closed
wants to merge 0 commits into from

Conversation

LachlanNewman
Copy link
Contributor

@LachlanNewman LachlanNewman commented Dec 13, 2022

This PR is to support rendering mermaid diagrams.

Closes #124.

@simonhaenisch
Copy link
Owner

simonhaenisch commented Dec 13, 2022

Cool thanks, however could I ask that you turn your code into a marked-mermaid extension (i.e. npm package)? See https://marked.js.org/using_pro#extensions and https://marked.js.org/using_advanced#extensions. Then you can just pass it into marked_extensions via config (after #140 is merged).

If the module is small enough and doesn't have a performance impact, then we can add it by default as well.

@giuliboy
Copy link

+1
would love having mermaid support.
currently we're using an overengineered Pandoc (md->latex->pdf) pipeline that is un-maintainable and we're looking for an alternative service that provides the same UX and similar results for the use case of bringing our Azure DevOps markdown wikis to PDF.

@simonhaenisch
Copy link
Owner

@LachlanNewman did you ever get around to publishing a mermaid extension for marked? If not, would you mind if I do it based on your code?

@LachlanNewman
Copy link
Contributor Author

LachlanNewman commented Feb 27, 2023

@simonhaenisch sure go ahead I've just reopened the pull request so we can look at implementing this together. Last time I ran into an issue with passing the extension that's actually the reason I was going to try to put this in the library rather than make it an extension

@LachlanNewman LachlanNewman reopened this Feb 27, 2023
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@simonhaenisch could we have this extension built in. because it requires loading the mermaid executable into the browsers to render the diagrams?

@neiroc
Copy link

neiroc commented Sep 18, 2023

any news about this feature?

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

Successfully merging this pull request may close these issues.

feature: Render inline mermaidjs blocks
4 participants