/mermaid-live-editor

Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.

Primary LanguageTypeScriptMIT LicenseMIT

Mermaid Live Editor Join our Slack!Netlify Status

Contributors are welcome!

If you want to speed up the progress for mermaid-live-editor, join the slack channel and contact knsv.

mermaid-live-editor

Edit, preview and share mermaid charts/diagrams.

Features

  • Edit and preview flowcharts, sequence diagrams, gantt diagrams in real time.
  • Save the result as a svg
  • Get a link to a viewer of the diagram so that you can share it with others.
  • Get a link to edit the diagram so that someone else can tweak it and send a new link back

Live demo

You can try out a live version here.

Docker

Run published image

docker run --publish 8000:80 ghcr.io/mermaid-js/mermaid-live-editor

To configure renderer URL

When building, Set the Environment variable MERMAID_RENDERER_URL to the rendering service. Default is https://mermaid.ink

Development

docker compose up --build

Then open http://localhost:8000

Setup

Volta is used for managing node and yarn versions.

This project is set up using Yarn:

yarn install

Development

yarn dev -- --open

This app is created with Svelte Kit.

Release

When a PR is created targeting master, it will be built and deployed by Netlify. The URL will be indicated in a Comment in the PR.

Once the PR is merged, it will automatically be released.