Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 942 Bytes

docs.md

File metadata and controls

25 lines (16 loc) · 942 Bytes

GDJS Documentation

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

How to generate the documentation

  • Install Doxygen and JSDoc.

  • To generate the GDJS Runtime (game engine) documentation:

    cd GDJS
    jsdoc -c docs/jsdoc.conf.json -t docs/jaguarjs-jsdoc docs/DocMainPage.md

    Output will be in docs/GDJS Documentation in the GDevelop repository root.

  • To generate the GDJS Platform documentation for the IDE:

    cd GDJS/docs
    doxygen

    Output will be in docs/GDJS Runtime Documentation in the GDevelop repository root.