Skip to content

Repository files navigation

comfyui_embedded_docs

Note

This is only for core nodes. For embedded custom node documentation, please see https://docs.comfy.org/custom-nodes/help_page

Updating Documentation

Each core node should have a folder containing its node name, then a two letter locale.md, and potentially any assets along with it in the same folder.

See FluxProUltraImageNode as an example.

Note

A fallback is simply docs/NodeName.md, but this is discouraged.

Localized documentation

en.md is the source of truth for a node. Every other locale in the folder is generated from en.md by the pipeline in docs-generation/: the model translates the page, then update_param_translations.py reconciles parameter and output names against the ComfyUI frontend i18n, so the tables match what users see in the UI.

Each node folder currently carries 15 locales: en, zh, zh-TW, ja, ko, es, fr, de, it, pt-BR, ru, tr, ar, fa, he.

What that means when you contribute:

  • A content fix goes into en.md only. Do not hand-translate the other 14 files. Keep the prose in English and leave the translations to the pipeline instead of machine-translating them inside the PR. Note what the default run does: batch_translate_docs.py skips a locale whose file already exists unless it is given --force (process_node, docs-generation/scripts/batch_translate_docs.py:331-339), so an edit to en.md does not by itself refresh the 14 existing files. A full refresh is python3 docs-generation/main.py --retranslate-all-languages (equivalent to --translate --all-languages --mode all --force --force-all-translation-nodes), which re-translates every node that has an en.md and uses API quota.
  • A value that is wrong in every locale (a parameter name, a default, a command, a URL) is the exception: grep -l the wrong string and fix the same string in each locale, without touching the prose around it.
  • Reviewing other locales is not expected of you. You are asked to review the locales you can read. The pull request template records which ones you reviewed, so a native speaker knows what is left.
  • The rules the pipeline relies on (data types stay English, parameter names follow the frontend nodeDefs, one fixed Inputs/Outputs heading per language) are listed in AGENTS.md.

The documentation site publishes a subset of these locales. .github/scripts/check_doc_structure.py (ENFORCED_LANGS = ja, zh, ko, es) applies the section-repair and heading-parity checks to that subset only; for the remaining locales those checks are skipped rather than reported. One check is not gated: a leaked translation preamble under the H1 counts as a violation for every locale (check_doc_structure.py:207-218), because a leaked prompt block is a defect wherever it appears.

Previewing Changes Locally

To preview your documentation changes in ComfyUI:

  1. Install editable version (optional but recommended):

    # If you have one, activate your ComfyUI virtual environment first
    pip uninstall comfyui-embedded-docs  # Remove existing PyPI version
    pip install -e /path/to/embedded-docs/  # Install editable version
  2. Launch and preview:

    • Start ComfyUI
    • Refresh the frontend tab after making documentation changes

Tip

The editable installation allows you to see changes immediately after copying files, without reinstalling the package.

Publishing

The package is automatically published to PyPI when:

  1. You manually trigger the workflow (Actions → Publish to PyPI → Run workflow)
  2. You push changes to pyproject.toml on the main branch
  3. A pull request that modifies pyproject.toml is merged to main

The publishing workflow:

  1. Builds the package using python -m build
  2. Publishes to PyPI using the configured PYPI_TOKEN secret

Syncing to Comfy docs

The docs-generation pipeline syncs embedded-docs (en.md, zh.md, ja.md, ko.md, and assets) to the Comfy-Org/docs repository as built-in node MDX files and updates the navigation (docs.json).

The pipeline lives in docs-generation/ and includes:

  • docs-generation/scripts/scan_missing_nodes.py – scan the ComfyUI codebase, detect new/changed nodes
  • docs-generation/scripts/batch_generate_docs.py + batch_translate_docs.py – LLM-based doc generation and 14-language translation
  • docs-generation/scripts/update_param_translations.py – reconcile parameter names with the ComfyUI frontend i18n
  • docs-generation/scripts/sync_to_comfy_docs.py – generate built-in-nodes/*.mdx + update docs.json navigation
  • docs-generation/scripts/version_tracker.py – per-node source hash tracking

See docs-generation/README.md for full setup and workflow.

Environment variables (optional):

  • EMBEDDED_DOCS_PATH – Path to this repo (default: the repo this pipeline lives in)
  • COMFYUI_PATH – Path to the ComfyUI repo (used to read node category from source)
  • TARGET_DOCS – Path to the comfy/docs root (e.g. /path/to/comfy/docs)

Category mapping: The sync script uses each node's ComfyUI category to put it in the right docs.json group. For the most complete categories (including API nodes and nodes that get category from a base class), run the node scanner once so it can write docs-generation/data/all_nodes_info.json; the sync script will prefer that file when present.

# Optional: run scanner first to build all_nodes_info.json (better category coverage)
python docs-generation/scripts/scan_missing_nodes.py

Run from repo root:

# Test mode: sync first 10 nodes (dry run: no writes)
TARGET_DOCS=/path/to/comfy/docs python docs-generation/scripts/sync_to_comfy_docs.py --mode test --count 10 --dry-run

# Sync all nodes with en.md and update docs.json
TARGET_DOCS=/path/to/comfy/docs python docs-generation/scripts/sync_to_comfy_docs.py --mode all

# Sync a single node
TARGET_DOCS=/path/to/comfy/docs python docs-generation/scripts/sync_to_comfy_docs.py --node Load3D

You can also use the interactive menu: run python docs-generation/main.py and choose option 5) Sync to Comfy docs.

Linting

To ensure minimal consistency across nodes documentation, it is recommended to follow the Markdown linting principles. Some of the linting issues can be fixed automatically with the shell script below. Note this requires to install markdownlint-cli.

# Install markdownlint-cli
# If you encounter the error npm.ps1 cannot be loaded because running scripts is disabled on this system
# Run this command: Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
npm install -g markdownlint-cli

# Fix linting issues in all markdown files under docs directory,using shell script (Linux)
bash fix_markdown.sh

# Fix linting issues for a specific node's documentation
bash fix_markdown.sh ClipLoader  # This will only check files in comfyui_embedded_docs/docs/ClipLoader/

# Or fix linting issues in markdown files, using powershell script (Windows)
powershell -ExecutionPolicy Bypass -File fix_markdown.ps1

Releases

Packages

Used by

Contributors

Languages