Startseite Erkunden Hilfe
Anmelden
Godot
/
godot-docs
Mirror von https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Dateien Issues 0 Wiki

#godot #docs #howto

Struktur: e19bb908c0
Branches Tags
godot-docs
ZIP TAR.GZ
Max Hilbrunner e19bb908c0 Merge pull request #5345 from skyace65/UI_Navigation vor 3 Jahren
.github 7b35584569 GitHub Actions: Don't build with warnings-as-errors for offline doc vor 3 Jahren
_extensions 45c9248c06 Update GDScriptLexer to GDScript 2.0 vor 4 Jahren
_static 4f67dc3cac Reorganize and update the "BBCode in RichTextLabel" article vor 4 Jahren
_templates 6ae96e7b50 Implemented Algolia search (#4884) vor 4 Jahren
_tools 5e3a7c8fd1 Add a tool to move rst files and images vor 4 Jahren
about 50f809abbb Release policy: Mark 2.1 and 3.1 as EOL vor 3 Jahren
classes 15f78ae0b9 classref: Update links to documentation pages after reorganization vor 3 Jahren
community 154c093f97 C++ style guide: Require clang-format 13 vor 3 Jahren
development ba83e29286 Fix instructions for installing SCons on Windows vor 3 Jahren
getting_started fafafd2675 Updated incorrect keyboard shortcut vor 3 Jahren
img aff48371b2 Add cheatsheet and comparison image for `ease()` and `smoothstep()` vor 4 Jahren
tutorials e19bb908c0 Merge pull request #5345 from skyace65/UI_Navigation vor 3 Jahren
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 4 Jahren
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) vor 4 Jahren
.gitignore 1361ffb70c Add _tools folder for utility scripts vor 5 Jahren
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors vor 5 Jahren
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 vor 5 Jahren
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors vor 5 Jahren
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license vor 6 Jahren
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial vor 5 Jahren
README.md 4060179184 Remove trailing space characters (#5251) vor 4 Jahren
conf.py 4060179184 Remove trailing space characters (#5251) vor 4 Jahren
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) vor 4 Jahren
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" vor 5 Jahren
requirements.txt edc6472797 Bump sphinx-tabs from 3.1.0 to 3.2.0 vor 4 Jahren
robots.txt fd5f6f4909 Appease our great search engine overlords vor 5 Jahren

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

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.

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. 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.