Strona główna Odkrywaj Pomoc
Zaloguj się
Godot
/
godot-docs
kopia lustrzana https://github.com/godotengine/godot-docs.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki

#godot #docs #howto

Drzewo: 2afeaafa6a
Gałęzie Tagi
godot-docs
ZIP TAR.GZ
unknown 2afeaafa6a Update minimal websocket client example. 1 rok temu
.github 06bd5b3ccb Fix false positives in codespell CI and fix reported typos 1 rok temu
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 rok temu
_static ab67eb8437 Merge pull request #9324 from rburing/css_self_links 1 rok temu
_styleguides 88970e5daa Add German style guide 1 rok temu
_templates bedd304160 Remove Giscus from search page (#8777) 1 rok temu
_tools e92616b7af Merge pull request #9336 from smix8/nav_obstacles 1 rok temu
about 644552ddd2 Release policy: Bump 4.3 ETA to June 1 rok temu
classes eacfba2716 classref: Sync with current master branch (705b7a0) 1 rok temu
community 8520601b13 Update the community channels 1 rok temu
contributing 06bd5b3ccb Fix false positives in codespell CI and fix reported typos 1 rok temu
getting_started d5c54b9f47 Remove duplicate words in `getting_started/first_2d_game` 1 rok temu
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 lat temu
tutorials 2afeaafa6a Update minimal websocket client example. 1 rok temu
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 lat temu
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 lat temu
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 lat temu
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 lat temu
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 lat temu
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 lat temu
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 lat temu
Makefile 31204023b6 Makefile: use sphinx-build -M 2 lat temu
README.md dbe3a88377 Fix various minor typos 1 rok temu
conf.py 3e3bbde35b Add support for embedding videos in documentation pages 1 rok temu
index.rst c5c215a179 Added separate links to stable/latest/3.6 copies of the offline documentation 1 rok temu
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 lat temu
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 rok temu
robots.txt fd5f6f4909 Appease our great search engine overlords 5 lat temu

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.