Domů Procházet Nápověda
Přihlásit se
Godot
/
godot-docs
zrcadlo https://github.com/godotengine/godot-docs.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki

#godot #docs #howto

Strom: 097c7ecbcc
Větve Značky
godot-docs
ZIP TAR.GZ
Max Hilbrunner 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it před 10 měsíci
.github b40f92eba9 CI: Skip class ref. sync and offline docs on forks před 9 měsíci
_extensions b09ab6fef9 Fix keywords for Vector in GDScript syntax highlighting před 11 měsíci
_static 57c24d9b46 Fix scrolling outside of content area před 1 rokem
_styleguides 88970e5daa Add German style guide před 1 rokem
_templates 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it před 9 měsíci
_tools 799f39d4b6 Fix redirect to new contribution guidelines před 1 rokem
about cc32aced26 Replace broken link to official discord před 9 měsíci
classes d93d120bb0 classref: Sync with current 4.3 branch (6699ae7) před 11 měsíci
community 40bdaac499 Remove note in Submitting to Asset Library před 9 měsíci
contributing f6b7d835b8 Fix link to Windows platform port in Custom platform ports před 9 měsíci
getting_started ffff2e7afd Link to Getting Started Input tutorial from Input examples page (#10200) před 9 měsíci
img 1586144704 Improve color constants cheat sheet (#8569) před 1 rokem
tutorials ea02eb44b5 Fix "or_greater"/"or_less" code example před 9 měsíci
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) před 4 roky
.gitignore 47bacc95fd Added configuring ide for rider (#7420) před 2 roky
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years před 1 rokem
.readthedocs.yml d9e0d8386e Add tools definition for RTD před 2 roky
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years před 1 rokem
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license před 6 roky
Makefile 31204023b6 Makefile: use sphinx-build -M před 2 roky
README.md 923fbf2bb6 Update ReadMe file with offline doc options před 1 rokem
conf.py 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it před 9 měsíci
index.rst 521d6749bc Branch docs version 4.3 před 1 rokem
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs před 2 roky
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages před 1 rokem
robots.txt fd5f6f4909 Appease our great search engine overlords před 5 roky

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.