Home Verkennen Help
Inloggen
Godot
/
godot-docs
spiegel van https://github.com/godotengine/godot-docs.git
2
0
Vork 0
Bestanden Issues 0 Wiki

#godot #docs #howto

Boom: a232d4bb18
Aftakkingen Labels
godot-docs
ZIP TAR.GZ
Rémi Verschelde a232d4bb18 Merge pull request #6886 from jrvidal/fix-export-web 2 jaren geleden
.github 9473b6c9e3 Enable error reporting on the CI and address the remaining errors 2 jaren geleden
_extensions c2d13c9ae4 Update GDScript syntax highlighting for Godot 4.0 3 jaren geleden
_static d14d924470 Display Godot version more clearly 2 jaren geleden
_templates d14d924470 Display Godot version more clearly 2 jaren geleden
_tools 1b0310aa47 Fix typos and make CI a happy Gobot 2 jaren geleden
about 1112060bf9 Fix punctuation and wording in FAQ (#6905) 2 jaren geleden
classes fb93c04226 classref: Sync with 4.0-stable 2 jaren geleden
community 87298c021f Update FAQ for Godot 4.0 2 jaren geleden
contributing 12720dd582 Merge pull request #6888 from rcorre/compiledb 2 jaren geleden
getting_started a7637e0ef1 Update getting started C# code, remove randomize (#6811) 2 jaren geleden
img 3dfbfbf381 Add links to demo projects where relevant (#6874) 2 jaren geleden
tutorials a232d4bb18 Merge pull request #6886 from jrvidal/fix-export-web 2 jaren geleden
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 jaren geleden
.gitignore ad6846b80e ReadTheDocs redirect automation. 3 jaren geleden
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 jaren geleden
.readthedocs.yml 3411e03ed9 RTD: Migrate config file to v2 5 jaren geleden
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 jaren geleden
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 jaren geleden
Makefile e7c7cf1510 Allow specifying a list of files for the make command 2 jaren geleden
README.md 0500f4df7c Update links in README to fix broken URLs (#6589) 2 jaren geleden
conf.py d14d924470 Display Godot version more clearly 2 jaren geleden
index.rst d524544e07 Improve naming and organization of some manual articles 2 jaren geleden
make.bat c60abb849e Revert "Default to parallel builds in Sphinx for faster builds" 5 jaren geleden
requirements.txt 64a60696bf Pin additional build requirements to avoid syntax highlighting issues 2 jaren geleden
robots.txt fd5f6f4909 Appease our great search engine overlords 5 jaren geleden

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.