Startseite Erkunden Hilfe
Anmelden
godotengine
/
godot-docs
Mirror von https://github.com/godotengine/godot-docs
Beobachten 1
Favorit hinzufügen 1
Fork 0
Dateien

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: 4.2
Branches Tags
godot-docs
ZIP TAR.GZ
tetrapod00 3d9ca63b15 Fix compile error in advanced_postprocessing.rst vor 3 Monaten
.github 78189da9d8 Bump peter-evans/create-pull-request from 5 to 6 vor 4 Monaten
_extensions 0a01baec10 Fix epub-related failures (#8207) vor 1 Jahr
_static 4ca2ee7d1f Fix scrolling outside of content area vor 4 Monaten
_styleguides 88970e5daa Add German style guide vor 1 Jahr
_templates 0a01baec10 Fix epub-related failures (#8207) vor 1 Jahr
_tools 9d6bbd8306 Fix redirect to new contribution guidelines vor 4 Monaten
about 3f87039c94 Fix dead links in the documentation vor 4 Monaten
classes e43e650135 classref: Sync with current 4.2 branch (7a3a36a) vor 6 Monaten
community 3f87039c94 Fix dead links in the documentation vor 4 Monaten
contributing 0d8aad8073 Update Cross-compiling for iOS on Linux vor 4 Monaten
getting_started 52b408e4d3 Mention that signals are first-class types since Godot 4.0 in Using signals vor 4 Monaten
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) vor 1 Jahr
tutorials 3d9ca63b15 Fix compile error in advanced_postprocessing.rst vor 2 Monaten
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 3 Jahren
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 3 Jahren
.gitignore 47bacc95fd Added configuring ide for rider (#7420) vor 1 Jahr
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors vor 4 Jahren
.readthedocs.yml d9e0d8386e Add tools definition for RTD vor 1 Jahr
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources vor 2 Jahren
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license vor 6 Jahren
Makefile 31204023b6 Makefile: use sphinx-build -M vor 1 Jahr
README.md f9947573e9 Merge branch 'DevDocsReadMe' of https://github.com/skyace65/godot-docs into DevDocsReadMe vor 4 Monaten
conf.py 4b68d56c63 Add table of contents to epub of docs vor 4 Monaten
index.rst dcdb34ce94 Merge pull request #9609 from MurderVeggie/how-to-contribute vor 4 Monaten
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs vor 1 Jahr
requirements.txt 1db6e49e0f Pin sphinx-contrib libraries to pre-5.0 version vor 10 Monaten
robots.txt fd5f6f4909 Appease our great search engine overlords vor 4 Jahren

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

To browse the documentation offline, 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.

For mobile devices or e-readers, you can also download an ePub copy for offline reading (updated every Monday). Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.

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

With 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.