48

GitHub - abrochard/mermaid-mode: Emacs major mode for working with mermaid graph...

 4 years ago
source link: https://github.com/abrochard/mermaid-mode
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md

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 Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK