mermaid

<!DOCTYPE html> <html> <head> <title>mermaidCLI.md</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="../doc-style.css" /> <script src="../doc-filelist.js"></script> <script> var relativeDir = "../", thisFile = "Users/knut/Documents/source/mermaid/docs/mermaidCLI.md", defaultSidebar = true; </script> <script src="../doc-script.js"></script> <script src="../mermaid.js"></script> <link rel="stylesheet" href="../mermaid.css" /> </head> <body> <div id="sidebar_wrapper"> <div id="sidebar_switch"> Files Headings </div> <div id="tree"></div> <div id="headings"> <div class="heading h1"> <a href="#mermaid CLI">mermaid CLI</a> </div> <div class="heading h2"> <a href="#Usage">Usage</a> </div> <div class="heading h2"> <a href="#Sequence diagram configuration">Sequence diagram configuration</a> </div> <div class="heading h2"> <a href="#CLI Known Issues">CLI Known Issues</a> </div> </div> </div> <div id="sidebar-toggle"></div> <div id="container"><div class="docs markdown"><div class="pilwrap" id="mermaid CLI"> <h1> <a href="#mermaid CLI" name="mermaid CLI" class="pilcrow">¶</a> mermaid CLI</h1> </div> Installing mermaid globally (<code>npm install -g mermaid</code>) will expose the <code>mermaid</code> command to your environment, allowing you to generate PNGs from any file containing mermaid markup via the command line. Note: The <code>mermaid</code> command requires <a href="http://phantomjs.org/">PhantomJS</a> (version <code>^1.9.0</code>) to be installed and available in your $PATH, or you can specify it's location with the <code>-e</code> option. For most environments, <code>npm install -g phantomjs</code> will satisfy this requirement. <div class="pilwrap" id="Usage"> <h2> <a href="#Usage" name="Usage" class="pilcrow">¶</a> Usage</h2> </div> <div class="highlight"><pre><code>$ mermaid --help Usage: mermaid [options] file... file The mermaid description file to be rendered Options: -s --svg Output SVG instead of PNG (experimental) -p --png If SVG was selected, and you also want PNG, set this flag -o --outputDir Directory to save files, will be created automatically, defaults to `cwd` -e --phantomPath Specify the path to the phantomjs executable -c --sequenceConfig Specify the path to the file with the configuration to be applied in the sequence diagram -h --help Show this message -v --verbose Show logging --version Print version and quit </code></pre></div> <div class="highlight"><pre><code>mermaid testGraph.mmd </code></pre></div> <div class="pilwrap" id="Sequence diagram configuration"> <h2> <a href="#Sequence diagram configuration" name="Sequence diagram configuration" class="pilcrow">¶</a> Sequence diagram configuration</h2> </div> The --sequenceConfig option allows overriding the sequence diagram configuration. It could be useful to increase the width between actors, the notes width or the margin to fit some large texts that are not well rendered with the default configuration, for example. The content of the file must be a JSON like this: <div class="highlight"><pre><code>{ diagramMarginX: 100, diagramMarginY: 10, actorMargin: 150, width: 150, height: 65, boxMargin: 10, boxTextMargin: 5, noteMargin: 10, messageMargin: 35 } </code></pre></div> These properties will override the default values and if a property is not set in this object, it will left it empty and could raise an error. The current properties (measured in px) are: <ul> <li>diagramMarginX: Size of the empty space to add at the left-right of the diagram.</li> <li>diagramMarginY: Size of the empty space to add at the top-bottom of the diagram.</li> <li>actorMargin: Horizontal space between each participant. The arrows between them would have this size too.</li> <li>width: Width of the participant box.</li> <li>height: Height of the participant box.</li> <li>boxMargin: Blank area around loop boxes.</li> <li>boxTextMargin: Blank area between the text and the border in a loop box.</li> <li>noteMargin: Size of the empty space around a note.</li> <li>messageMargin: Space between messages</li> </ul> <div class="pilwrap" id="CLI Known Issues"> <h2> <a href="#CLI Known Issues" name="CLI Known Issues" class="pilcrow">¶</a> CLI Known Issues</h2> </div> <ul> <li>SVG output currently does some replacement on text, as mermaid's SVG output is only appropriate for browsers. Text color and background color is not yet replicated; please use PNGs for most purposes until this is resolved.</li> <li>SVG output is decidedly non-standard. It works, but may cause issues in some viewers.</li> </ul> </div> </div> </body> </html>