Skip to content

abrochard/mermaid-mode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 

Repository files navigation

MELPA

mermaid-mode

Emacs major mode for working with mermaid graphs

alt text

Installation

  1. Install from Melpa or load the mermaid-mode.el file
  2. Install mmdc binary from the mermaid.cli project if you plan to compile graphs in Emacs

Usage

Currently supporting flow charts and sequence diagrams with syntax coloring and indentation.

C-c C-c to compile to an image
C-c C-o to open in the live editor
C-c C-d to open the official doc

Customization

You can specify the location of mmdc with the variable mermaid-mmdc-location, the default assumes you have the binary in your exec PATH.

By default mmdc will compile to png format. You can change that by setting the variable mermaid-output-format.

Bugs & Issues

Feel free to open an issue!

About

Emacs major mode for working with mermaid graphs https://mermaidjs.github.io/

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published