首页 发现 帮助
登录
Godot
/
godot-docs
镜像自地址 https://github.com/godotengine/godot-docs.git
2
0
派生 0
文件 工单管理 0 Wiki

#godot #docs #howto

目录树: fd8bde9eac
分支列表 标签列表
godot-docs
ZIP TAR.GZ
Orville Q. Song fd8bde9eac Fix the wrong hyperlink to XR Tools. 2 年之前
.github 9473b6c9e3 Enable error reporting on the CI and address the remaining errors 2 年之前
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 年之前
_static d14d924470 Display Godot version more clearly 2 年之前
_templates d14d924470 Display Godot version more clearly 2 年之前
_tools d44c1bd7dc Update redirects 2 年之前
about c799afdfa2 Update Importing 3D scenes documentation for Godot 4.0 (#6800) 2 年之前
classes fb93c04226 classref: Sync with 4.0-stable 2 年之前
community 87298c021f Update FAQ for Godot 4.0 2 年之前
contributing 978a13bb0a Mark potentially outdated pages with a WIP warning 2 年之前
getting_started f9bf150643 Merge pull request #6896 from dalexeev/gds-var-colon-style 2 年之前
img 4096508fb6 Change the square logo for a wide one (#6397) 2 年之前
tutorials fd8bde9eac Fix the wrong hyperlink to XR Tools. 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 ad6846b80e ReadTheDocs redirect automation. 3 年之前
.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 2 年之前
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.