Skip to content

KeyWeeUsr/mermaid-docker-mode

Repository files navigation

mermaid-docker-mode

MELPA MELPA Stable CI Coverage Status Buy me a coffee Liberapay PayPal

Render mermaid graphs with Docker service

This library attempts to create Mermaid graphs via the official mermaid-cli using the official Docker image and restricting network access, so that you are sure nothing gets out and your system is kept isolated from random Node.js deps/files noise all around the filesystem.

How to

Install it from Melpa or clone and install manually, then:

  1. Have mermaid-mode installed.
  2. Run the install function M-x mermaid-docker-install
  3. Activate this mode with M-x mermaid-docker-mode
  4. After successful installation C-c C-c for mermaid-mode is patched and renders the graphs via Docker container

Customization

By default the rendering is set to happen in an external viewer (such as xviewer) and can be changed to any other binary or set to render within Emacs itself via inserting an image into a new buffer.

Make sure to check related defconst parts of the file to customize.