Dynamic Workflow Documentation Portal with Docsify & Mermaid
detail.loadingPreview
Automate the creation and maintenance of your n8n workflow documentation with this comprehensive solution. It leverages Docsify for elegant static site generation and Mermaid for powerful diagramming, providing an interactive editing experience and a central overview of all your automations.
About This Workflow
This n8n workflow transforms your instance into a powerful, self-hosted documentation portal. By integrating Docsify and Mermaid, it allows you to dynamically generate and serve detailed documentation for all your n8n workflows. The system includes an interactive Markdown editor with a live preview, enabling easy content creation and updates. It automatically compiles an overview of your workflows, displaying key details like status, creation/update dates, node counts, and triggers. Whether you're onboarding new team members or maintaining complex automation, this workflow ensures your documentation is always up-to-date and accessible, complete with visual diagrams for clarity.
Key Features
- Automated Documentation Generation: Automatically creates a navigable documentation portal for your n8n workflows.
- Interactive Markdown Editor: Provides a built-in editing interface with a live preview for easy content creation.
- Docsify-Powered Static Site: Generates a lightweight, single-page application documentation site using Docsify.
- Mermaid Diagram Support: Seamlessly renders Mermaid syntax for flowcharts, sequence diagrams, and more directly within your documentation.
- Centralized Workflow Overview: Offers an auto-generated index page listing all your n8n workflows with relevant metadata.
- Customizable Theming & Styling: Includes pre-configured HTML for headers and styles, allowing for a polished look.
How To Use
- Configure Project Path: In the
CONFIGnode, set theproject_pathparameter to your desired local directory where documentation Markdown files will be stored. - Access the Docs Portal: Trigger the workflow (likely via a webhook or manual execution) to generate and serve your Docsify documentation site. The
Main Pagenode will render the Docsify interface. - Create/Edit Documentation: Utilize the interactive editor (implied by the
HTML_styles_editorandHTML_docsify_includenodes) to write your Markdown content for individual workflows. You can embed Mermaid syntax for diagrams. - Review Workflow Overview: Navigate to the
/summary.mdpath (as configured in theMain Pagenode) to view an automatically generated table of all workflows in your n8n instance. - Utilize Docsify Features: Explore built-in Docsify functionalities like full-text search, sidebar navigation, and browser history management for an enhanced documentation experience.
Apps Used
Workflow JSON
{
"id": "0ce5eb83-3a46-4ef8-80c7-2c5c4c10d26e",
"name": "Dynamic Workflow Documentation Portal with Docsify & Mermaid",
"nodes": 19,
"category": "DevOps",
"status": "active",
"version": "1.0.0"
}Note: This is a sample preview. The full workflow JSON contains node configurations, credentials placeholders, and execution logic.
Get This Workflow
ID: 0ce5eb83-3a46...
About the Author
AI_Workflow_Bot
LLM Specialist
Building complex chains with OpenAI, Claude, and LangChain.
Statistics
Related Workflows
Discover more workflows you might like
Automated PR Merged QA Notifications
Streamline your QA process with this automated workflow that notifies your team upon successful Pull Request merges. Leverage AI and vector stores to enrich notifications and ensure seamless integration into your development pipeline.
Visualize Your n8n Workflows: Interactive Dashboard with Mermaid.js
Gain unparalleled visibility into your n8n automation landscape. This workflow transforms your n8n instance into a dynamic, interactive dashboard, leveraging Mermaid.js to visualize all your workflows in one accessible place.
Robust Concurrency Control for n8n Workflows with Redis
Prevent simultaneous execution of critical n8n workflows or tasks using a centralized, Redis-backed locking mechanism. This reusable utility workflow ensures data integrity and resource management by allowing other workflows to acquire, check, and release locks.