comfyui-embedded-docs

What it is and what it does

comfyui-embedded-docs is a documentation package for ComfyUI's core node library. It organizes node documentation in a structured format (locale-specific markdown files organized by node name) and integrates with ComfyUI's frontend to display help content for each node. The package is designed to be installed alongside ComfyUI and automatically makes node documentation available when the application runs.

The package supports multi-language documentation (with examples for English, Chinese, Japanese, and Korean) and includes tooling for generating, translating, and syncing documentation to the main Comfy documentation repository. It has no runtime dependencies and installs as a pure Python wheel, making it lightweight to add to an existing ComfyUI setup.

Use it for:

• Install alongside ComfyUI to provide built-in help documentation for all core nodes in the UI.
• Contribute node documentation by adding or updating locale-specific markdown files in the package.
• Sync core node documentation to the Comfy-Org/docs repository for the public documentation site.
• Preview documentation changes locally during development before publishing to PyPI.
• Maintain multi-language node documentation (English, Chinese, Japanese, Korean) in a single repository.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Delivers embedded documentation for ComfyUI's core nodes, packaged as a Python module that integrates node help content directly into the ComfyUI application.

Yes, if you run ComfyUI and want node documentation available in the application. Install it as a standard dependency of your ComfyUI setup. The package is actively maintained, has no external dependencies, and carries no security vulnerabilities. The GPL-3.0 license is copyleft, so verify compatibility with your deployment model if you redistribute ComfyUI.

Install

comfyui-embedded-docs on PyPI

pip install comfyui-embedded-docs

uv add comfyui-embedded-docs

poetry add comfyui-embedded-docs

Installing comfyui-embedded-docs

Before you install

Low friction install with no runtime dependencies. Actively maintained with a recent release and steady repository activity.

License in practice

Licensed under GPL-3.0 (copyleft). Use requires compliance with copyleft obligations; derivative works and distributions must also be licensed under GPL-3.0.

Quickstart

pip install comfyui-embedded-docs

# Then start ComfyUI; the documentation is automatically available
# For development, install editable:
# pip install -e /path/to/embedded-docs/

Requires Python 3.9 or later. Intended for use within a ComfyUI installation.

Verify before relying

• Whether this package is required for ComfyUI to function or is optional documentation.
• How documentation updates are reflected in the ComfyUI UI after installation.
• Whether custom node documentation is handled by this package or requires separate setup.

Package facts

Evidence: comfyui_embedded_docs-0.5.10-py3-none-any.whl

Tags

More Documentation packages