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

#godot #docs #howto

目錄樹: 30193215cf
分支列表 標籤列表
godot-docs
ZIP TAR.GZ
Rémi Verschelde 30193215cf classref: Sync with latest 4.0-dev 3 年之前
.github 7b35584569 GitHub Actions: Don't build with warnings-as-errors for offline doc 3 年之前
_extensions 45c9248c06 Update GDScriptLexer to GDScript 2.0 4 年之前
_static 4f67dc3cac Reorganize and update the "BBCode in RichTextLabel" article 3 年之前
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 年之前
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 年之前
about fa34841739 Improve the FreeType copyright year editor mention 3 年之前
classes 30193215cf classref: Sync with latest 4.0-dev 3 年之前
community 154c093f97 C++ style guide: Require clang-format 13 3 年之前
development cb5f51a2e7 Add libatomic-static dependency for Fedora in Compiling for Linux, *BSD 3 年之前
getting_started 047ba3909f Type for loop invariant, i/index, in squash check 3 年之前
img aff48371b2 Add cheatsheet and comparison image for `ease()` and `smoothstep()` 3 年之前
tutorials 22f17d24fc Fix missing word in When and how to avoid using nodes for everything (#5386) 3 年之前
.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 c7144215ef Fix formatting on AUTHORS.md file 3 年之前
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 4060179184 Remove trailing space characters (#5251) 3 年之前
conf.py 4060179184 Remove trailing space characters (#5251) 3 年之前
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 年之前
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 年之前
requirements.txt 308f6e4f54 Pin docutils to <0.18 to fix CI due to new warning 3 年之前
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. 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.