Skip to content

superj80820/mermaid-js-converter

Repository files navigation

mermaid-js-converter

You can use command line to convert Mermaid's Markdown format into a more general SVG.

Requires

Install

$ npm install -g mermaid-js-converter

How to use

Add mermaid to the code block in Markdown to make this tool detect conversion. Like example.md

Then execute the conversion command line.

$ mjc -f myMD.md -o SVG
  • -f: File name
  • -o: Output format
    • md: SVG to markdown
    • SVG: Markdown to SVG

Why this repository

Mermaid is a very cool development tool.

Although Gitlab has been supported, it is not supported Github.

This repository is affected by this issue inspired.

If the Markdown of a website does not support Mermaid, you can use this tool.

Of course, it would be better if Mermaid could be listed as a Markdown standard.

Support

  • Flow Chart
  • Sequence Diagram
  • Class Diagram
  • State Diagram
  • Gantt Chart
  • Pie Chart
  • ER Diagram
  • User Journey

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published