Repository files navigation

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.

SeeFluxProUltraImageNode as an example.

To preview your documentation changes in ComfyUI:

1. Install editable version (optional but recommended):

   # If you have one, activate your ComfyUI virtual environment firstpip uninstall comfyui-embedded-docs# Remove existing PyPI versionpip install -e /path/to/embedded-docs/# Install editable version

2. Launch and preview:

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

The package is automatically published to PyPI when:

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

The publishing workflow:

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

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 installmarkdownlint-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 Bypassnpm 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 documentationbash 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