99255ab693
* develop: (101 commits) fix: Flickering when rendering, PanZoom & Rough mode combined chore: Simplify queueing logic fix: Blank screen on initial load chore: Add delay for playground toggle fix: Record correct diagram type, send playground toggle event immediately. chore(deps): update dependency autoprefixer to v10.4.21 chore(deps): update all non-major dependencies chore(deps): update dependency typescript to v5.8.2 chore(deps): update all non-major dependencies build: update Browserslist db Use netlify to redirect users chore: Add sitemap to robots.txt fix: Add redirect for /index.html chore: Add sitemap fix: Do not index /view page chore(deps): update all non-major dependencies feat: Pause banner animation when mouse is on the banner fix: Layout for banner use snippets update urls and styling ...
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 --platform linux/amd64 --publish 8000:8080 ghcr.io/mermaid-js/mermaid-live-editor
To configure renderer URL
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
To configure Kroki Instance URL
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
To configure Analytics
When building set the MERMAID_ANALYTICS_URL build argument to your plausible instance, and MERMAID_DOMAIN to your domain.
Default is empty, disabling analytics.
To enable Mermaid Chart links and promotion
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.
To update the Security modal
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.
Development
docker compose up --build
Then open http://localhost:3000
Building and running images locally
Build
docker build -t mermaid-js/mermaid-live-editor .
Run
docker run --detach --name mermaid-live-editor --publish 8080:8080 mermaid-js/mermaid-live-editor
Visit: http://localhost:8080
Stop
docker stop mermaid-live-editor
Setup
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
Requirements
Development
yarn install
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.