Accueil Explorer Aide
Connexion
godotengine
/
godot-docs
miroir de https://github.com/godotengine/godot-docs
Suivre 1
Voter 1
Fork 0
Fichiers

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.

Branche: drop-uwp
Branches Tags
godot-docs
ZIP TAR.GZ
Rémi Verschelde 6af0eb0e0c Remove UWP mentions as the platform port was removed in 4.2 il y a 1 an
.github 1825a772e6 Bump actions/checkout from 3 to 4 il y a 1 an
_extensions 131491cc8b Update GDScript lexer il y a 1 an
_static 9c5cc147cd Reimplement space-to-tab regex without lookbehind il y a 1 an
_templates ca94970356 Less intrusive 4.0 update state info (#7100) il y a 1 an
_tools 70c6bca054 Merge pull request #8411 from Calinou/update-unused-images-script il y a 1 an
about 6af0eb0e0c Remove UWP mentions as the platform port was removed in 4.2 il y a 1 an
classes 877192fe6e classref: Sync with current master branch (e38686f) il y a 1 an
community 954658fa1b Add video tutorial reference (#8138) il y a 1 an
contributing 6af0eb0e0c Remove UWP mentions as the platform port was removed in 4.2 il y a 1 an
getting_started 9aba4a087a Merge pull request #8467 from Calinou/remove-unused-images il y a 1 an
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) il y a 1 an
tutorials 6af0eb0e0c Remove UWP mentions as the platform port was removed in 4.2 il y a 1 an
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) il y a 3 ans
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) il y a 3 ans
.gitignore 47bacc95fd Added configuring ide for rider (#7420) il y a 1 an
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors il y a 4 ans
.readthedocs.yml d9e0d8386e Add tools definition for RTD il y a 1 an
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources il y a 2 ans
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license il y a 6 ans
Makefile 31204023b6 Makefile: use sphinx-build -M il y a 1 an
README.md 9d1dd80374 Build ePubs of the documentation for offline reading il y a 1 an
conf.py 6c074b44cb Disable collapsing tabs for codeblocks il y a 1 an
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading il y a 1 an
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs il y a 1 an
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting il y a 1 an
robots.txt fd5f6f4909 Appease our great search engine overlords il y a 4 ans

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.