Mermaid

From My Mnemonic Rhyme
Revision as of 20:10, 22 March 2023 by Weiss (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Usage: mmdc [options]

Options:
  -V, --version                                   output the version number
  -t, --theme [theme]                             Theme of the chart (choices: "default", "forest", "dark", "neutral", default:
                                                  "default")
  -w, --width [width]                             Width of the page (default: 800)
  -H, --height [height]                           Height of the page (default: 600)
  -i, --input <input>                             Input mermaid file. Files ending in .md will be treated as Markdown and all
                                                  charts (e.g. ```mermaid (...)```) will be extracted and generated. Use `-` to
                                                  read from stdin.
  -o, --output [output]                           Output file. It should be either md, svg, png or pdf. Optional. Default: input
                                                  + ".svg"
  -e, --outputFormat [format]                     Output format for the generated image. (choices: "svg", "png", "pdf", default:
                                                  Loaded from the output file extension)
  -b, --backgroundColor [backgroundColor]         Background color for pngs/svgs (not pdfs). Example: transparent, red,
                                                  '#F0F0F0'. (default: "white")
  -c, --configFile [configFile]                   JSON configuration file for mermaid.
  -C, --cssFile [cssFile]                         CSS file for the page.
  -s, --scale [scale]                             Puppeteer scale factor (default: 1)
  -f, --pdfFit [pdfFit]                           Scale PDF to fit chart
  -q, --quiet                                     Suppress log output
  -p --puppeteerConfigFile [puppeteerConfigFile]  JSON configuration file for puppeteer.
  -h, --help                                      display help for command
mmdc -i MontyHallLogicFlowchart.md -e png
mmdc -i MontyHallLogicFlowchart.md -w 2560 -H 1440 -e png -s 10