UNPKG

@playcanvas/jsdoc-template

Version:

JSDoc 3.x and 4.x compatible template for PlayCanvas

playcanvas.com

playcanvas/playcanvas-jsdoc-template

40 lines (24 loc) • 1.61 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# PlayCanvas JSDoc Template 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/ [![NPM version][npm-badge]][npm-url] [![License][license-badge]][license-url] [![CI][ci-badge]][ci-url] ## How to build Ensure you have [Node.js](https://nodejs.org) 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. [ci-badge]: https://github.com/playcanvas/playcanvas-jsdoc-template/actions/workflows/ci.yml/badge.svg [ci-url]: https://github.com/playcanvas/playcanvas-jsdoc-template/actions/workflows/ci.yml [npm-badge]: https://img.shields.io/npm/v/@playcanvas/jsdoc-template [npm-url]: https://www.npmjs.com/package/@playcanvas/jsdoc-template [license-badge]: https://img.shields.io/npm/l/@playcanvas/jsdoc-template.svg?cacheSeconds=2592000 [license-url]: LICENSE