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

#godot #docs #howto

目录树: 18ad4e72f3
分支列表 标签列表
godot-docs
ZIP TAR.GZ
Gio 18ad4e72f3 Ubuntu APT oneliner to install system builtin alternatives (#9512) 1 年之前
.github dbb13eb5a9 Clarify where to report engine bugs 1 年之前
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 年之前
_static 57c24d9b46 Fix scrolling outside of content area 1 年之前
_styleguides 88970e5daa Add German style guide 1 年之前
_templates bedd304160 Remove Giscus from search page (#8777) 1 年之前
_tools 799f39d4b6 Fix redirect to new contribution guidelines 1 年之前
about 19ffef34f8 Update Docs for ARM support 1 年之前
classes 9479a5e658 classref: Sync with current master branch (607b230) 1 年之前
community b08d7fea84 First look at editor's interface iteration 1 年之前
contributing 18ad4e72f3 Ubuntu APT oneliner to install system builtin alternatives (#9512) 1 年之前
getting_started b08d7fea84 First look at editor's interface iteration 1 年之前
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 年之前
tutorials afbece3bdf Merge pull request #9250 from raulsntos/breaking_changes_4.3 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 2 年之前
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 年之前
Makefile 31204023b6 Makefile: use sphinx-build -M 2 年之前
README.md 923fbf2bb6 Update ReadMe file with offline doc options 1 年之前
conf.py 3e3bbde35b Add support for embedding videos in documentation pages 1 年之前
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 年之前
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 年之前
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 年之前
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 download an HTML copy (updated every Monday): stable, latest, 3.6. 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 (updated every Monday): stable, latest, 3.6. 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

With 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.