Godot C# API

Unofficial web version of Godot's C# API documentation (https://paulloz.github.io/godot-csharp-api/).

Disclaimer

This repository has been archived, and the documentation website put offline. I do not want to host an outdated documentation platform, and keeping everything tightly up to date with the stable version of Godot has proven to be a challenge recently.

Sorry for the inconvenience.

How to use this repository

Should I be unable to maintain this, here's a quick rundown of how to generate the documentation and build the website.

1. Install DocFX
2. Drop the API files inside src/<version>/
3. Add the corresponding metadata entry in the docfx.json file
4. Add the corresponding build entry in the docfx.json file
5. Add the corresponding link in the toc.yml file
6. Run docfx metadata
7. Run docfx build

The whole website should now be built under docs/. You can preview it locally using docfx serve docs/. If you want to use the official Godot documentation logo, you'll also have to retrieve it from there.

License

See the index.md file for license details.