comfyui-embedded-docs

comfyui-embedded-docs is the PyPI package that bundles the official documentation for ComfyUI’s core nodes. These are the help pages that render directly inside the ComfyUI interface, giving users per-node guidance without leaving the graph editor. The package covers core nodes only; custom-node documentation is handled separately.

Each core node has a documentation folder containing locale-specific Markdown files and any accompanying assets, so help content can be localized across languages. Distributing this content as a versioned Python package lets the ComfyUI server ship matching in-app docs alongside each release.

What You Get

• Official in-app help pages for ComfyUI’s core nodes
• Per-node Markdown documentation with locale-specific variants
• Bundled assets (images and diagrams) that accompany the docs
• A versioned package so docs match the installed ComfyUI release
• An editable-install workflow for previewing documentation changes locally

Common Use Cases

• Rendering built-in node help inside the ComfyUI interface
• Providing localized documentation for ComfyUI users across languages
• Shipping up-to-date core-node docs with each ComfyUI distribution

Under The Hood

Architecture - Documentation lives under docs/<NodeName>/<locale>.md with co-located assets (a flat docs/NodeName.md fallback exists but is discouraged); the package exposes this tree so the ComfyUI front-end can look up and render the correct localized page for a given core node.

Tech Stack - The repository is content-first Markdown plus image assets, wrapped in a Python package with shell-based publishing automation and an editable-install path for local previews.

Code Quality - The project is well maintained with consistent, frequent updates tracking new core nodes, and its per-node/per-locale convention keeps contributions structured and easy to review.

API Design - There is effectively no imperative API: the contract is the on-disk folder convention, so contributors add a node folder and locale file and the front-end surfaces it automatically.