97 lines
2.6 KiB
Markdown
97 lines
2.6 KiB
Markdown
[](https://dashboard.cypress.io/projects/2ckppp/runs) [](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)[](https://app.netlify.com/sites/mermaidjs/deploys)
|
|
|
|
# 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](https://mermaid.live/).
|
|
|
|
## Docker
|
|
|
|
### Run published image
|
|
|
|
```bash
|
|
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.
|
|
Default is `https://mermaid.ink`
|
|
|
|
### To configure Kroki Instance URL
|
|
|
|
When building set the MERMAID_KROKI_RENDERER_URL build argument to your Kroki instance.
|
|
Default is `https://kroki.io`
|
|
|
|
### Development
|
|
|
|
```bash
|
|
docker compose up --build
|
|
```
|
|
|
|
Then open http://localhost:3000
|
|
|
|
### Building and running images locally
|
|
|
|
#### Build
|
|
|
|
```bash
|
|
docker build -t mermaid-js/mermaid-live-editor .
|
|
```
|
|
|
|
#### Run
|
|
|
|
```bash
|
|
docker run --detach --name mermaid-live-editor --publish 8080:8080 mermaid-js/mermaid-live-editor
|
|
```
|
|
|
|
Visit: <http://localhost:8080>
|
|
|
|
#### Stop
|
|
|
|
```bash
|
|
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
|
|
|
|
- [volta](https://volta.sh/) to manage node versions.
|
|
- [Node.js](https://nodejs.org/en/). `volta install node`
|
|
- [yarn](https://yarnpkg.com/) package manager. `volta install yarn`
|
|
|
|
## Development
|
|
|
|
```sh
|
|
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.
|