홈 탐색 도움말
로그인
Godot
/
godot-docs
의 미러 https://github.com/godotengine/godot-docs.git
2
0
포크 0
파일 이슈 0 위키

#godot #docs #howto

트리: e83fd34f10
브랜치 태그
godot-docs
ZIP TAR.GZ
Max Hilbrunner e83fd34f10 Merge pull request #8430 from skyace65/FirstScript 1 년 전
.github 1825a772e6 Bump actions/checkout from 3 to 4 1 년 전
_extensions 131491cc8b Update GDScript lexer 1 년 전
_static 9c5cc147cd Reimplement space-to-tab regex without lookbehind 1 년 전
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 년 전
_tools e269ed9f56 Merge pull request #7884 from m4gr3d/update_android_plugin_tutorial 1 년 전
about 3b9cb26da3 Merge pull request #8388 from Calinou/gdextension-update-references 1 년 전
classes 2bba3c85dd classref: Sync with current master branch (5ee9831) 1 년 전
community 64d44971bf Add Video and Text tutorial links for tutorials.rst (#8335) 1 년 전
contributing e0a8e07f56 Update list of modules that can be disabled in Optimizing for size 1 년 전
getting_started e83fd34f10 Merge pull request #8430 from skyace65/FirstScript 1 년 전
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 년 전
tutorials d2c5133674 Merge pull request #8136 from Hex-4/fix-scripting-advanced-settings 1 년 전
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 년 전
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 년 전
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 년 전
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 년 전
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 년 전
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 년 전
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 년 전
Makefile 31204023b6 Makefile: use sphinx-build -M 2 년 전
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 년 전
conf.py 6c074b44cb Disable collapsing tabs for codeblocks 1 년 전
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading 2 년 전
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 년 전
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2 년 전
robots.txt fd5f6f4909 Appease our great search engine overlords 5 년 전

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.