{"repo":"mermaid-js/mermaid-cli","free":true,"listed":false,"github":"https://github.com/mermaid-js/mermaid-cli","clone":"git clone https://github.com/mermaid-js/mermaid-cli.git","description":"Command line tool for the Mermaid library","language":"JavaScript","stars":4941,"topics":["diagrams","cli","mermaid"],"license":"MIT","category":"cli-tools","readme_excerpt":"mermaid-cli This is a command-line interface (CLI) for mermaid. It takes a mermaid definition file as input and generates an SVG/PNG/PDF file as output. Installation Usage Convert Mermaid mmd Diagram File To SVG Note See Alternative installations if you don't want to install the package globally. Locate how to call the mmdc executable for your preferred method i.e. Docker, Yarn, NPM, local install, etc. Examples Create A PNG With A Dark Theme And Transparent Background Animating an SVG file with custom CSS The --cssFile option can be used to inline some custom CSS. Please see ./test-positive/flowchart1.css for an example of a CSS file that has animations. Warning : If you want to override mermaid 's themeCSS , we recommend instead adding {\"themeCSS\": \"...\"}) to your mermaid --configFile . You may also need to use !important to override mermaid's themeCSS . Warning : Inline CSS files may be blocked by your browser, depending on the HTTP Content-Security-Policy header of the website that hosts your SVG. Example output: docs/animated-flowchart.svg Transform a markdown file with mermaid diagrams This command transforms a markdown file itself. The mermaid-cli will find the mermaid diagrams, create SVG files from them and refer to those in the markdown output. This: mermaid graph [....] mermaid sequenceDiagram [....] mermaid graph accTitle: My title here accDescr: My description here A-- B Becomes: Piping from stdin You can easily pipe input from stdin. This example shows how to us","default_branch":null,"files":null,"tree":[],"storefront":"/r/mermaid-js","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/mermaid-js/mermaid-cli/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}