Mermaid Image Uploader

将Mermaid图表转换为图片,上传至免费图床,并返回适用于Markdown文件及单个图表的图片链接。

安装

概览

Mermaid Image Uploader 是一款专为开发者和技术写作者设计的自动化工具,能够将 Mermaid 图表代码转换为高质量图片,并自动上传至多个免费图床服务,最终生成可直接嵌入 Markdown 文档或网页的图片链接。该工具特别适用于需要将流程图、时序图、甘特图等可视化内容集成到技术文档、博客文章或公众号推文的场景。通过简单的命令行操作或 Python API,用户可以快速完成从代码到可分享图片链接的全流程处理,极大提升了技术内容发布的效率与一致性。 工具支持多种主流图床平台,包括 Imgur、FreeImage.host、Postimages 和 Cloudinary,部分平台需配置 API Key。用户可根据访问速度、稳定性及是否需要注册账户等因素灵活选择。此外,Mermaid Image Uploader 不仅支持单个图表的转换与上传,还能批量扫描并替换 Markdown 文件中的所有 Mermaid 块为对应的图片 URL,非常适合维护大型技术文档库或定期更新教程类内容。整个流程无需手动截图、保存再上传,实现真正的“一键发布”。 该项目采用 MIT 许可证开源,结构清晰,包含完整的示例代码与详细使用说明。无论是独立开发者、技术博主,还是团队协作中的文档工程师,都能借助此工具简化图表管理流程,确保图文内容在各类平台上的展示效果统一且高效。

核心功能特点

  1. 将 Mermaid 代码实时转换为 PNG、SVG 或 JPG 格式的高质量图片
  2. 支持多个免费图床自动上传(如 Imgur、FreeImage.host、Postimages)
  3. 自动生成可直接嵌入 Markdown 或网页的图片 URL 链接
  4. 支持批量处理 Markdown 文件中的多个 Mermaid 图表并统一替换
  5. 提供命令行接口与 Python API 双重使用方式,便于集成到工作流中

适用场景

Mermaid Image Uploader 最典型的应用场景是技术写作与文档维护。例如,当你在撰写一篇关于系统架构的技术博客时,通常会使用 Mermaid 绘制组件交互图或数据流向图。传统做法需要手动导出为图片、上传到图床、复制链接再插入 Markdown 编辑器,过程繁琐且容易出错。而使用该工具后,只需一行命令即可将 `.mmd` 文件转为图片并获取公网链接,直接粘贴进文章即可。对于微信公众号等国内平台,选择 FreeImage.host 这类无需 API Key 且访问快速的图床尤为重要,能有效避免外链被拦截的问题。 另一个高频使用场景是团队协作中的知识沉淀。在一个敏捷开发项目中,产品、开发和测试人员可能频繁更新需求流程图或测试用例时序图。若这些图表仍以原始 Mermaid 代码形式存在于 Wiki 或 Confluence 页面中,阅读体验较差。通过脚本批量将项目内的所有 Mermaid 块渲染为图片并托管到稳定图床,能显著提升文档可读性和加载速度。尤其当文档数量庞大时,自动化处理比人工干预更高效可靠。 此外,该工具也适合教学场景。教师在制作在线课程或发布学习笔记时,常需展示算法执行过程或 UML 类图。利用 Mermaid Image Uploader 可快速生成清晰图示,并确保学生无论在国内还是海外都能顺畅查看。由于输出的是标准图片而非嵌入式 SVG,兼容性强,适配各种阅读器和设备屏幕。整体而言,该工具填补了 Mermaid 生态在“可视化发布”环节的空白,成为连接代码思维与大众理解的重要桥梁。