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: 4.3
Branches Tags
godot-docs
ZIP TAR.GZ
notPelf 8835289fe7 Add info about layer mask exporting to physics_introduction.rst (#10242) il y a 1 semaine
.github 0f3fabbb5a Update codespell path and fix spelling errors il y a 1 mois
_extensions b09ab6fef9 Fix keywords for Vector in GDScript syntax highlighting il y a 1 mois
_static 57c24d9b46 Fix scrolling outside of content area il y a 4 mois
_styleguides 88970e5daa Add German style guide il y a 1 an
_templates bedd304160 Remove Giscus from search page (#8777) il y a 10 mois
_tools 799f39d4b6 Fix redirect to new contribution guidelines il y a 4 mois
about 5bfbe5674f Update iOS system requirements. il y a 1 mois
classes d93d120bb0 classref: Sync with current 4.3 branch (6699ae7) il y a 1 mois
community 402b0234fc Remove individual youtube channel links from tutorials page il y a 1 mois
contributing f7e8509a17 Improve sidebar navigation by removing headers il y a 1 mois
getting_started d9fde9ea1f Tweak note about making Physics Material unique in Creating instances il y a 1 mois
img 1586144704 Improve color constants cheat sheet (#8569) il y a 3 mois
tutorials 8835289fe7 Add info about layer mask exporting to physics_introduction.rst (#10242) il y a 1 semaine
.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 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years il y a 3 mois
.readthedocs.yml d9e0d8386e Add tools definition for RTD il y a 1 an
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years il y a 3 mois
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 923fbf2bb6 Update ReadMe file with offline doc options il y a 4 mois
conf.py 521d6749bc Branch docs version 4.3 il y a 3 mois
index.rst 521d6749bc Branch docs version 4.3 il y a 3 mois
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs il y a 1 an
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages il y a 8 mois
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 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.