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: ce1b9dfb94
Branches Tags
godot-docs
ZIP TAR.GZ
Stephen Li ce1b9dfb94 Fix link written in md syntax instead of rst vor 1 Jahr
.github dbb13eb5a9 Clarify where to report engine bugs vor 1 Jahr
_extensions 0a01baec10 Fix epub-related failures (#8207) vor 1 Jahr
_static ab67eb8437 Merge pull request #9324 from rburing/css_self_links vor 1 Jahr
_styleguides 88970e5daa Add German style guide vor 1 Jahr
_templates bedd304160 Remove Giscus from search page (#8777) vor 1 Jahr
_tools e92616b7af Merge pull request #9336 from smix8/nav_obstacles vor 1 Jahr
about 3fafd46da6 Document how to handle compatibility breakages vor 1 Jahr
classes 22eec0f18c classref: Sync with current master branch (811ce36) vor 1 Jahr
community 9eb7467328 Adding a next steps page to the XR documentation vor 1 Jahr
contributing 17a683682c Update name of where you get openJDK from vor 1 Jahr
getting_started 7e2a730d05 pi/4 is 45 degrees. vor 1 Jahr
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) vor 2 Jahren
tutorials ce1b9dfb94 Fix link written in md syntax instead of rst vor 1 Jahr
.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 47bacc95fd Added configuring ide for rider (#7420) vor 2 Jahren
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors vor 5 Jahren
.readthedocs.yml d9e0d8386e Add tools definition for RTD vor 2 Jahren
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources vor 3 Jahren
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license vor 6 Jahren
Makefile 31204023b6 Makefile: use sphinx-build -M vor 2 Jahren
README.md dbe3a88377 Fix various minor typos vor 1 Jahr
conf.py 3e3bbde35b Add support for embedding videos in documentation pages vor 1 Jahr
index.rst c5c215a179 Added separate links to stable/latest/3.6 copies of the offline documentation vor 1 Jahr
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs vor 2 Jahren
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages vor 1 Jahr
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

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.