{"id":28921836,"url":"https://github.com/playcanvas/api-reference","last_synced_at":"2025-07-19T15:04:04.417Z","repository":{"id":217944218,"uuid":"745175948","full_name":"playcanvas/api-reference","owner":"playcanvas","description":"PlayCanvas API reference manual","archived":false,"fork":false,"pushed_at":"2025-07-11T09:21:19.000Z","size":233,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-19T10:24:23.199Z","etag":null,"topics":["api-reference","documentation","javascript","playcanvas","typedoc","typescript"],"latest_commit_sha":null,"homepage":"https://api.playcanvas.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/playcanvas.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-01-18T19:39:44.000Z","updated_at":"2025-07-11T09:21:21.000Z","dependencies_parsed_at":"2024-01-18T22:36:05.678Z","dependency_job_id":"0e5b41e4-fff5-453a-88b8-087434a002c2","html_url":"https://github.com/playcanvas/api-reference","commit_stats":null,"previous_names":["playcanvas/api-reference"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/playcanvas/api-reference","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playcanvas%2Fapi-reference","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playcanvas%2Fapi-reference/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playcanvas%2Fapi-reference/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playcanvas%2Fapi-reference/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/playcanvas","download_url":"https://codeload.github.com/playcanvas/api-reference/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playcanvas%2Fapi-reference/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265950375,"owners_count":23853750,"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":["api-reference","documentation","javascript","playcanvas","typedoc","typescript"],"created_at":"2025-06-22T07:08:27.609Z","updated_at":"2025-07-19T15:04:04.411Z","avatar_url":"https://github.com/playcanvas.png","language":"HTML","readme":"# PlayCanvas API Reference\n\nThis repository builds the combined PlayCanvas API Reference. The API reference is a collection of documentation from multiple PlayCanvas repositories.\n\n## Requirements\n\nEnsure you have Node.js 18+ installed.\n\n## Configuration\n\nRepository configuration is stored in `repos-config.json`. This file defines the repositories to be cloned, their URLs, and default branches:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"name\": \"engine\",\n      \"url\": \"https://github.com/playcanvas/engine.git\",\n      \"branch\": \"main\"\n    },\n    ...\n  ]\n}\n```\n\nYou can modify this file to change default branches, add new repositories, or remove existing ones.\n\n## Building the API Reference\n\nTo build the combined API reference, run:\n\n```bash\nnpm run build\n```\n\nThis cross-platform script will:\n\n1. Load the repository configuration from `repos-config.json`\n2. Clone the configured PlayCanvas repositories\n3. Install dependencies for each repository\n4. Build the TypeDoc documentation for each repository\n5. Copy the documentation to a central `docs` folder\n6. Create a main index.html file that allows navigation between the different API references\n7. Generate a combined sitemap.xml that includes URLs from all repositories for better SEO\n\n\u003e [!NOTE]  \n\u003e The build script automatically cleans and recreates the `repos` directory each time it's run, ensuring you always get a fresh build with the latest code from the configured branches.\n\n### Specifying Repository Branches\n\nThe default branches for all repositories are defined in the `repos-config.json` file. This is the recommended place to set your branch configurations:\n\n```json\n{\n  \"repositories\": [\n    {\n      \"name\": \"engine\",\n      \"url\": \"https://github.com/playcanvas/engine.git\",\n      \"branch\": \"release-2.6\"\n    },\n    // ... other repositories\n  ]\n}\n```\n\nFor temporary changes without modifying the configuration file, you can override branches using command-line arguments in the format `repo=branch`:\n\n```bash\n# Override the engine branch for a single build\nnpm run build engine=dev\n\n# Override multiple repositories for a single build\nnpm run build engine=dev pcui=feature/new-components\n```\n\nThe repository names used in the command line must match the `name` fields in the `repos-config.json` file.\n\n## Viewing\n\nTo view the built API reference, run:\n\n```bash\nnpm run serve\n```\n\nThen point your browser at `http://localhost:3000`.\n\n## Deployment\n\nThe API reference is automatically deployed to GitHub Pages whenever the main branch is updated.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaycanvas%2Fapi-reference","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplaycanvas%2Fapi-reference","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaycanvas%2Fapi-reference/lists"}