Files
GDevelop/GDJS/docs
Florian Rival 2c4fa1d1c2 Switch the game engine documentation to TypeDoc (#3593)
* This adds link between types, a more readable rendering, a better search and, more generally, makes the [game engine documentation](https://docs.gdevelop-app.com/GDJS%20Runtime%20Documentation/index.html) much easier to browse.
2022-02-03 13:58:44 +01:00
..

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:

    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:

    cd <GDevelop repository>/GDJS/docs
    doxygen
    

    Output will be in <GDevelop repository>/docs/GDJS Runtime Documentation.