Edit, preview and share mermaid charts/diagrams.

• 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

You can try out a live version.

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

docker run --platform linux/amd64 --publish 8000:8080 ghcr.io/mermaid-js/mermaid-live-editor

The published docker image is built using our default environment variables. You cannot override them when running the image. If you need to customize them, you will need to build the image yourself.

When building set the MERMAID_RENDERER_URL build argument to the rendering service. Example: Default ishttps://mermaid.ink. Set to empty string to disable PNG and SVG links under Actions

When building set the MERMAID_KROKI_RENDERER_URL build argument to your Kroki instance. Default is https://kroki.io Set to empty string to disable Kroki link under Actions

When building set the MERMAID_ANALYTICS_URL build argument to your plausible instance, and MERMAID_DOMAIN to your domain.

Default is empty, disabling analytics.

When building set the MERMAID_IS_ENABLED_MERMAID_CHART_LINKS build argument to true

Default is empty, disabling button to save to Mermaid Chart and promotional banner.

The modal shown on clicking the security link assumes analytics, renderer, Kroki and Mermaid chart are enabled. You can update it by modifying Privacy.svelte if you wish.

docker compose up --build

Then open http://localhost:3000

docker build -t mermaid-js/mermaid-live-editor .

docker run --detach --name mermaid-live-editor --publish 8080:8080 mermaid-js/mermaid-live-editor

Visit: http://localhost:8080

docker stop mermaid-live-editor

Below link will help you making a copy of the repository in your local system.

https://docs.github.com/en/get-started/quickstart/fork-a-repo

• Node.js current LTS version
• pnpm package manager. Install with corepack enable pnpm

pnpm install
pnpm dev -- --open

This app is created with Svelte Kit.

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.