ComfyUI Embedded Documentation

0.4.3 · active · verified Sat Apr 11

ComfyUI-embedded-docs is a Python package that provides offline documentation and help resources specifically for ComfyUI's core nodes. It bundles Markdown files and associated assets, making node-specific documentation accessible directly within the ComfyUI interface. The package maintains an active development status with regular updates, typically published to PyPI upon changes to its `pyproject.toml` on the main branch.

Warnings

gotcha Outdated or missing node help documentation is a common issue if ComfyUI's core dependencies, including `comfyui-embedded-docs`, are not updated alongside the main ComfyUI application.
Fix: Ensure you run a full update for your ComfyUI installation, not just a `git pull` of the main repository. This often involves updating core dependencies explicitly or using update scripts provided by ComfyUI.
gotcha This package provides documentation for *core* ComfyUI nodes. If you encounter issues with custom nodes (e.g., they don't load, cause errors, or their documentation is missing/incorrect), the problem likely lies within the custom node's implementation or its own documentation, not this package.
Fix: For custom node issues, consult the custom node's specific GitHub repository or support channels. Disable custom nodes to isolate problems.
gotcha When contributing to the documentation or making local changes, a standard `pip install` will not reflect your modifications immediately.
Fix: Use an 'editable' installation (`pip install -e /path/to/embedded-docs/`) for development. This allows changes in the source directory to be reflected in ComfyUI without reinstallation. Remember to restart or refresh ComfyUI after making changes.

Install

pip install comfyui-embedded-docs Install stable version

Quickstart

After installation, launch your ComfyUI instance. To view documentation for any core node, click on the node in your workflow, then click the 'node info' icon (often a '?' or 'i' symbol) in the selection toolbox. This will open a documentation page directly within ComfyUI, providing details about the node's function, inputs, and outputs.

pip install comfyui-embedded-docs
# Now, launch ComfyUI (e.g., python main.py)
# Then, within the ComfyUI UI, you can access the embedded documentation.

view raw JSON →