@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
The npm package @playcanvas/jsdoc-template receives a total of 8 weekly downloads. As such, @playcanvas/jsdoc-template popularity was classified as not popular.
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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.