Template description
This workflow creates a documentation system for n8n instances using Docsify.js. It serves a dynamic documentation website that allows users to:
- View an overview of all workflows in a tabular format
- Filter workflows by tags
- Access automatically generated documentation for each workflow
- Edit documentation with a live Markdown preview
- Visualize workflow structures using Mermaid.js diagrams
πΊ Check out the short 2-min demonstration on LinkedIn. Don't forget to connect!
π§ Key Components
- Main Documentation Portal
- Serves a Docsify-powered website
- Provides a navigation sidebar with workflow tags
- Displays workflow status, creation date, and documentation links
- Documentation Generator
- Uses GPT model to auto-generate workflow descriptions
- Creates Mermaid.js diagrams of workflow structures
- Maintains consistent documentation format
- Live Editor
- Split-screen Markdown editor with preview
- Real-time Mermaid diagram rendering
- Save/Cancel functionality
βοΈ Technical Details
Environment Setup
- Requires write access to the specified project directory
- Uses environment variables for n8n instance URL configuration
- Implements webhook endpoints for serving documentation
β οΈ Security Considerations
Note: The current implementation doesn't include authentication for editing. Consider adding authentication for production use.
Dependencies
- Docsify.js for documentation rendering
- Mermaid.js for workflow visualization
- OpenAI GPT for documentation generation
π Part of the n8n Observability Series
This workflow is part of a broader series focused on n8n instance observability. Check out these related workflows:
- Workflow Dashboard - Get comprehensive analytics of your n8n instance
- Visualize Your n8n Workflows with Mermaid.js - Create beautiful workflow visualizations
Each workflow in this series helps you better understand and manage your n8n automation ecosystem!
Share Template
More AI workflow templates
AI agent chat
This workflow employs OpenAI's language models and SerpAPI to create a responsive, intelligent conversational agent. It comes equipped with manual chat triggers and memory buffer capabilities to ensure seamless interactions.
To use this template, you need to be on n8n version 1.50.0 or later.
n8n Team
+7
Scrape and summarize webpages with AI
This workflow integrates both web scraping and NLP functionalities. It uses HTML parsing to extract links, HTTP requests to fetch essay content, and AI-based summarization using GPT-4o. It's an excellent example of an end-to-end automated task that is not only efficient but also provides real value by summarizing valuable content.
Note that to use this template, you need to be on n8n version 1.50.0 or later.
n8n Team
+5
AI agent that can scrape webpages
βοΈπ οΈππ€π¦Ύ
This template is a PoC of a ReAct AI Agent capable of fetching random pages (not only Wikipedia or Google search results).
On the top part there's a manual chat node connected to a LangChain ReAct Agent. The agent has access to a workflow tool for getting page content.
The page content extraction starts with converting query parameters into a JSON object. There are 3 pre-defined parameters:
url** β an address of the page to fetch
method** = full / simplified
maxlimit** - maximum length for the final page. For longer pages an error message is returned back to the agent
Page content fetching is a multistep process:
An HTTP Request mode tries to get the page content.
If the page content was successfuly retrieved, a series of post-processing begin:
Extract HTML BODY; content
Remove all unnecessary tags to recude the page size
Further eliminate external URLs and IMG scr values (based on the method query parameter)
Remaining HTML is converted to Markdown, thus recuding the page lengh even more while preserving the basic page structure
The remaining content is sent back to an Agent if it's not too long (maxlimit = 70000 by default, see CONFIG node).
NB:
You can isolate the HTTP Request part into a separate workflow.
Check the Workflow Tool description, it guides the agent to provide a query string with several parameters instead of a JSON object.
Please reach out to Eduard is you need further assistance with you n8n workflows and automations!
Note that to use this template, you need to be on n8n version 1.19.4 or later.
Eduard
+2
Telegram AI Chatbot
The workflow starts by listening for messages from Telegram users. The message is then processed, and based on its content, different actions are taken. If it's a regular chat message, the workflow generates a response using the OpenAI API and sends it back to the user. If it's a command to create an image, the workflow generates an image using the OpenAI API and sends the image to the user. If the command is unsupported, an error message is sent. Throughout the workflow, there are additional nodes for displaying notes and simulating typing actions.
Eduard
+4
OpenAI GPT-3: Company Enrichment from website content
Enrich your company lists with OpenAI GPT-3 β
Youβll get valuable information such as:
Market (B2B or B2C)
Industry
Target Audience
Value Proposition
This will help you to:
add more personalization to your outreach
make informed decisions about which accounts to target
I've made the process easy with an n8n workflow.
Here is what it does:
Retrieve website URLs from Google Sheets
Extract the content for each website
Analyze it with GPT-3
Update Google Sheets with GPT-3 data
Lucas Perret
+5
Ask questions about a PDF using AI
The workflow first populates a Pinecone index with vectors from a Bitcoin whitepaper. Then, it waits for a manual chat message. When received, the chat message is turned into a vector and compared to the vectors in Pinecone. The most similar vectors are retrieved and passed to OpenAI for generating a chat response.
Note that to use this template, you need to be on n8n version 1.19.4 or later.
David Roberts
