Skip to content

A commandline tool for generating the API documentation of Cocos Creator game engine.

License

Notifications You must be signed in to change notification settings

cocos/creator-api-doc

 
 

Repository files navigation

Typedoc JSON Generator for Cocos Creator 3.x API

Prepare

Install NodeJS v18.

Install

$ npm i

Build

$ npm run build

Unit Test

$ npm run test

Apply URL Patch for typedoc

Since the default generated json file doesn't contain the url of source file, run npm run apply-patch to enable it.

About

A commandline tool for generating the API documentation of Cocos Creator game engine.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 88.0%
  • JavaScript 8.5%
  • Shell 3.5%