Документация workflow n8n с OpenAI и Docsify.js
Workflow n8n с OpenAI автоматически создаёт документацию для workflow: портал на Docsify.js показывает список, а для каждого workflow доступны описание и схема Mermaid.js.
Оригинал на n8n.io: 📚 Auto-generate documentation for n8n workflows with GPT and Docsify — Eduard
Открыть шаблон на n8n.io бесплатно- Сложность
- сложный20 видов узлов
- Просмотров на n8n.io
- 12 669
- Опубликован
- Обновлён
- Автор
- Eduardпроверен n8n.io
- Сверено
Что делает шаблон
Портал Docsify.js показывает workflow в таблице с тегами, статусом, датой создания и ссылками на документацию. Для каждого workflow формируются описание и схема структуры в Mermaid.js; формат документации остаётся единым. Встроенный редактор позволяет менять Markdown с предварительным просмотром и сохранять или отменять правки. Для работы нужны права на запись в указанную папку проекта и URL экземпляра n8n в переменных окружения. Редактирование не защищено аутентификацией, поэтому для рабочего использования её предлагают добавить.
Как работает workflow по шагам
- Вебхук запускает обработку запроса к порталу документации.
- Узлы n8n получают данные о workflow и передают их для формирования документации.
- OpenAI Chat Model генерирует описание, а узлы Mermaid.js строят схему структуры.
- Docsify.js отображает список workflow и созданную документацию.
- Редактор показывает Markdown с предварительным просмотром и обрабатывает сохранение или отмену изменений.
Что нужно для запуска
- Доступ к OpenAI и учётные данные для его узла.
- Права на запись в указанную папку проекта.
- URL экземпляра n8n в переменных окружения.
- Доступ к сервисам из списка интеграций.
Что изменить под себя
- Указать URL экземпляра n8n в переменных окружения.
- Задать папку проекта, для которой есть права на запись.
- Добавить аутентификацию для редактирования перед использованием в рабочей среде.
Сервисы 1
Категории у источника: База знаний , Мультимодальный ИИ
Узлы workflow 20
- Execute Command
- If
- Merge
- No Operation, do nothing
- Edit Fields (Set)
- Webhook
- Switch
- Respond to Webhook
- Sticky Note
- n8n
- Code
- HTML
- Basic LLM Chain
- OpenAI Chat Model
- Auto Fixing Output Parser
- Structured Output Parser
- Read/Write Files from Disk
- Convert to File
- Extract from File
- Sort
Виды узлов, из которых собран сценарий, — как их перечисляет страница шаблона. Серым — служебные узлы n8n.
Автор и первоисточник
Сценарий «📚 Auto-generate documentation for n8n workflows with GPT and Docsify» опубликовал на n8n.io Eduard. Файл шаблона и авторское описание — на странице шаблона.
Русское описание написано языковой моделью по странице шаблона и прошло автоматическую проверку: в нём нет сервисов и чисел, которых нет у автора. Сценарий принадлежит автору; каталог его не хранит.