Halaman utama Jelajahi Bantuan
Masuk
Godot
/
godot-docs
cermin dari https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Berkas Masalah 0 Wiki

#godot #docs #howto

Pohon: 14baaf0b3a
Ranting Tag
godot-docs
ZIP TAR.GZ
Hugo Locurcio 14baaf0b3a Add a page on decals 3 tahun lalu
.github 9473b6c9e3 Enable error reporting on the CI and address the remaining errors 2 tahun lalu
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 tahun lalu
_static ff4f111677 Add a warning that docs are WIP and a status flag for articles 2 tahun lalu
_templates ff4f111677 Add a warning that docs are WIP and a status flag for articles 2 tahun lalu
_tools d724dc1212 Merge pull request #6212 from paddy-exe/gdextension-docs 2 tahun lalu
about ea92f07f3c Fix CI 2 tahun lalu
classes af256254cd classref: Sync with current master branch (0cd148313) 2 tahun lalu
community 87298c021f Update FAQ for Godot 4.0 2 tahun lalu
contributing 978a13bb0a Mark potentially outdated pages with a WIP warning 2 tahun lalu
getting_started 98a9a62d54 Merge pull request #6807 from Piralein/3d🎠 2 tahun lalu
img 4096508fb6 Change the square logo for a wide one (#6397) 2 tahun lalu
tutorials 14baaf0b3a Add a page on decals 2 tahun lalu
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 tahun lalu
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 tahun lalu
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 tahun lalu
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 tahun lalu
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 tahun lalu
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 tahun lalu
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 tahun lalu
Makefile e7c7cf1510 Allow specifying a list of files for the make command 2 tahun lalu
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) 2 tahun lalu
conf.py ff4f111677 Add a warning that docs are WIP and a status flag for articles 2 tahun lalu
index.rst d524544e07 Improve naming and organization of some manual articles 2 tahun lalu
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 tahun lalu
requirements.txt 64a60696bf Pin additional build requirements to avoid syntax highlighting issues 2 tahun lalu
robots.txt fd5f6f4909 Appease our great search engine overlords 5 tahun lalu

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. Building the manual
  6. 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.