Acasă Explorează Ajutor
Autentificare
Godot
/
godot-docs
oglindă de https://github.com/godotengine/godot-docs.git
2
0
Bifurcare 0
Fisiere Probleme 0 Wiki

#godot #docs #howto

Arbore: 50cb22fd09
Ramuri Etichete
godot-docs
ZIP TAR.GZ
Shawn Hardern 50cb22fd09 Add C# examples to CPU optimization 11 luni în urmă
.github 521d6749bc Branch docs version 4.3 11 luni în urmă
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 an în urmă
_static 57c24d9b46 Fix scrolling outside of content area 1 an în urmă
_styleguides 88970e5daa Add German style guide 1 an în urmă
_templates bedd304160 Remove Giscus from search page (#8777) 1 an în urmă
_tools 799f39d4b6 Fix redirect to new contribution guidelines 1 an în urmă
about 19ffef34f8 Update Docs for ARM support 1 an în urmă
classes 9c9e3a391e classref: Sync with current master branch (8e666ad) 11 luni în urmă
community b08d7fea84 First look at editor's interface iteration 1 an în urmă
contributing 050c9b94a9 Update certain example code snippets to use the new syntax 10 luni în urmă
getting_started 8be74fd9ac Fix glTF capitalization in manual 10 luni în urmă
img 1586144704 Improve color constants cheat sheet (#8569) 1 an în urmă
tutorials 50cb22fd09 Add C# examples to CPU optimization 10 luni în urmă
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 ani în urmă
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 ani în urmă
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 ani în urmă
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 luni în urmă
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 ani în urmă
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 luni în urmă
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 ani în urmă
Makefile 31204023b6 Makefile: use sphinx-build -M 2 ani în urmă
README.md 923fbf2bb6 Update ReadMe file with offline doc options 1 an în urmă
conf.py 521d6749bc Branch docs version 4.3 11 luni în urmă
index.rst 521d6749bc Branch docs version 4.3 11 luni în urmă
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 ani în urmă
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 an în urmă
robots.txt fd5f6f4909 Appease our great search engine overlords 5 ani în urmă

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

To browse the documentation offline, you can download an HTML copy (updated every Monday): stable, latest, 3.6. Extract the ZIP archive then open the top-level index.html in a web browser.

For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): stable, latest, 3.6. Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.

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

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