{"id":25208081,"url":"https://github.com/comfy-org/docs","last_synced_at":"2025-10-25T08:30:58.656Z","repository":{"id":229715412,"uuid":"777432241","full_name":"Comfy-Org/docs","owner":"Comfy-Org","description":"Documentation for ComfyUI","archived":false,"fork":false,"pushed_at":"2024-05-29T00:29:26.000Z","size":1534,"stargazers_count":2,"open_issues_count":1,"forks_count":4,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-05-29T14:41:00.310Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://comfydocs.org","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Comfy-Org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-25T20:55:42.000Z","updated_at":"2024-05-29T14:41:17.818Z","dependencies_parsed_at":"2024-05-29T14:41:07.951Z","dependency_job_id":"7461bf1c-b1d9-4436-9e60-2336f792a7d6","html_url":"https://github.com/Comfy-Org/docs","commit_stats":null,"previous_names":["drip-art/docs","comfy-org/docs"],"tags_count":0,"template":false,"template_full_name":"mintlify/starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comfy-Org%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comfy-Org%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comfy-Org%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Comfy-Org%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Comfy-Org","download_url":"https://codeload.github.com/Comfy-Org/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238109528,"owners_count":19417881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-10T12:18:42.816Z","updated_at":"2025-10-25T08:30:53.594Z","avatar_url":"https://github.com/Comfy-Org.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ComfyUI Documentation\n\n## Development\n\nInstall the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command\n\n```\nnpm i mintlify\n```\n\nRun the following command at the root of your documentation (where mint.json is)\n\n```\nnpx mintlify dev\n```\n\n### Create a PR\n\nCreate a PR. Once it is accepted Vercel will deploy the change to https://docs.comfy.org/\n\n### Generating API Reference Docs\n\nCan either use an OpenAPI file or URL containing the file:\n\n```bash\ncd registry/api-reference # Keep API files separated by products.\nnpx @mintlify/scraping@latest openapi-file \u003cpath-to-openapi-file\u003e\n```\n\nThis will only generate the MDX files for each endpoint. You need to add a link to these files in `mint.json`, and the up-to-date API spec will be shown on that doc page.\n\n## Contributing\n\nPlease just create a PR and we will review it within a few days.\n\nOr talk to us on our [discord](https://discord.com/invite/comfyorg)\n\n### i18n Contributions\n\nMintlify uses versioning as a way to add additional locales. To add a translation of a page, follow these instructions:\n\n1. Create a file under the language code with the same exact filename of the original english filename.\n\neg. If you are translating `introduction.mdx` into Chinese, create a file under `zh-CN/get_started/introduction.mdx`. Make sure you include the version in the new file:\n\n```\n---\ntitle: \"\"\ndescription: \"\"\nversion: \"Chinese\"\n---\n```\n\n2. Change the original file to be English version\n\nFiles without versions appear in all versions, so we need to make sure the English file does not appear in the Chinese translation.\n\n```\n---\ntitle: \"\"\ndescription: \"\"\nversion: \"English\"\n---\n```\n\n3. Update navigation for `mint.json`\n\nIf you translated a single page, just add the new translated page to the navigation group.\n\nFor `introduction.mdx`:\n\n```\n  \"pages\": [\n    \"get_started/introduction\",\n    \"zh-CN/get_started/introduction\",\n  ...\n  ]\n```\n\nMintlify will automatically filter out pages that are not the current version (in our case language).\n\nIf all the pages in a group are translated, you should make a copy of the entire group for the specific version.\n\neg. If the Getting Started group has all been translated, we can do this:\n\n```\n{\n  \"group\": \"Get Started\",\n  \"version\": \"English\"\n  \"pages\": [\n    ...English pages\n  ]\n},\n{\n  \"group\": “入门指南\",\n  \"version\": \"Chinese\"\n  \"pages\": [\n    ...Chinese pages\n  ]\n}\n\n```\n\nRefer to Mintlify documentation on [Versions](https://mintlify.com/docs/settings/versioning#versioning) for more info.\n\n#### Adding a new language\n\nIf a language does not exist yet, add it in `mint.json` under versions. So if you are adding Portuguese, make this change:\n\n```\n\"versions\": [{\n    \"name\": \"Português\",\n    \"locale\": \"pt-BR\"\n  }]\n```\n\nThe locale will translate Mintlify default UI components' text. This is optional. The full list of locales are [here](https://mintlify.com/docs/settings/global#param-locale).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomfy-org%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomfy-org%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomfy-org%2Fdocs/lists"}