首頁 探索 說明
登入
Godot
/
godot-docs
镜像来自 https://github.com/godotengine/godot-docs.git
2
0
複刻 0
檔案 問題管理 0 Wiki

#godot #docs #howto

目錄樹: 24d0a7ec39
分支列表 標籤列表
godot-docs
ZIP TAR.GZ
Hugo Locurcio 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 年之前
.github aab75310c7 Update PR template 4 年之前
_extensions cf655aa176 Revert "Fix Sphinx `add_lexer()` deprecation in the GDScript extension (#4594)" 4 年之前
_static cbeb9212cc Fix the "ref" badge appearing twice in search results 4 年之前
_templates d494d19dac Remove trailing whitespace and irregular whitespace 5 年之前
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 年之前
about a922efa2a8 Add an Using the web editor page (#4629) 4 年之前
classes d0eb1eb6bc Move remaining files out of step_by_step/ 4 年之前
community b8bda4b3d4 Added Andrew Wilkes' video/text tutorial platforms (#4699) 4 年之前
development 33887d5c7b Add libstdc++-static to Fedora pre-compile one-liner 4 年之前
getting_started 1cdd6c9cc7 Replace instance diagram images for readability on all backgrounds (#4609) 4 年之前
img e13ac6fce4 Merge pull request #4679 from Calinou/add-img-folder-readme 4 年之前
tutorials 89fd7ef6a6 Edit iOS plugin documentation updates 4 年之前
.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 1361ffb70c Add _tools folder for utility scripts 5 年之前
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 年之前
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 年之前
AUTHORS.md 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 年之前
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 年之前
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 年之前
README.md bdeb07691a Fix URL typo in the README (#4415) 4 年之前
conf.py f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 年之前
index.rst 761592598f Remove mentions of IRC in favor of the new Contributors Chat platform (#4644) 4 年之前
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 年之前
requirements.txt f528a844d6 Add a more descriptive custom 404 error page (#4624) 4 年之前
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.

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