/mermaid-js-converter

Primary LanguageJavaScriptMIT LicenseMIT

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 myMD.md myMD-out.md -t svg
Arguments:
  input              md file for converting
  output             md file for save

Options:
  -t, --type <type>  type converting file (choices: "svg", "png", "md")
  --use-kroki        use kroki for converting
  --use-link         add link on live editor mermaid
  -s --style <file>  use style json file into mermaid
  -h, --help         display help for command

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