
Security News
pnpm 10.12 Introduces Global Virtual Store and Expanded Version Catalogs
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.
comfyui-embedded-docs
Advanced tools
[!NOTE] This is only for core nodes. For embedded custom node documentation, please see https://docs.comfy.org/custom-nodes/help_page
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.
To preview your documentation changes in ComfyUI:
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
Launch and preview:
[!TIP] The editable installation allows you to see changes immediately after copying files, without reinstalling the package.
The package is automatically published to PyPI when:
pyproject.toml
on the main branchpyproject.toml
is merged to mainThe publishing workflow:
python -m build
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
FAQs
Embedded documentation for ComfyUI nodes
We found that comfyui-embedded-docs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.
Security News
Amaro 1.0 lays the groundwork for stable TypeScript support in Node.js, bringing official .ts loading closer to reality.
Research
A deceptive PyPI package posing as an Instagram growth tool collects user credentials and sends them to third-party bot services.