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

#godot #docs #howto

目录树: 097c7ecbcc
分支列表 标签列表
godot-docs
ZIP TAR.GZ
Max Hilbrunner 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it 10 月之前
.github b40f92eba9 CI: Skip class ref. sync and offline docs on forks 9 月之前
_extensions b09ab6fef9 Fix keywords for Vector in GDScript syntax highlighting 11 月之前
_static 57c24d9b46 Fix scrolling outside of content area 1 年之前
_styleguides 88970e5daa Add German style guide 1 年之前
_templates 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it 9 月之前
_tools 799f39d4b6 Fix redirect to new contribution guidelines 1 年之前
about cc32aced26 Replace broken link to official discord 9 月之前
classes d93d120bb0 classref: Sync with current 4.3 branch (6699ae7) 11 月之前
community 40bdaac499 Remove note in Submitting to Asset Library 9 月之前
contributing f6b7d835b8 Fix link to Windows platform port in Custom platform ports 9 月之前
getting_started ffff2e7afd Link to Getting Started Input tutorial from Input examples page (#10200) 9 月之前
img 1586144704 Improve color constants cheat sheet (#8569) 1 年之前
tutorials ea02eb44b5 Fix "or_greater"/"or_less" code example 9 月之前
.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 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 1 年之前
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 年之前
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 923fbf2bb6 Update ReadMe file with offline doc options 1 年之前
conf.py 097c7ecbcc Remove canonical/hreflang tags, let RTD I18N do it 9 月之前
index.rst 521d6749bc Branch docs version 4.3 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.