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

#godot #docs #howto

目录树: bae4de3b5b
分支列表 标签列表
godot-docs
ZIP TAR.GZ
Max Hilbrunner bae4de3b5b Merge pull request #11172 from godotengine/dependabot/pip/sphinxext-opengraph-0.11.0 1 月之前
.github 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 1 月之前
_extensions 7a7ac7dc2d GDScript: Document abstract and variadic functions 2 月之前
_static 6792402014 Add custom Sphinx roles for editor UI 5 月之前
_styleguides 88970e5daa Add German style guide 1 年之前
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 8 月之前
_tools 3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 1 月之前
about a5897077f0 Fix incorrect Intel IGP minimum requirement in System requirements 1 月之前
classes 720c8ef830 classref: Sync with current master branch (c2202d3) 1 月之前
community a15f86bc03 Merge branch 'master' into patch-1 5 月之前
contributing 92dcf8cc9c Update kdevelop.rst (#11167) 1 月之前
getting_started db5cb61334 Merge pull request #11148 from Piralein/aWildLitterAppears 1 月之前
img a82ed18d3d Add FoldableContainer to the Control node gallery page 2 月之前
tutorials 90724ec6f7 Merge pull request #11169 from Muller-Castro/fix-scons-snippet 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 965685e247 Add more Python-related files to gitignore 7 月之前
.lycheeignore bf27bf2c96 Fix URL check errors 5 月之前
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 年之前
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 9 月之前
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 年之前
404.rst 2bfc2f04cf Hide user notes on 404 page 4 月之前
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 年之前
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 年之前
Makefile 31204023b6 Makefile: use sphinx-build -M 2 年之前
README.md d4b2a69cf6 Fix broken link in README to Contributing section 10 月之前
conf.py 69d69dad2c Update Godot docs version to 4.5 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 年之前
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 10 月之前
requirements.txt 314b306e08 Bump sphinxext-opengraph from 0.10.0 to 0.11.0 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.