Comfy-Org/docs

什么是 Comfy‑Org/docs？

此仓库包含 ComfyUI 的官方文档网站，ComfyUI 是一个用于构建 AI 图像生成管道（例如 Stable Diffusion）的可视化节点式界面。文档使用 Mintlify 构建，这是一个静态网站生成器，可将 MDX 文件渲染为多语言网站（https://docs.comfy.org/）。

核心目的

存储构成面向用户文档的源 Markdown/MDX 文件。
提供脚本以在本地预览更改（npm i && npm run dev）。
使用 OpenAI 兼容翻译模型，自动将英文文档翻译成多种语言（中文、日文、韩文等）。
保持内置节点的文档与独立的 Comfy-Org/embedded-docs 仓库同步。
从 OpenAPI 规范生成 API 参考页面。

主要功能与工作流程

功能	工作方式	重要性
本地预览	`npm run dev` 启动开发服务器，渲染 MDX 文件。	让贡献者在合并前立即看到更改。
自动化 i18n	`npm run translate` 调用翻译 API（OpenAI 兼容）并将翻译后的 MDX 写入语言文件夹。front-matter 中的哈希值跟踪文件是否最新。	无需手动翻译即可保持文档跨语言同步。
词汇表与术语一致性	三层系统（`preserve_terms`、`glossary/frontend`、`glossary/overrides`）确保技术术语在翻译中保持一致。	防止多语言文档中出现混淆或矛盾的术语。
API 参考文档生成	`npx @mintlify/scraping@latest openapi-file <path>` 将 OpenAPI 规范转换为 MDX 端点页面。	为使用 ComfyUI 后端服务的开发人员提供最新、可搜索的 API 文档。
重定向安全性	当文件重命名时，PR 必须在 `docs.json` 中包含 `redirects` 数组；如果缺少，GitHub Action 会使 PR 失败。	确保重组后旧链接仍可工作。
同步拥有文件保护	某些文件（例如 `openapi‑v2.yaml`、生成的路由器页面）会在每次同步时自动生成。工作流会阻止编辑这些受保护路径的 PR。	防止意外覆盖自动生成的内容。
贡献流程	开启 PR → Vercel 自动部署至 https://docs.comfy.org/ → 审阅者合并。	文档更新的简单、快速反馈循环。

谁应该使用？

ComfyUI 用户寻找安装指南、节点参考或工作流示例。
开发人员需要 OpenAPI 规范或 API 使用示例。
翻译人员想要添加新语言（开启 issue；仓库会自动处理批量翻译）。
贡献者想要改进文档、添加教程或修正术语。

如何开始

克隆仓库。
运行 npm i 然后 npm run dev 以在本地查看网站。
在根目录（英文）或语言子文件夹中编辑或添加 MDX 文件。
准备就绪后，推送分支并开启 PR。合并后，Vercel 会发布更改。
如果您需要新语言，请开启 issue；维护者会将其添加到 translation-config.json 并运行批量翻译脚本。

简而言之： Comfy‑Org/docs 是 ComfyUI AI 工作流工具多语言文档的源代码与自动化中心，提供简单的本地预览、自动翻译、API 参考文档生成，以及安全的贡献流程。