https://github.com/godot-rust/godot-rust.github.io
Website and API Docs infrastructure
https://github.com/godot-rust/godot-rust.github.io
Last synced: 4 months ago
JSON representation
Website and API Docs infrastructure
- Host: GitHub
- URL: https://github.com/godot-rust/godot-rust.github.io
- Owner: godot-rust
- License: mpl-2.0
- Created: 2023-05-07T09:55:03.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T00:58:10.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:51:57.864Z (about 1 year ago)
- Language: HTML
- Size: 586 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
- License: License.txt
Awesome Lists containing this project
README
# Website and API Docs infrastructure
Contains the source files for https://godot-rust.github.io and the CI infrastructure to generate real-time documentation from latest commits. This CI is based on GitHub Actions and offers the following workflow:
* Supports `gdnative` and `gdext` repos.
* Triggered via push to master and pull requests.
* Runs `cargo doc` for the respective branch.
* Creates an overview page with all active docs.
* Deploys generated docs to the website.
The website is built with [Zola], a static site generator implemented in Rust. We use a custom theme inspired by [Blow], together with [Tailwind CSS] for styling.
[Zola]: https://www.getzola.org
[Blow]: https://www.getzola.org/themes/blow
[Tailwind CSS]: https://tailwindcss.com