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: f3ada36d06
Ranting Tag
godot-docs
ZIP TAR.GZ
kleonc f3ada36d06 Fix incorrect reference to PacketPeerUDP.bind in migrating tutorial 2 tahun lalu
.github 4e53ed3252 Merge pull request #7274 from Calinou/ci-build-epub 2 tahun lalu
_extensions 7d5fb4e6a2 Various fixups 2 tahun lalu
_static 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 tahun lalu
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 tahun lalu
_tools 1b0310aa47 Fix typos and make CI a happy Gobot 2 tahun lalu
about fcdce11d22 Merge pull request #7179 from mhilbrunner/about-intro 2 tahun lalu
classes fb93c04226 classref: Sync with 4.0-stable 2 tahun lalu
community 3a7e86f77e Gwizz YT Channel Added 2 tahun lalu
contributing cc581494a4 Merge pull request #7276 from Calinou/validation-layers-add-desktop-platforms 2 tahun lalu
getting_started 9e7def4483 Remove outdated HiDPI note from nodes and scenes 2 tahun lalu
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 2 tahun lalu
tutorials f3ada36d06 Fix incorrect reference to PacketPeerUDP.bind in migrating tutorial 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 bc925e0c80 Made a sentence easier to read and included a reference to class_String (#7034) 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 3 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 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 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 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 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.