Startsida Utforska Hjälp
Logga in
godotengine
/
godot-docs
spegling av https://github.com/godotengine/godot-docs
Bevaka 1
Stjärnmärk 1
Fork 0
Filer

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.

Gren: stable
Grenar Taggar
godot-docs
ZIP TAR.GZ
Max Hilbrunner 4b616e1444 Merge pull request #10364 from godotengine/4.3 3 veckor sedan
.github f9e72e2bad CI: Integrate pre-commit for style checks 3 veckor sedan
_extensions b09ab6fef9 Fix keywords for Vector in GDScript syntax highlighting 2 månader sedan
_static 70f703a6c8 Update Sphinx version 3 veckor sedan
_styleguides 88970e5daa Add German style guide 1 år sedan
_templates 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it 3 veckor sedan
_tools f9e72e2bad CI: Integrate pre-commit for style checks 3 veckor sedan
about 8b188321a8 Mark Haxe GDExtension bindings as archived (#10330) 3 veckor sedan
classes d93d120bb0 classref: Sync with current 4.3 branch (6699ae7) 2 månader sedan
community 13a47e3b00 Remove link to Reddit list of tutorials 3 veckor sedan
contributing 3489cc51fb Update file_access.h location 3 veckor sedan
getting_started 032be9e338 Clarify Area2D warning behavior (#10173) 3 veckor sedan
img 1586144704 Improve color constants cheat sheet (#8569) 4 månader sedan
tutorials faac424508 Add links to project setting mentions 3 veckor sedan
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 år sedan
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 år sedan
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 1 år sedan
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 4 månader sedan
.pre-commit-config.yaml f9e72e2bad CI: Integrate pre-commit for style checks 3 veckor sedan
.readthedocs.yml d9e0d8386e Add tools definition for RTD 1 år sedan
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 4 månader sedan
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 år sedan
Makefile 31204023b6 Makefile: use sphinx-build -M 1 år sedan
README.md 923fbf2bb6 Update ReadMe file with offline doc options 5 månader sedan
conf.py 7a79288319 Restore old menu 3 veckor sedan
index.rst 521d6749bc Branch docs version 4.3 4 månader sedan
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 1 år sedan
pyproject.toml f9e72e2bad CI: Integrate pre-commit for style checks 3 veckor sedan
requirements.txt 70f703a6c8 Update Sphinx version 3 veckor sedan
robots.txt fd5f6f4909 Appease our great search engine overlords 4 år sedan

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 (updated every Monday): stable, latest, 3.6. 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 (updated every Monday): stable, latest, 3.6. 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.