https://github.com/playcanvas/api-reference
PlayCanvas API reference manual
https://github.com/playcanvas/api-reference
api-reference documentation javascript playcanvas typedoc typescript
Last synced: 7 months ago
JSON representation
PlayCanvas API reference manual
- Host: GitHub
- URL: https://github.com/playcanvas/api-reference
- Owner: playcanvas
- License: mit
- Created: 2024-01-18T19:39:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-11T09:21:19.000Z (8 months ago)
- Last Synced: 2025-07-19T10:24:23.199Z (7 months ago)
- Topics: api-reference, documentation, javascript, playcanvas, typedoc, typescript
- Language: HTML
- Homepage: https://api.playcanvas.com/
- Size: 228 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PlayCanvas API Reference
This repository builds the combined PlayCanvas API Reference. The API reference is a collection of documentation from multiple PlayCanvas repositories.
## Requirements
Ensure you have Node.js 18+ installed.
## Configuration
Repository configuration is stored in `repos-config.json`. This file defines the repositories to be cloned, their URLs, and default branches:
```json
{
"repositories": [
{
"name": "engine",
"url": "https://github.com/playcanvas/engine.git",
"branch": "main"
},
...
]
}
```
You can modify this file to change default branches, add new repositories, or remove existing ones.
## Building the API Reference
To build the combined API reference, run:
```bash
npm run build
```
This cross-platform script will:
1. Load the repository configuration from `repos-config.json`
2. Clone the configured PlayCanvas repositories
3. Install dependencies for each repository
4. Build the TypeDoc documentation for each repository
5. Copy the documentation to a central `docs` folder
6. Create a main index.html file that allows navigation between the different API references
7. Generate a combined sitemap.xml that includes URLs from all repositories for better SEO
> [!NOTE]
> 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.
### Specifying Repository Branches
The default branches for all repositories are defined in the `repos-config.json` file. This is the recommended place to set your branch configurations:
```json
{
"repositories": [
{
"name": "engine",
"url": "https://github.com/playcanvas/engine.git",
"branch": "release-2.6"
},
// ... other repositories
]
}
```
For temporary changes without modifying the configuration file, you can override branches using command-line arguments in the format `repo=branch`:
```bash
# Override the engine branch for a single build
npm run build engine=dev
# Override multiple repositories for a single build
npm run build engine=dev pcui=feature/new-components
```
The repository names used in the command line must match the `name` fields in the `repos-config.json` file.
## Viewing
To view the built API reference, run:
```bash
npm run serve
```
Then point your browser at `http://localhost:3000`.
## Deployment
The API reference is automatically deployed to GitHub Pages whenever the main branch is updated.