Smart Mermaid is a free, AI-powered web application that converts natural language text into Mermaid diagram code, rendering it visually. It targets developers, designers, and technical writers seeking to streamline diagram creation for documentation and presentations. The tool simplifies complex diagramming by leveraging AI to interpret text and generate code, offering both standard Mermaid and hand-drawn Excalidraw rendering modes.

How It Works

The application integrates advanced AI models (e.g., DeepSeek V3, R1) to parse user input, which can be typed directly, pasted, or uploaded via .txt, .md, or .docx files (up to 20,000 characters). It intelligently identifies the appropriate diagram type (flowchart, sequence, Gantt, state) or accepts user specification. Generated Mermaid code is then rendered in real-time, with options for a precise Mermaid renderer or a more artistic, editable Excalidraw renderer.

Quick Start & Requirements

• Docker: git clone https://github.com/liujuntao123/smart-mermaid.git then cd smart-mermaid and docker-compose up -d. Access at http://localhost:3000.
• Local: Node.js 18.x+, npm/yarn. Clone, npm install (or yarn install), create .env.local with AI service configuration, then npm run dev (or yarn dev).
• Prerequisites: AI service API URL, API Key, and Model Name are required for custom configuration and unlimited use.
• Links: Demo

Highlighted Details

• AI-powered text-to-Mermaid conversion with real-time streaming output.
• Dual rendering modes: standard Mermaid and editable Excalidraw (hand-drawn style).
• AI-driven Mermaid code analysis and auto-correction capabilities.
• Supports custom AI service configuration (OpenAI, Azure OpenAI, etc.) for unlimited use.

Maintenance & Community

The project is actively maintained by liujuntao123. Contributions are welcomed via GitHub Issues and Pull Requests.

Licensing & Compatibility

The repository does not explicitly state a license in the README. Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

The free tier is limited to 5 generations per user per day. While the project mentions compatibility with OpenAI API, specific details on other compatible services are not elaborated. The license is not specified, which may impact commercial adoption.