Smart Mermaid：用文字快速生成流程图和时序图的AI工具

Smart Mermaid 是一个开源的 AI 驱动 Web 应用程序，专注于将用户输入的自然语言文本转换为 Mermaid 格式代码，并生成可视化图表。它通过 AI 技术简化了图表绘制过程，省去了手动编写复杂代码的麻烦。用户只需用简单的文字描述业务流程或逻辑，Smart Mermaid 就能智能解析并生成流程图、时序图、类图等多样化图表。项目支持 Docker 一键部署，适合开发者、产品经理和需要快速生成专业图表的人群使用。代码托管在 GitHub，拥有 810 个星标和 92 次分支，显示了社区的活跃支持。

功能列表

• 自然语言生成图表：用户输入文字描述，AI 自动解析并生成 Mermaid 格式的图表代码。
• 支持多种图表类型：包括流程图、时序图、类图、甘特图和架构图等，覆盖常见业务场景。
• 自定义 AI 配置：支持配置 AI 服务（如 API 地址和密钥），满足个性化需求。
• 专业图表编辑：提供编辑和预览功能，支持多种渲染模式，提升图表专业性。
• Docker 一键部署：通过 Docker 快速搭建本地或服务器环境，方便使用。
• 访问控制：支持设置访问密码，保护用户生成的内容。

使用帮助

安装流程

Smart Mermaid 支持通过 Docker 快速部署，以下是详细安装步骤：

1. 克隆代码仓库
   在终端运行以下命令，将项目克隆到本地：

   git clone https://github.com/liujuntao123/smart-mermaid.git
   cd smart-mermaid
   

2. 切换到 Docker 分支
   注意：主分支不包含 Docker 配置文件，需切换到 docker 分支：

   git checkout docker
   

3. 配置 AI 服务
   Smart Mermaid 依赖外部 AI 服务（如 OpenAI API）来解析文本。需要配置以下环境变量：
   • 编辑 docker-compose.yml 或环境变量文件，添加以下内容：

     AI_API_URL=https://api.openai.com/v1
     AI_API_KEY=你的API密钥
     AI_MODEL_NAME=gpt-3.5-turbo
     

   • 如果需要访问控制，设置：

     ACCESS_PASSWORD=你的访问密码
     

4. 启动服务
   使用 Docker Compose 启动服务：

   docker-compose up -d
   

   服务启动后，Smart Mermaid 将运行在本地 http://localhost:3000。

5. 访问应用
   打开浏览器，访问 http://localhost:3000。如果设置了访问密码，输入密码即可进入操作界面。

主要功能操作

1. 生成图表

• 操作步骤：
  1. 在主页的文本输入框中，输入描述业务流程的自然语言文字。例如：“用户登录系统，系统验证身份，成功后进入主页，失败则提示错误。”
  2. 点击“生成”按钮，AI 将分析文本并生成对应的 Mermaid 代码。
  3. 系统会自动选择合适的图表类型（如流程图或时序图），也可手动指定类型。
  4. 生成的图表会显示在右侧预览区域，支持实时调整。
• 注意事项：
  • 输入文字尽量清晰，描述逻辑关系，避免模糊语句。
  • 最大支持 20,000 字符输入，每日生成次数限制为 5 次（可通过配置文件 NEXT_PUBLIC_DAILY_USAGE_LIMIT 修改）。

2. 编辑与导出

• 编辑图表：
  • 点击预览区域的“编辑”按钮，可直接修改 Mermaid 代码。
  • 调整代码后，图表会实时更新，方便快速调试。
• 导出图表：
  • 支持将图表导出为 SVG、PNG 或 Mermaid 代码文件。
  • 点击“导出”按钮，选择格式并下载到本地。
• 渲染模式：
  • 支持多种渲染模式（如暗色或亮色主题），在设置中切换。

3. 自定义配置

• AI 服务配置：
  • 在 docker-compose.yml 中修改 AI_API_URL 和 AI_API_KEY，支持接入其他 AI 服务（如本地部署的模型）。
  • 可调整 AI_MODEL_NAME 使用不同模型，优化生成效果。
• 访问限制：
  • 设置 ACCESS_PASSWORD 后，只有输入正确密码的用户才能访问应用，适合团队内部使用。

4. 查看历史记录

• 生成的图表会保存在本地会话中，点击“历史记录”可查看之前生成的图表。
• 支持重新编辑或删除历史图表，方便管理。

常见问题解决

• AI 解析失败：检查 AI_API_KEY 是否有效，确保网络连接正常。
• Docker 启动报错：确认已切换到 docker 分支，检查 docker-compose.yml 配置是否正确。
• 图表显示异常：确保输入的 Mermaid 代码语法正确，可参考 Mermaid 官方文档（https://mermaid.js.org）。

应用场景

1. 产品经理设计业务流程
   产品经理需要快速制作流程图或时序图来描述业务逻辑。Smart Mermaid 允许他们用自然语言输入需求，快速生成专业图表，节省时间。
2. 开发者文档编写
   开发者在编写技术文档时，可用 Smart Mermaid 快速生成架构图或类图，嵌入到 Markdown 文件中，提升文档可读性。
3. 团队协作与演示
   团队在讨论项目时，可通过 Smart Mermaid 生成图表并导出，用于 PPT 或在线演示，方便沟通。
4. 教育与培训
   教师或培训师可以用 Smart Mermaid 将复杂的逻辑关系转化为直观图表，帮助学生理解。

QA

1. Smart Mermaid 支持哪些图表类型？
   支持流程图、时序图、类图、甘特图和架构图等多种类型，覆盖大多数业务场景。
2. 如何确保 AI 生成的图表准确？
   输入清晰的文字描述，明确逻辑关系。生成后可手动编辑 Mermaid 代码，确保图表符合需求。
3. 是否需要编程经验？
   不需要。Smart Mermaid 通过自然语言生成图表，适合非程序员使用。开发者可进一步编辑代码以优化。
4. Docker 部署需要哪些前置条件？
   需要安装 Git 和 Docker Compose，确保网络可访问 AI 服务（如 OpenAI API）。