@playcanvas/jsdoc-template
Advanced tools
This is a JSDoc 3.x and 4.x compatible template for the PlayCanvas API Reference. It is generated automatically during engine publishing process and hosted on: https://developer.playcanvas.com/api/
Ensure you have Node.js installed. Then, install all of the required Node.js dependencies:
npm install
Then you can build CSS styles:
npm run build
To test static html files, you need to use PlayCanvas Engine repository. Clone https://github.com/playcanvas/engine besides this repository:
./playcanvas-jsdoc-template/
./engine/
Then edit ./engine/conf-api.json, field opts.template to: "../playcanvas-jsdoc-template" so it will use your local copy of templates for building the docs, and then in ./engine/ run:
npm run docs
Static files will be generated to:
./engine/docs/
These can be served by the web server of your choice or viewed directly by opening ./engine/docs/index.html in a web browser.
FAQs
JSDoc 3.x and 4.x compatible template for PlayCanvas
We found that @playcanvas/jsdoc-template demonstrated a not healthy version release cadence and project activity because the last version was released 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 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.