Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
godotengine
/
godot-docs
zrkadlo https://github.com/godotengine/godot-docs
Pridať medzi pozorované 1
Hviezda 1
Fork 0
Súbory

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: master
Branche Tagy
godot-docs
ZIP TAR.GZ
Max Hilbrunner 47cd64c66f Merge pull request #10311 from mhilbrunner/fix-ci 17 hodín pred
.github f70686cdbe CI: Integrate `pre-commit` for style checks 1 týždeň pred
_extensions b646c65bed Update GDScript syntax highlighter 3 týždňov pred
_static c10b857b54 Improve shader function descriptions (#9338) 3 dní pred
_styleguides 88970e5daa Add German style guide 1 rok pred
_templates 181206baaa Remove canonical/hreflang tags, let RTD I18N do it 2 týždňov pred
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 1 týždeň pred
about 26cd9d1c72 Add Shader functions page to documentation changelog 1 deň pred
classes fa8c14368b classref: Sync with current master branch (0c45ace) 20 hodín pred
community 31723d8fcf Remove note in Submitting to Asset Library 1 mesiac pred
contributing 9057f15806 Add dev_build and dev_mode flags to scons compilation instructions for desktop editor pages 3 dní pred
getting_started b82187d22c Clarify Area2D warning behavior (#10173) 2 dní pred
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 3 mesiacov pred
tutorials 1e9348b138 Delete mention of OpenGL ES 2 1 deň pred
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 rokov pred
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 rokov pred
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 1 rok pred
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 3 mesiacov pred
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 18 hodín pred
.readthedocs.yml d9e0d8386e Add tools definition for RTD 1 rok pred
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 3 mesiacov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile 31204023b6 Makefile: use sphinx-build -M 1 rok pred
README.md d4b2a69cf6 Fix broken link in README to Contributing section 3 týždňov pred
conf.py df5976ae09 Merge pull request #10194 from Piralein/layoutfix 1 týždeň pred
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 4 mesiacov pred
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 1 rok pred
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 1 týždeň pred
requirements.txt 436b6e1793 Bump sphinx-rtd-theme from 3.0.1 to 3.0.2 1 týždeň pred
robots.txt fd5f6f4909 Appease our great search engine overlords 4 rokov pred

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.