Docsify example

工作流名称

Docsify example

主要功能和亮点

该工作流集成了Docsify文档库，自动生成并管理n8n工作流的文档页面。支持实时查看、编辑和保存Markdown格式的工作流文档，同时内置Mermaid图表渲染，能够将工作流节点和连接关系以流程图形式直观展示。工作流还实现了文档的自动生成、自动更新和文件管理，包含自定义样式和编辑器界面，提升文档编写和维护效率。

解决的核心问题

• 自动化生成和维护n8n工作流文档，解决手工编写文档繁琐、易遗漏的问题
• 提供实时在线Markdown文档编辑和预览功能，避免多工具切换，提高编辑便捷性
• 将复杂的工作流结构通过流程图直观展示，帮助团队快速理解工作流逻辑
• 集中文档管理，方便查看所有工作流状态及历史更新，提升团队协作透明度

应用场景

• DevOps或自动化团队需管理大量n8n工作流文档的场景
• 需要在线编辑和实时预览工作流文档的技术团队
• 需要快速浏览、理解和维护复杂自动化流程的项目管理和运维人员
• 以Markdown格式输出文档，方便集成到知识库、Wiki或版本控制系统

主要流程步骤

1. 接收请求：通过Webhook接收文档查看、编辑、保存等操作请求。
2. 配置初始化：读取项目路径、实例URL及HTML模板样式等配置。
3. 文件处理：判断文档文件是否存在，存在则加载，不存在则自动生成基本文档模板。
4. 工作流数据获取：从n8n实例获取指定工作流的详细信息。
5. 文档生成：调用LLM（如OpenAI GPT-4 Turbo）自动生成工作流说明和节点配置文档。
6. Mermaid图表生成：生成工作流节点及连接的流程图代码，支持图形化展示。
7. 文档编辑器：提供基于Docsify和自定义样式的在线Markdown编辑器，支持实时预览和保存。
8. 文件写入：将编辑或自动生成的文档保存至指定目录。
9. 响应客户端：根据请求类型返回HTML页面或Markdown内容，实现文档浏览和编辑。

涉及的系统或服务

• n8n API：获取工作流信息及管理文档文件
• Webhook：接收和响应文档相关的HTTP请求
• OpenAI GPT-4 Turbo：自动生成工作流说明文档内容
• Docsify：实现文档的前端展示和实时渲染
• Mermaid.js：绘制工作流节点流程图
• 文件系统操作节点：读取和写入Markdown文档文件

适用人群或使用价值

• n8n自动化工作流开发者和维护者
• 需系统化管理和共享自动化流程文档的技术团队
• 希望提升工作流文档编写效率和质量的项目管理者
• 需要通过可视化图表辅助理解流程的人群

该工作流通过整合自动化文档生成、在线编辑和流程图展示，极大简化了n8n工作流的文档维护工作，提升团队协作效率和文档质量。