This PR introduces a first implementation of a codeblock exporter which makes it possible to "dump" all the inline Godot documentation for Engine classes to markdown files, so everything that gets documented in code, can also be navigated in the site.
Featured in the PR
A customized version of gdscript-docs-maker that address issues with invalid JSON file exported from Godot when numeral constants (like INF or NAN) are used as params default values.
A better, custom docker container to run gdscript-docs-maker (only 266MB instead of > 1.5GB, plus Godot and GDM versions are pinned to the working ones)
Make targets to build and run the GDM container on any OS that supports Docker Desktop and Make (instructions provided in a dedicated README)
A syntax highlighter for GDScript based on highlight.js, already integrated and custom-themed for our documentation :)
Not featured, but planned
GitHub Action to export the refs before publishing the docs to production
Resorting to a published and maintained docker image by the Carenalgas community, downloadable from DockerHub
A way to better sort the reference. At the moment, the navigation is pretty awkwardly ordered
More extensive doc blocks, with keywords to structure information in MarkDown
Contributions to upstream GDM repo, that will eventually be done
This PR introduces a first implementation of a codeblock exporter which makes it possible to "dump" all the inline Godot documentation for Engine classes to markdown files, so everything that gets documented in code, can also be navigated in the site.
Featured in the PR
INForNAN) are used as params default values.highlight.js,already integrated and custom-themed for our documentation :)Not featured, but planned
And, of course... COMPLETE TESTING!