Domů Procházet Nápověda
Přihlásit se
Godot
/
godot-docs
zrcadlo https://github.com/godotengine/godot-docs.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki

#godot #docs #howto

Strom: 4f5b70c45a
Větve Značky
godot-docs
ZIP TAR.GZ
Max Hilbrunner 4f5b70c45a Merge pull request #8109 from strobelt/add-csharp-tips-to-jump-and-squash-3d-tutorial před 1 rokem
.github 1825a772e6 Bump actions/checkout from 3 to 4 před 1 rokem
_extensions da3f1a1275 GDScript: Document `match` pattern guards před 1 rokem
_static 17b652d181 Merge pull request #7863 from dalexeev/use-relative-font-size-for-code před 1 rokem
_templates ca94970356 Less intrusive 4.0 update state info (#7100) před 2 roky
_tools e269ed9f56 Merge pull request #7884 from m4gr3d/update_android_plugin_tutorial před 1 rokem
about c3550c951b Merge pull request #8285 from Calinou/environment-glow-2d před 1 rokem
classes 33048e0960 classref: Sync with current master branch (6543495) před 1 rokem
community 83346a6a5a Update remaining QA links před 1 rokem
contributing 365a295c04 Merge pull request #8253 from skyace65/Windows-Defender před 1 rokem
getting_started 4f5b70c45a Merge pull request #8109 from strobelt/add-csharp-tips-to-jump-and-squash-3d-tutorial před 1 rokem
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) před 2 roky
tutorials 8751562e76 Merge pull request #8270 from mariomadproductions/master před 1 rokem
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitignore 47bacc95fd Added configuring ide for rider (#7420) před 2 roky
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors před 5 roky
.readthedocs.yml d9e0d8386e Add tools definition for RTD před 2 roky
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources před 2 roky
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license před 6 roky
Makefile 31204023b6 Makefile: use sphinx-build -M před 2 roky
README.md 9d1dd80374 Build ePubs of the documentation for offline reading před 2 roky
conf.py 82fac20c98 Update Godot version to 4.2 před 2 roky
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading před 2 roky
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs před 2 roky
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting před 2 roky
robots.txt fd5f6f4909 Appease our great search engine overlords před 5 roky

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 use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also 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

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.