Generate mermaid diagrams using org-mode, org-babel and mermaid.cli.
If you use Spacemacs, use the mermaid Spacemacs layer.
- Install package from Melpa
- Install mermaid.cli
- Specify
mmdc
executable path:(setq ob-mermaid-cli-path "/your-installating-path/node_modules/.bin/mmdc")
- Add
mermaid
toorg-babel-load-languages
(org-babel-do-load-languages 'org-babel-load-languages '((mermaid . t) (scheme . t) (your-other-langs . t)))
- Open
org-mode
buffer and create anorg-babel
source block:#+begin_src mermaid :file test.png sequenceDiagram A-->B: Works! #+end_src
sequenceDiagram A-->B: Works!
- Exporting the
org-mode
document or invoking theorg-babel-execute-src-block
function to generate diagram.
file
- Output file. It should be either svg, png or pdf.
width
- Width of the page. Optional.
height
- Height of the page. Optional.
theme
- Theme of the chart, could be default, forest, dark or neutral. Optional.
background-color
- Background color. Example: transparent, red, โ#F0F0F0โ. Optional.
mermaid-config-file
- JSON configuration file for mermaid. Optional.
css-file
- CSS file for the page. Optional.
pupeteer-config-file
- JSON configuration file for puppeteer. Optional.