This repository houses the official documentation for ComfyUI, offering comprehensive guides and API references. It targets ComfyUI users and developers, providing a centralized, multi-lingual knowledge base to facilitate understanding and adoption of the platform.

How It Works

Documentation is managed using Mintlify, with English MDX files serving as the source of truth. An advanced automated translation system, driven by npm run translate, synchronizes updates across supported languages (Chinese, Japanese, Korean) by comparing English sources against existing translations. A hash-based mechanism tracks changes, and a glossary system ensures terminology consistency across languages. API reference documentation can be automatically generated from OpenAPI files.

Quick Start & Requirements

• Install: npm i
• Develop: npm run dev
• Prerequisites: Node.js, Bun, and an OpenAI-compatible API key for translation (TRANSLATE_API_KEY in .env.local).
• Links: ComfyUI Documentation, Mintlify Documentation

Highlighted Details

• Robust multi-language support with automated translation pipelines and per-language glossaries for terminology control.
• Automated generation of API reference documentation from OpenAPI specifications using @mintlify/scraping.
• Centralized maintenance of built-in node documentation within a single-level directory structure for simplified management.
• Workflow examples leverage raw GitHub content URLs for direct import into ComfyUI, preserving metadata.

Maintenance & Community

Contributions are accepted via Pull Requests, with reviews typically completed within a few days. Community discussions can occur on Discord. The repository includes scripts for automated translation, quality review, and glossary synchronization.

Licensing & Compatibility

The repository's README does not explicitly state a software license. This omission requires clarification for any adoption or integration decisions, particularly concerning commercial use or derivative works.

Limitations & Caveats

Renaming files necessitates manual updates to redirect lists in docs.json to prevent broken links. The built-in-nodes/ directory is excluded from the automated translation process. Long files may experience translation truncation, requiring specific repair commands. The absence of a declared license is a significant adoption blocker.