Dify 文档

Dify 的官方文档，提供英文、简体中文和日文版本。

目录

• 参与贡献
• 查看旧版文档

参与贡献

欢迎贡献内容！所有内容必须以 英文 提交——中文和日文翻译由我们的翻译流水线自动生成。

快速开始

1. 复刻（Fork）并克隆此仓库。
2. 创建分支，进行修改，并向 main 分支提交拉取请求（PR）。
3. 维护者会审阅您的 PR。审核通过后，翻译将自动生成。

仓库结构

dify-docs/
├── en/              # 英文文档（源语言）
├── zh/              # 中文翻译（自动生成）
├── ja/              # 日文翻译（自动生成）
├── writing-guides/  # 格式指南、术语表
├── .claude/skills/  # Claude Code 技能
├── tools/translate/ # 翻译流水线
├── docs.json        # 导航结构

• 所有内容修改应在 en/ 目录下进行。除非要专门优化中文或日文翻译，否则不要直接编辑 zh/ 或 ja/ 目录。
• 如果添加或移动页面，请更新 docs.json 中的英文部分——翻译会自动同步。

文件格式

文档文件使用 MDX 格式，并需要 YAML 前言（frontmatter）：

---
title: 页面标题
description: 页面内容的简短描述。
---

页面内容在此...

提交与 PR 规范

提交信息（Commit）和 PR 标题使用相同格式：{类型}: {描述}

• 使用小写、祈使语气（例如 "add"，而非 "added" 或 "adds"）。
• 末尾不加句号。
• 不超过 72 个字符。

对于非显而易见的变更，请在空行后添加正文说明原因：

fix: switch API response mode to streaming

Blocking mode was causing HTTP 504 timeouts on large pages.

本地预览

npm i -g mintlify
mintlify dev

以上命令会在 http://localhost:3000 启动本地开发服务器。

设置

启用预提交钩子（在提交术语表变更时自动重新生成术语数据库）：

git config core.hooksPath .githooks

格式标准

我们在 writing-guides/formatting-guide.md 中维护了格式指南。如果您使用 AI 编辑器或助手（如 Cursor、Claude Code、Copilot 等），可引导其参考该文件，以在提交前检查您的成果。

AI 辅助贡献

本仓库在 .claude/skills/ 目录下包含了 Claude Code 技能，这些技能可为不同类型的文档提供写作辅助。如果您使用 Claude Code，克隆仓库后这些技能会自动生效。

准则

• 一个 PR 只涉及一个主题。 请勿将不相关的变更混在一起。
• 仅限英文。 翻译由系统自动处理，但 en/self-host/configuration/environments.mdx 除外，该文件需要手动翻译。
• 更新导航。 如果您添加了新页面，请将其加入 docs.json 的英文部分。
• 本地测试。 在提交 PR 前，运行 mintlify dev 验证您的更改是否能够正确渲染。
• 不要泄露秘密。 切勿提交 API 密钥、凭据或 .env 文件。

查看旧版文档

我们的文档站点只托管最新版本。要查看先前版本的文档，请签出对应 release/* 分支，并使用 Mintlify CLI 在本地预览。

git clone https://github.com/langgenius/dify-docs.git
cd dify-docs
git checkout release/1.14.x   # 将此处替换为您需要查看的版本
npm i -g mintlify
mintlify dev

上述操作将在 http://localhost:3000 上提供历史版本的文档。在 分支列表 中可查看所有可用的 release/* 版本。