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: f823ed239b
Aftakkingen Labels
godot-docs
ZIP TAR.GZ
Bastiaan Olij f823ed239b Add documentation about the compositor 1 jaar geleden
.github 06bd5b3ccb Fix false positives in codespell CI and fix reported typos 1 jaar geleden
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 jaar geleden
_static ab67eb8437 Merge pull request #9324 from rburing/css_self_links 1 jaar geleden
_styleguides 88970e5daa Add German style guide 1 jaar geleden
_templates bedd304160 Remove Giscus from search page (#8777) 1 jaar geleden
_tools 06bd5b3ccb Fix false positives in codespell CI and fix reported typos 1 jaar geleden
about 644552ddd2 Release policy: Bump 4.3 ETA to June 1 jaar geleden
classes eacfba2716 classref: Sync with current master branch (705b7a0) 1 jaar geleden
community 8520601b13 Update the community channels 1 jaar geleden
contributing 06bd5b3ccb Fix false positives in codespell CI and fix reported typos 1 jaar geleden
getting_started a4606200bb change shrink to enlarge in "Your first 3D game" tutorial 1 jaar geleden
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 jaren geleden
tutorials f823ed239b Add documentation about the compositor 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 3 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 dbe3a88377 Fix various minor typos 1 jaar geleden
conf.py 3e3bbde35b Add support for embedding videos in documentation pages 1 jaar geleden
index.rst c5c215a179 Added separate links to stable/latest/3.6 copies of the offline documentation 1 jaar geleden
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 jaren geleden
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 jaar 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 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

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.