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

#godot #docs #howto

目录树: 1e2f11fbc3
分支列表 标签列表
godot-docs
ZIP TAR.GZ
Matthew 1e2f11fbc3 Merge pull request #6426 from Element894/patch-1 2 年之前
.github b07952f635 Update pull request template to be similar to godotengine/godot (#5909) 3 年之前
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 年之前
_static 7f0c2e4a1d Merge pull request #6412 from YuriSizov/frontend-search-results-islands 2 年之前
_templates 21f92e43d6 Add a link to doc writing guidelines to the header (#5947) 3 年之前
_tools 4096508fb6 Change the square logo for a wide one (#6397) 2 年之前
about 1b065c4f32 Add a Godot 3 to Godot 4 upgrade guide (#6393) 2 年之前
classes 3cb71819bf Update class reference index with better grouping 2 年之前
community a5bf20bb6d Add support for split class reference 2 年之前
development 509804650e Update all instances of `instance()` to `instantiate()` 2 年之前
getting_started 1e2f11fbc3 Merge pull request #6426 from Element894/patch-1 2 年之前
img 4096508fb6 Change the square logo for a wide one (#6397) 2 年之前
tutorials 79bf69fd2e Merge pull request #6437 from Calinou/update-instantiate 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 3 年之前
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 年之前
Makefile f3d1dff63b Minor English improvements for Makefile 3 年之前
README.md 1fe3fa4898 add a link to building the manual in readme 3 年之前
conf.py 0209919fc2 Remove search highlights from the page and the history 2 年之前
index.rst b68c505789 Make sidebar categories collapsible 2 年之前
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 年之前
requirements.txt a4a1d90c80 Bump sphinx-notfound-page from 0.8 to 0.8.3 3 年之前
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.