Etusivu Tutki Apua
Kirjaudu sisään
godotengine
/
godot-docs
peilaus alkaen https://github.com/godotengine/godot-docs
Tarkkaile 1
Äänestä 1
Fork 0
Tiedostot

Official EU-hosted mirror of the Godot Engine GitHub documentation repository, provided as backup and for anyone who cannot access GitHub due to US trade restrictions. Please only use the issue tracker if you are restricted from using GitHub.

Branch: dodge2d_update
Branchit Tagit
godot-docs
ZIP TAR.GZ
Chris Bradfield f5d11e6483 WIP: Updating for 4.0 (using beta1) 2 vuotta sitten
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) 2 vuotta sitten
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 2 vuotta sitten
_static 81a4cc2002 Fix the styling of the HTML shell reference (#6119) 2 vuotta sitten
_templates 21f92e43d6 Add a link to doc writing guidelines to the header (#5947) 2 vuotta sitten
_tools 5fce24792d Remove visual scripting from the documentation 2 vuotta sitten
about 5175fb8256 Use official CC BY 3.0 terminology and resources 2 vuotta sitten
classes c273baa258 classref: Sync with current master branch (4ba934bf3) 2 vuotta sitten
community 3f9abd9001 English improvements for content guidelines 2 vuotta sitten
development 98bb548d4a Fix doctool command 2 vuotta sitten
getting_started f5d11e6483 WIP: Updating for 4.0 (using beta1) 2 vuotta sitten
img a74fba1608 Cheatsheet of ease() with known names 2 vuotta sitten
tutorials f5b3a2fab2 Update example code for Godot 4 in Using RigidBody (#6215) 2 vuotta sitten
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 vuotta sitten
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 vuotta sitten
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 vuotta sitten
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 4 vuotta sitten
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 4 vuotta sitten
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 vuotta sitten
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 vuotta sitten
Makefile f3d1dff63b Minor English improvements for Makefile 2 vuotta sitten
README.md 1fe3fa4898 add a link to building the manual in readme 2 vuotta sitten
conf.py 5175fb8256 Use official CC BY 3.0 terminology and resources 2 vuotta sitten
index.rst 5cbff38341 Add missing Navigation category 2 vuotta sitten
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 4 vuotta sitten
requirements.txt a4a1d90c80 Bump sphinx-notfound-page from 0.8 to 0.8.3 2 vuotta sitten
robots.txt fd5f6f4909 Appease our great search engine overlords 4 vuotta sitten

README.md

Godot Engine documentation

This repository contains the source files of Godot Engine's documentation, in reStructuredText markup language (reST).

They are meant to be parsed with the Sphinx documentation builder to build the HTML documentation on Godot's website.

Download for offline use

You can download an HTML copy for offline reading (updated every Monday). Extract the ZIP archive then open the top-level index.html in a web browser.

Theming

The Godot documentation uses the default sphinx_rtd_theme with many customizations applied on top. It will automatically switch between the light and dark theme depending on your browser/OS' theming preference.

If you use Firefox and wish to use the dark theme regardless of your OS configuration, you can install the Dark Website Forcer add-on.

Contributing

All contributors are welcome to help on the Godot documentation.

To get started, head to the Contributing section of the online manual. There, you will find all the information you need to write and submit changes.

Here are some quick links to the areas you might be interested in:

  1. Contributing to the online manual
  2. Contributing to the class reference
  3. Content guidelines
  4. Writing guidelines
  5. Building the manual
  6. Translating the documentation

License

At the exception of the classes/ folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license (CC BY 3.0) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community". See LICENSE.txt for details.

The files in the classes/ folder are derived from Godot's main source repository and are distributed under the MIT license, with the same authors as above.