mermaid

(โ˜… 89,874)

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

Showing a partial file list โ€” download the zip above to see everything.

  • .ackrc
  • .editorconfig
  • .fallowrc.json
  • .gitattributes
  • .gitignore
  • .hadolint.yaml
  • .lintstagedrc.mjs
  • .node-version
  • .npmrc
  • .prettierignore
  • .prettierrc.json
  • CHANGELOG.md
  • CITATION.cff
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • cspell.config.yaml
  • docker-compose.yml
  • Dockerfile
  • eslint.config.js
  • FUNDING.json
  • LICENSE
  • netlify.toml
  • package.json
  • README.md
  • README.zh-CN.md

# Installation Guide

1. Get the code
git clone https://github.com/mermaid-js/mermaid

Downloads the entire project code from GitHub to your computer.

cd mermaid

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm publish

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation