Dynamic Docsify Documentation Portal for n8n Workflows
detail.loadingPreview
This workflow creates a self-hosted Docsify documentation portal directly within your n8n instance. Effortlessly generate interactive documentation for all your n8n workflows, including dynamic Mermaid diagrams and an auto-generated overview, making knowledge sharing seamless.
About This Workflow
This powerful n8n workflow transforms your instance into a dynamic documentation hub powered by Docsify. It provides a flexible framework to host comprehensive documentation for all your n8n automation workflows, directly accessible from your n8n environment. Leverage Markdown for easy content creation, enhanced with seamless integration for Mermaid diagrams, allowing you to visualize complex processes and architectures directly within your docs. The workflow automatically generates an overview table of all your available workflows, complete with essential metadata, ensuring your team always has up-to-date information. Ideal for internal knowledge bases, project documentation, or sharing workflow insights.
Key Features
- Integrated Docsify Portal: Host a fully functional Docsify documentation website directly within your n8n instance, no external hosting required.
- Mermaid Diagram Support: Render interactive flowcharts, sequence diagrams, and more directly from Markdown code blocks using Mermaid.
- Automated Workflow Overview: Generates a dynamic, sortable table listing all your n8n workflows with their status, creation dates, node counts, and triggers.
- Customizable HTML & CSS: Full control over the documentation portal's appearance and behavior, including custom headers and styling.
- Markdown-centric Content: Easily create and manage documentation using familiar Markdown syntax.
How To Use
- Configure the CONFIG Node:
- Set
project_pathto define where your Markdown files will reside (e.g.,./.n8n/docs). - Verify
instance_urlcorrectly captures your n8n instance's accessible URL. - Review
HTML_headers,HTML_styles_editor, andHTML_docsify_includeparameters to customize your Docsify theme, add custom CSS, or include extra scripts for enhanced functionality.
- Set
- Create Your Documentation Content:
- Populate the
project_pathdirectory with your Markdown files (e.g.,README.md,_sidebar.md,your_workflow_guide.md). Use standard Markdown syntax and embed Mermaid diagrams withinmermaidcode blocks.
- Populate the
- Activate & Access:
- Ensure the workflow is active. Access your dynamic documentation portal via the webhook URL associated with the "Main Page" node, or directly by running the "Main Page" node and opening its output in a browser.
- Generate Workflow Overview:
- The "Instance overview" node automatically gathers data from your n8n workflows. Configure it as needed to generate the comprehensive table summarizing your workflows. This table is typically included in
_sidebar.mdor a mainindex.mdfile.
- The "Instance overview" node automatically gathers data from your n8n workflows. Configure it as needed to generate the comprehensive table summarizing your workflows. This table is typically included in
Apps Used
Workflow JSON
{
"id": "52276e2f-e02f-415b-b9a4-3758c3919599",
"name": "Dynamic Docsify Documentation Portal for n8n Workflows",
"nodes": 27,
"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: 52276e2f-e02f...
About the Author
SaaS_Connector
Integration Guru
Connecting CRM, Notion, and Slack to automate your life.
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.
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.
Automate Qualys Report Generation and Retrieval
Streamline your Qualys security reporting by automating the generation and retrieval of reports. This workflow ensures timely access to crucial security data without manual intervention.