commit f69e63d93154bea6bc37f34c4eec44ce33663edc Author: Hugo Locurcio Date: Wed Feb 26 19:56:46 2020 +0100 Initial commit diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..2aab0a2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_style = space +indent_size = 2 +insert_final_newline = true +trim_trailing_whitespace = true + +[Makefile] +indent_style = tab diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2d89e43 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Hugo's default output directory +/public/ + +# Automatically generated by `build.sh` +content/_index.md diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..7cd7a47 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,15 @@ +os: linux +dist: bionic +# Python is required to run `doc_status.py` +language: python + +python: + - 3.7.1 + +install: + - curl -LO https://github.com/gohugoio/hugo/releases/download/v0.65.3/hugo_0.65.3_Linux-64bit.tar.gz + - tar xf hugo_0.65.3_Linux-64bit.tar.gz hugo + - sudo mv hugo /usr/local/bin/ + +script: + - ./build.sh diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..149ba76 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright © 2020 Hugo Locurcio and contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5d0515f --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Godot class reference status + +View the completion status of the Godot class reference (updated daily). + +## [View](https://godot-doc-status.github.io/) + +## License + +Copyright © 2020 Hugo Locurcio and contributors + +- Unless otherwise specified, files in this repository are licensed under the + MIT license, see [LICENSE.md](LICENSE.md) for more information. diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..48ff135 --- /dev/null +++ b/build.sh @@ -0,0 +1,23 @@ +#!/usr/bin/env bash + +set -euo pipefail +IFS='$\n\t' + +TMP="$(mktemp -d)" +git clone --depth=1 https://github.com/godotengine/godot.git "$TMP" + +# Generate a Markdown table of the class reference coverage. +mkdir -p content/ +rm -f content/index.md + +# Add Git commit information to the generated page. +COMMIT_HASH="$(git -C "$TMP" rev-parse --short=9 HEAD)" +echo -e "Generated from commit [$COMMIT_HASH](https://github.com/godotengine/godot/commit/$COMMIT_HASH).\n" > content/_index.md + +# Trim the first line of the output to get a valid Markdown table. +python3 "$TMP/doc/tools/doc_status.py" -u "$TMP/doc/classes" | tail -n +2 >> content/_index.md + +# Build the website. +hugo + +rm -rf "$TMP" diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..8bb807f --- /dev/null +++ b/config.toml @@ -0,0 +1,6 @@ +baseURL = "https://godot-doc-status.github.io/" +languageCode = "en-us" +title = "Godot class reference status" + +# This is a single-page website, no need to generate a sitemap and RSS feed. +disableKinds = ["sitemap", "RSS"] diff --git a/layouts/index.html b/layouts/index.html new file mode 100644 index 0000000..47055bc --- /dev/null +++ b/layouts/index.html @@ -0,0 +1,16 @@ + + + + + + + + + {{ .Site.Title }} + + + + + {{ .Content }} + + diff --git a/static/favicon.png b/static/favicon.png new file mode 100644 index 0000000..ac69f11 Binary files /dev/null and b/static/favicon.png differ diff --git a/static/main.css b/static/main.css new file mode 100644 index 0000000..6ab4b55 --- /dev/null +++ b/static/main.css @@ -0,0 +1,45 @@ +:root { + --body-background-color: hsl(0, 0%, 100%); + --body-color: hsl(0, 0%, 25%); +} + +@media (prefers-color-scheme: dark) { + :root { + --body-background-color: hsl(0, 0%, 20%); + --body-color: hsl(0, 0%, 85%); + } +} + +body { + background-color: var(--body-background-color); + color: var(--body-color); + /* Use a modern font stack inspired by Bootstrap 4. */ + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; +} + +table { + border-collapse: collapse; +} + +td { + border: 1px solid hsla(0, 0%, 50%, 50%); + padding: 0.25rem 0.5rem; +} + +tr:hover { + background-color: hsla(0, 0%, 50%, 25%); +} + +tr:nth-child(even) { + background-color: hsla(0, 0%, 50%, 10%); +} + +tr:nth-child(even):hover { + background-color: hsla(0, 0%, 50%, 35%); +} + +/* Align class names to the right for better readability and highlight them. */ +td:first-child { + font-weight: bold; + text-align: right; +}