Strona główna Odkrywaj Pomoc
Zaloguj się
godotengine
/
godot-docs
kopia lustrzana https://github.com/godotengine/godot-docs
Obserwuj 1
Polub 1
Forkuj 0
Pliki

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.

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

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.