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

#godot #docs #howto

트리: 80b71c4ba8
브랜치 태그
godot-docs
ZIP TAR.GZ
Hugo Locurcio 80b71c4ba8 Document missing macOS/iOS support for HTML5 due to upstream bugs 2 년 전
.github 9473b6c9e3 Enable error reporting on the CI and address the remaining errors 2 년 전
_extensions 7d5fb4e6a2 Various fixups 2 년 전
_static d14d924470 Display Godot version more clearly 2 년 전
_templates d14d924470 Display Godot version more clearly 2 년 전
_tools 1b0310aa47 Fix typos and make CI a happy Gobot 2 년 전
about 8d1cfa6c37 Merge pull request #6345 from Calinou/add-custom-platform-ports 2 년 전
classes fb93c04226 classref: Sync with 4.0-stable 2 년 전
community 08498ef96a Change capitalization of Project Manager 2 년 전
contributing 057d8b97f1 Merge pull request #7031 from wlsnmrk/sphinx-build-dir 2 년 전
getting_started 79bbffaadd Merge pull request #7021 from kastaldi/patch-1 2 년 전
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 2 년 전
tutorials 80b71c4ba8 Document missing macOS/iOS support for HTML5 due to upstream bugs 2 년 전
.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 bc925e0c80 Made a sentence easier to read and included a reference to class_String (#7034) 2 년 전
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 년 전
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 년 전
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 e7c7cf1510 Allow specifying a list of files for the make command 2 년 전
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) 2 년 전
conf.py d14d924470 Display Godot version more clearly 2 년 전
index.rst d524544e07 Improve naming and organization of some manual articles 2 년 전
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 년 전
requirements.txt 64a60696bf Pin additional build requirements to avoid syntax highlighting issues 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

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.

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.