Home Verkennen Help
Inloggen
Godot
/
godot-docs
spiegel van https://github.com/godotengine/godot-docs.git
2
0
Vork 0
Bestanden Issues 0 Wiki

#godot #docs #howto

Boom: 0caf2ac2bc
Aftakkingen Labels
godot-docs
ZIP TAR.GZ
Hugo Locurcio 0caf2ac2bc Recommend using fullscreen on Linux in Fixing jitter and stutter 1 jaar geleden
.github d20bdf8af6 Update configs to refer to 4.1 2 jaren geleden
_extensions 5f4c6838fc Use different color for control flow keywords in GDScript syntax highlighting 1 jaar geleden
_static 5f4c6838fc Use different color for control flow keywords in GDScript syntax highlighting 1 jaar geleden
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 jaren geleden
_tools 45c425079f Tell codespell to ignore the locale code page (#7519) 2 jaren geleden
about 2b8d7eb0dd Document macOS editor dock icon duplicating itself in Troubleshooting 1 jaar geleden
classes b4dad0ded6 classref: Sync with current 4.1 branch (6884be6) 2 jaren geleden
community e5ab33dd91 Merge pull request #7649 from sainthDE/patch-1 2 jaren geleden
contributing 79a5ee8d14 fix: update location fo node_3d_editor_gizmos.cpp 1 jaar geleden
getting_started be0419035b Update 02.player_scene.rst 1 jaar geleden
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 jaren geleden
tutorials 0caf2ac2bc Recommend using fullscreen on Linux in Fixing jitter and stutter 1 jaar geleden
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 jaren geleden
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 jaren geleden
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 jaren geleden
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 jaren geleden
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 jaren geleden
Makefile 31204023b6 Makefile: use sphinx-build -M 2 jaren geleden
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 jaren geleden
conf.py 02ddcdc5e2 Update remaining master branch references 2 jaren geleden
index.rst 02ddcdc5e2 Update remaining master branch references 2 jaren geleden
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 jaren geleden
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2 jaren geleden
robots.txt fd5f6f4909 Appease our great search engine overlords 5 jaren geleden

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.