Files
n8n-guide/README.md

253 lines
7.5 KiB
Markdown
Raw Permalink Normal View History

2025-09-09 09:29:17 +08:00
# n8n工作流自动化指南
> 🚀 从零基础到专家级应用全面掌握n8n工作流自动化技能
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![n8n](https://img.shields.io/badge/n8n-compatible-brightgreen.svg)](https://n8n.io)
[![MkDocs](https://img.shields.io/badge/docs-MkDocs-blue.svg)](https://mkdocs.org)
## 📖 项目简介
本项目是一份全面的n8n工作流自动化学习指南旨在帮助用户从基础概念到高级应用系统性地掌握n8n平台的使用技能。无论您是技术零基础的业务人员还是需要深入了解部署运维的技术人员都能在这里找到适合的学习路径。
### 🎯 目标读者
- **业务人员**: 希望通过低代码工具提升工作效率
- **技术支持**: 负责n8n部署、配置和维护的技术人员
- **开发者**: 需要构建复杂自动化流程的工程师
- **AI爱好者**: 想要结合AI能力构建智能工作流
## ✨ 主要特色
### 🔧 全流程覆盖
- **入门指导**: 从零开始的完整学习路径
- **实战案例**: 丰富的真实业务场景示例
- **进阶技巧**: AI集成、MCP协议、自然语言编程
- **最佳实践**: 避坑指南和性能优化建议
### 🎨 现代化体验
- **美观界面**: 精心设计的现代化文档界面
- **直观图表**: 用图形化方式展示复杂概念,替代技术性强的代码图表
- **响应式设计**: 支持PC、平板、手机等各种设备
- **深色模式**: 支持明暗主题切换
### 📚 丰富资源
- **模板库**: 2000+工作流模板资源
- **视频教程**: 精选中英文视频教程合集
- **工具推荐**: 社区节点和扩展工具
- **参考文档**: 整理的官方和社区资源
## 📁 项目结构
```
n8n指南/
├── docs/ # 文档源文件
│ ├── index.md # 首页
│ ├── introduction/ # 引言和背景
│ ├── installation/ # 安装配置指南
│ ├── learning/ # 学习使用教程
│ ├── reference/ # 参考资料
│ ├── ai-center/ # AI卓越中心
│ ├── assets/ # 静态资源
│ │ ├── images/ # 图片资源
│ │ └── pdfs/ # PDF文档
│ └── stylesheets/
│ └── extra.css # 自定义样式
├── mkdocs.yml # MkDocs配置文件
├── README.md # 项目说明文档
└── n8n指南.md # 原始指南文档
```
## 🚀 快速开始
### 📖 在线阅读
访问我们的在线文档网站开始您的n8n学习之旅
```
https://your-domain.github.io/n8n-guide
```
### 💻 本地部署
如果您希望在本地运行或贡献内容,请按以下步骤操作:
2025-09-11 14:00:33 +08:00
#### 方式一Python直接运行
2025-09-09 09:29:17 +08:00
2025-09-11 14:00:33 +08:00
**环境要求**
2025-09-09 09:29:17 +08:00
- Python 3.7+
- pip 包管理器
2025-09-11 14:00:33 +08:00
**安装步骤**
2025-09-09 09:29:17 +08:00
1. **克隆项目**
```bash
git clone https://github.com/your-username/n8n-guide.git
cd n8n-guide
```
2. **安装依赖**
```bash
pip install mkdocs
pip install mkdocs-material
pip install pymdown-extensions
```
3. **启动开发服务器**
```bash
mkdocs serve
```
4. **访问文档**
打开浏览器访问 `http://127.0.0.1:8000`
2025-09-11 14:00:33 +08:00
#### 方式二Docker部署推荐
**环境要求**
- Docker
- Docker Compose
**一键部署**
```bash
# 启动服务
./start.sh
# 或者使用Docker Compose
docker-compose up -d
```
**访问文档**
打开浏览器访问 `http://localhost:8000`
#### 公网服务器部署
**部署到公网服务器**
```bash
# 上传项目文件到服务器
# 运行部署脚本
./deploy.sh
```
**访问地址**
`http://your-server-ip:8000`
2025-09-09 09:29:17 +08:00
#### 构建静态站点
```bash
mkdocs build
```
生成的静态文件将保存在 `site/` 目录中。
## 📋 学习路径
### 🌟 初学者路径 (1-2周)
1. [背景介绍](docs/introduction/background.md) - 了解AI时代的机遇与挑战
2. [快速开始](docs/installation/quick-start.md) - 云端注册体验
3. [界面介绍](docs/installation/interface.md) - 熟悉操作界面
4. [基本工作流](docs/learning/basic-workflows.md) - 创建第一个工作流
### 🛠️ 进阶用户路径 (1-2个月)
1. [本地部署](docs/installation/local-deployment.md) - 搭建私有环境
2. [常用节点](docs/learning/common-nodes.md) - 掌握核心功能
3. [凭证管理](docs/installation/credentials.md) - 安全连接外部服务
4. [模板应用](docs/learning/templates.md) - 快速复用方案
### 🚀 专家级路径 (3-6个月)
1. [避坑指南](docs/learning/pitfalls.md) - 避免常见错误
2. [MCP集成](docs/learning/mcp.md) - AI智能工作流
3. [社区节点](docs/learning/community-nodes.md) - 扩展平台能力
4. [自然语言编程](docs/learning/natural-language.md) - AI辅助开发
## 🔧 功能特性
### 📊 技术栈
- **文档框架**: MkDocs + Material主题
- **样式增强**: 自定义CSS现代化UI设计
- **图表展示**: 替换技术性图表为直观可视化元素
- **资源管理**: 支持本地图片、PDF等静态资源
### 🎨 界面特色
- **现代配色**: 青色系主色调,美观协调
- **卡片布局**: 信息分块展示,层次清晰
- **动画效果**: 适度的过渡动画,提升体验
- **响应式**: 完美适配各种屏幕尺寸
### 📱 用户体验
- **快速导航**: 清晰的导航结构,快速定位内容
- **搜索功能**: 全文搜索,快速找到需要的信息
- **参考置顶**: 重要参考链接置于页面顶部
- **进度跟踪**: 明确的学习路径和进度指示
## 🤝 贡献指南
我们欢迎社区贡献!您可以通过以下方式参与:
### 📝 内容贡献
- **完善文档**: 改进现有内容,修正错误
- **添加案例**: 分享实用的工作流案例
- **翻译工作**: 帮助翻译英文资源
- **视频制作**: 制作配套的视频教程
### 🐛 问题反馈
- **Bug报告**: 发现文档错误或链接失效
- **功能建议**: 提出改进建议和新功能需求
- **用户反馈**: 分享使用体验和学习心得
### 🛠️ 技术贡献
- **界面优化**: 改进文档界面和用户体验
- **功能开发**: 增加新的文档功能
- **性能优化**: 提升文档加载和访问性能
## 📞 联系我们
### 💬 社群交流
- **微信群**: 扫描二维码加入学习群
- **QQ群**: n8n中文学习交流群
- **邮件**: [your-email@domain.com](mailto:your-email@domain.com)
### 🔗 相关链接
- **n8n官网**: [https://n8n.io](https://n8n.io)
- **官方文档**: [https://docs.n8n.io](https://docs.n8n.io)
- **中文社区**: [https://docs.n8ncn.io](https://docs.n8ncn.io)
- **GitHub项目**: [https://github.com/n8n-io/n8n](https://github.com/n8n-io/n8n)
## 📄 版权信息
本项目采用 [MIT 许可证](LICENSE)。
### 🙏 致谢
感谢以下资源和社区的支持:
- **n8n团队**: 提供优秀的自动化平台
- **MkDocs社区**: 优秀的文档生成工具
- **Material主题**: 美观的文档主题
- **社区贡献者**: 分享模板和经验的社区成员
## 📈 项目统计
- **文档页面**: 20+ 详细页面
- **学习模块**: 6大核心模块
- **参考资源**: 100+ 精选资源链接
- **模板库**: 2000+ 工作流模板
- **更新频率**: 持续更新维护
---
⭐ 如果这个项目对您有帮助请给我们一个Star
🔄 项目持续更新中,欢迎关注最新动态。
📖 开始您的n8n自动化之旅[阅读文档](docs/index.md)