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: 723a9a38c8
Branches Tags
godot-docs
ZIP TAR.GZ
Max Hilbrunner 723a9a38c8 Merge pull request #9873 from HolonProduction/sub-plugins vor 8 Monaten
.github f70686cdbe CI: Integrate `pre-commit` for style checks vor 8 Monaten
_extensions b646c65bed Update GDScript syntax highlighter vor 9 Monaten
_static 6a9dc9b6a9 Update Sphinx version vor 9 Monaten
_styleguides 88970e5daa Add German style guide vor 1 Jahr
_templates 181206baaa Remove canonical/hreflang tags, let RTD I18N do it vor 9 Monaten
_tools f70686cdbe CI: Integrate `pre-commit` for style checks vor 8 Monaten
about d837593d9a Add custom codespell dictionary vor 9 Monaten
classes 94aadc9a52 Merge pull request #10267 from Repiteo/ci/pre-commit vor 8 Monaten
community 31723d8fcf Remove note in Submitting to Asset Library vor 9 Monaten
contributing 9a2fccb54b Merge pull request #10277 from mhilbrunner/salvage-9858 vor 8 Monaten
getting_started f70686cdbe CI: Integrate `pre-commit` for style checks vor 8 Monaten
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) vor 11 Monaten
tutorials 723a9a38c8 Merge pull request #9873 from HolonProduction/sub-plugins vor 8 Monaten
.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 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years vor 11 Monaten
.pre-commit-config.yaml f70686cdbe CI: Integrate `pre-commit` for style checks vor 8 Monaten
.readthedocs.yml d9e0d8386e Add tools definition for RTD vor 2 Jahren
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years vor 11 Monaten
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 d4b2a69cf6 Fix broken link in README to Contributing section vor 9 Monaten
conf.py df5976ae09 Merge pull request #10194 from Piralein/layoutfix vor 8 Monaten
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute vor 1 Jahr
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs vor 2 Jahren
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks vor 8 Monaten
requirements.txt 436b6e1793 Bump sphinx-rtd-theme from 3.0.1 to 3.0.2 vor 8 Monaten
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 (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.