Log in Get started

Back to Gdevelop

GDJS Documentation

GDJS/docs/README.md

5.6.268793 B

Original Source

GDJS Documentation

📚 Read the documentation online: GDJS Runtime (game engine) documentation or GDJS Platform documentation for the IDE.

How to generate the documentation

To generate the GDJS Runtime (game engine) documentation:
bash
```
cd <GDevelop repository>/GDJS
npm install
npm run generate-doc
```
Output will be in <GDevelop repository>/docs/GDJS Documentation.
To generate the GDJS Platform documentation for the IDE, install Doxygen. Then:
bash
```
cd <GDevelop repository>/GDJS/docs
doxygen
```
Output will be in <GDevelop repository>/docs/GDJS Runtime Documentation.