n8n-docs

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• 已安装 Git（用于克隆本仓库）
• 可编辑 Markdown 的文本编辑器
• 了解 Markdown 基本语法（内容都在 docs/ 下的 .md 文件）
• 可选：安装 Vale 做散文检查（README 列出的技术栈）
• 可选：安装 Lychee 做失效链接检查（README 列出的技术栈）

安装与启动步骤

1. 1克隆文档仓库

   从 GitHub 拉取 n8n-docs 仓库到本地，用于阅读或修改文档内容。

   git clone https://github.com/n8n-io/n8n-docs.git

   复制

2. 2进入仓库目录

   切换到刚克隆下来的仓库根目录，后续操作都在这里进行。

   cd n8n-docs

   复制

3. 3浏览文档内容

   所有文档内容在 docs/ 下，按主题分子目录，如 build、deploy、get-started 等。

4. 4使用文档模板

   document-templates/ 存放各类文档类型的模板，新增内容时可参照。

5. 5对照在线文档

   仓库内容对应线上站点 docs.n8n.io，可打开官网核对最新版本说明。

6. 6了解质量校验

   Vale 检查文案、Lychee 检查失效链接，均由 GitHub Actions 在 CI 中运行。

如何确认成功

本地 docs/ 目录能看到按主题分类的 markdown 文件，且浏览器打开 docs.n8n.io 能访问到对应内容即说明准备完成。

常见问题

注意事项

• README 未给出本地安装、构建或预览命令，相关步骤以仓库结构和在线文档为准。
• 本仓库不包含 n8n 产品代码，自托管部署请查阅 docs.n8n.io/hosting。
• Vale 与 Lychee 在 CI 中由 GitHub Actions 执行，本地是否运行需自行准备。
• 文档内容以 Markdown 形式集中存放在 docs/ 目录，按主题划分。