Halaman utama Jelajahi Bantuan
Masuk
Godot
/
godot-docs
cermin dari https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Berkas Masalah 0 Wiki

#godot #docs #howto

Pohon: 60e3f14d98
Ranting Tag
godot-docs
ZIP TAR.GZ
Danil Alexeev 60e3f14d98 Update "GDScript documentation comments" page 2 tahun lalu
.github 45c425079f Tell codespell to ignore the locale code page (#7519) 2 tahun lalu
_extensions 7d5fb4e6a2 Various fixups 2 tahun lalu
_static b57807b618 Make it possible to read abbreviations by tapping on mobile 2 tahun lalu
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 tahun lalu
_tools 45c425079f Tell codespell to ignore the locale code page (#7519) 2 tahun lalu
about 7f20fec3c3 Fix formatting for a link on the Release Policy page 2 tahun lalu
classes 0e78a34e3d classref: Sync with current master branch (031aa99) 2 tahun lalu
community 5201efb43e Add text tutorial 2 tahun lalu
contributing 3dda1b382d Mark UWP as non-functional in its respective export and compilation pages 2 tahun lalu
getting_started fe50006f2e Update player_scene_nodes.webp 2 tahun lalu
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 tahun lalu
tutorials 60e3f14d98 Update "GDScript documentation comments" page 2 tahun lalu
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 tahun lalu
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 tahun lalu
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 tahun lalu
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 tahun lalu
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 tahun lalu
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 tahun lalu
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 tahun lalu
Makefile 31204023b6 Makefile: use sphinx-build -M 2 tahun lalu
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 tahun lalu
conf.py 82fac20c98 Update Godot version to 4.2 2 tahun lalu
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading 2 tahun lalu
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 tahun lalu
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2 tahun lalu
robots.txt fd5f6f4909 Appease our great search engine overlords 5 tahun lalu

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 use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also 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

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.