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

#godot #docs #howto

目录树: a40e4fd10a
分支列表 标签列表
godot-docs
ZIP TAR.GZ
Max Hilbrunner a40e4fd10a Merge pull request #7199 from Calinou/custom-mouse-cursor-update-max-size 2 年之前
.github cde5e82a65 Fix CI comment 2 年之前
_extensions 7d5fb4e6a2 Various fixups 2 年之前
_static 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 年之前
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 年之前
_tools 1b0310aa47 Fix typos and make CI a happy Gobot 2 年之前
about de7687fa3f Document how to resolve issues with the editor looking too sharp or blurry 2 年之前
classes fb93c04226 classref: Sync with 4.0-stable 2 年之前
community 3a7e86f77e Gwizz YT Channel Added 2 年之前
contributing e7cd5e5a92 [contributing/documentation/building_the_manual] fix headings 2 年之前
getting_started c6f35d11e7 Merge pull request #7171 from royzwambag/instancing-docs-update 2 年之前
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 2 年之前
tutorials 1bd3513507 Mention maximum recommended size of 128×128 in Customizing the mouse cursor 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 31204023b6 Makefile: use sphinx-build -M 2 年之前
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) 2 年之前
conf.py 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 2 年之前
index.rst d524544e07 Improve naming and organization of some manual articles 2 年之前
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 年之前
requirements.txt 2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918) 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.