Sidharth Vinod
6dc24ded90
* master-holder: (72 commits) Release 1.22.10 Clipboard icon Release 1.22.10 Space for tabs Release 1.22.10 Nojekyll Release 1.22.10 Fix path Release 1.22.10 Disable jekyll Release 1.22.10 Fix base path Release 1.22.10 Hide editor on mobile Remove netlify Remove doce Try netlify Release 1.22.10 Rename branch Deploy ...
59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
[](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
|
|
|
|
# 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-js.github.io/mermaid-live-editor/).
|
|
|
|
## Setup
|
|
|
|
[Volta](https://volta.sh) is used for managing node and yarn versions.
|
|
|
|
This project is set up using [Yarn](https://classic.yarnpkg.com/en/docs/getting-started). :
|
|
|
|
```
|
|
yarn install
|
|
```
|
|
|
|
or in develop branch to use the beta version of mermaid use
|
|
|
|
```
|
|
yarn install --update-checksums
|
|
```
|
|
|
|
This together with a .npmrc file:
|
|
|
|
```
|
|
registry=https://registry.npmjs.com/
|
|
@mermaid-js:registry=https://npm.pkg.github.com
|
|
//npm.pkg.github.com/:_authToken="XXXXXXXXX"
|
|
```
|
|
|
|
## Development
|
|
|
|
```
|
|
yarn dev -- --open
|
|
```
|
|
|
|
This app is created with Svelte + svelte-spa-router.
|
|
|
|
## Release
|
|
|
|
```
|
|
yarn release
|
|
```
|