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

Initial support for mermaid.js in markdown #17

Merged
merged 1 commit into from
Dec 20, 2023

Conversation

ZakarFin
Copy link
Member

Enables rendering diagrams like this:
image

Using snippets like this on the md-files under documentation:

 ```mermaid
sequenceDiagram
    Alice->John: Hello John, how are you?
    loop Every minute
        John-->Alice: Great!
    end

It's a bit slow to render on the client. We should try to make mermaid pre-render the SVG on build instead.

Copy link

vercel bot commented Nov 22, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
oskari-web-nextjs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 22, 2023 10:14am

@ZakarFin
Copy link
Member Author

Looks like server-side rendering is not supported on mermaid js at least yet: mermaid-js/mermaid#3650

https://github.com/hikerpig/pintora could be an option as well as it could be used to generate the SVG when building the docs.

@ZakarFin
Copy link
Member Author

@ZakarFin ZakarFin marked this pull request as ready for review December 18, 2023 12:44
@testomuli testomuli merged commit cc30922 into oskariorg:master Dec 20, 2023
2 checks passed
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.

2 participants