public_mirrors
/
doc-status
mirror of https://github.com/godotengine/doc-status.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Online Godot class reference status
58 Commits 3 Branches 0 Tags 1.6 MiB
JavaScript 39%
CSS 28.8%
Shell 26.1%
HTML 6.1%
Go to file
Hugo Locurcio d56614f4d8
GitHub Actions: Update Hugo to 0.101.0 (#20) 		2022-06-29 19:07:17 +02:00
.github GitHub Actions: Update Hugo to 0.101.0 (#20) 2022-06-29 19:07:17 +02:00
layouts Style the table at build time to speed up page loading (#4) 2020-06-27 00:42:30 +02:00
static Tweak favicon to distinguish it from other Godot-related websites 2021-09-02 19:17:21 +02:00
.editorconfig Initial commit 2020-02-26 20:01:37 +01:00
.gitignore Initial commit 2020-02-26 20:01:37 +01:00
LICENSE.txt Change copyrights for consistency with the @godotengine organization 2020-05-23 14:16:40 +02:00
README.md Add a technical pragraph that explains how this website is built 2020-11-02 16:42:20 +01:00
build.sh Rename the temporary Git clone directory variable for clarity 2020-09-13 19:34:33 +02:00
config.toml Fade out `0/0` completion ratios as there's nothing to document 2020-06-15 21:26:19 +02:00

README.md

Godot class reference status

View the completion status of the Godot class reference (updated daily).

View

How it works

  • First, build.sh performs the following operations:
    • Clone the Godot Git repository to a temporary directory.
    • Run doc/tools/status.py to generate a Markdown table, with the output redirected to a file. A static header is added at the beginning of the file as well.
    • Some text manipulation is done on the generated Markdown file to improve readability and visual grepping.
  • Hugo is used to build the HTML template with the referenced Markdown data into a static HTML page.
  • The generated website is deployed to GitHub Pages.

Every day, there's a continuous integration step that runs the tasks above to keep the page up-to-date.

Development

Follow these instructions to set up this site locally for development purposes:

  • Install Hugo for your operating system.
  • Run the build.sh script to clone the Godot repository, generate a Markdown file and build the website.
    • On Windows 10, you should be able to run this script using the WSL.
  • Run hugo server while working on the website CSS/JavaScript. The local server will reload automatically on file changes.
    • If you need to regenerate content/_index.md, run build.sh again. You can do this while having the development server running.

License

Unless otherwise specified, files in this repository are licensed under the MIT license. See LICENSE.txt for more information.