Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
Godot
/
godot-docs
zrkadlo https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Súbory Issues 0 Wiki

#godot #docs #howto

Strom: 58bc70ff28
Branche Tagy
godot-docs
ZIP TAR.GZ
Yuri Roubinsky 58bc70ff28 Few more fixes/enchancements to shaders 3 rokov pred
.github 7b35584569 GitHub Actions: Don't build with warnings-as-errors for offline doc 3 rokov pred
_extensions 45c9248c06 Update GDScriptLexer to GDScript 2.0 4 rokov pred
_static 4f67dc3cac Reorganize and update the "BBCode in RichTextLabel" article 3 rokov pred
_templates 6ae96e7b50 Implemented Algolia search (#4884) 4 rokov pred
_tools 5e3a7c8fd1 Add a tool to move rst files and images 4 rokov pred
about 4304158511 Mark the Godot 3.3 series as partially supported 3 rokov pred
classes 904e9d6cf7 classref: Sync with latest 4.0-dev 3 rokov pred
community 154c093f97 C++ style guide: Require clang-format 13 3 rokov pred
development 8d1f5c74db Fix incorrect export template path in Compiling for macOS (#5425) 3 rokov pred
getting_started ceffab3d03 Add input mapping to creeps tutorial (#5383) 3 rokov pred
img aff48371b2 Add cheatsheet and comparison image for `ease()` and `smoothstep()` 3 rokov pred
tutorials 58bc70ff28 Few more fixes/enchancements to shaders 3 rokov pred
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitignore 1361ffb70c Add _tools folder for utility scripts 5 rokov pred
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 rokov pred
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 rokov pred
AUTHORS.md c7144215ef Fix formatting on AUTHORS.md file 3 rokov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile c58ed951a1 Drop LaTeX dependency via usage of sphinx.ext.imgmath in Vector Math tutorial 5 rokov pred
README.md 4060179184 Remove trailing space characters (#5251) 3 rokov pred
conf.py 4060179184 Remove trailing space characters (#5251) 3 rokov pred
index.rst 4664df9819 Build offline documentation for the stable branch as well (#4896) 4 rokov pred
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 rokov pred
requirements.txt 87c8f73767 Bump sphinxext-opengraph from 0.4.2 to 0.5.0 (#5405) 3 rokov pred
robots.txt fd5f6f4909 Appease our great search engine overlords 5 rokov pred

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.