Mermaid Diagram Generator Server

Mermaid Diagram Generator Server

site icon
2025.03.18 2
Python图表生成Mermaid 语法转换内容生成
Mermaid Diagram Generator Server 是一个基于 Flask 的简单服务器,用于从 Mermaid 语法生成图表。它利用 mermaid-cli 工具将 Mermaid 代码转换为可视化的图表,支持多种主题和背景选项。
View on GitHub

Overview

基本能力

产品定位

Mermaid Diagram Generator Server 是一个图表生成服务,专门用于将 Mermaid 语法转换为可视化的图表。

核心功能

  1. 支持通过 Mermaid 语法生成图表。
  2. 提供 Web 界面和 API 端点两种使用方式。
  3. 支持多种主题(default, dark, forest, neutral)和背景(white, transparent)选项。
  4. 自动清理临时文件,避免存储空间浪费。

适用场景

  1. 开发者在文档中需要嵌入图表时。
  2. 团队协作中需要快速生成和分享图表时。
  3. 自动化流程中需要动态生成图表时。

工具列表

  1. mermaid-cli:用于将 Mermaid 语法转换为图表的命令行工具。

常见问题解答

  1. mermaid-cli 未安装或不在 PATH 中:确保已全局安装 mermaid-cli 并正确配置 PATH。
  2. Mermaid 语法无效:检查输入的 Mermaid 代码是否符合语法规范。
  3. 临时文件权限问题:确保 temp_files 目录存在并有适当的权限。

使用教程

使用依赖

  1. 安装 Python 3.7+。
  2. 安装 Node.js 和 npm。
  3. 全局安装 mermaid-cli: bash npm install -g @mermaid-js/mermaid-cli

安装教程

  1. 克隆仓库。
  2. 安装 Python 依赖: bash pip install -r requirements.txt
  3. 确保 mermaid-cli 已全局安装: bash npm install -g @mermaid-js/mermaid-cli

调试方式

  1. 启动服务器: bash python server.py
  2. 访问 Web 界面:http://localhost:5000
  3. 使用 API 端点生成图表: bash curl -X POST http://localhost:5000/generate \ -H "Content-Type: application/json" \ -d '{"mermaid":"graph TD\nA[Client] --\u003e B[Load Balancer]"}' \ --output diagram.png
  4. 运行测试脚本: bash python test.py

许可证

None