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: 705d9940f6
Ramuri Etichete
godot-docs
ZIP TAR.GZ
Matthew 705d9940f6 Merge pull request #8527 from ershn/patch-1 1 an în urmă
.github 1825a772e6 Bump actions/checkout from 3 to 4 2 ani în urmă
_extensions 131491cc8b Update GDScript lexer 1 an în urmă
_static 9c5cc147cd Reimplement space-to-tab regex without lookbehind 1 an în urmă
_styleguides 88970e5daa Add German style guide 1 an în urmă
_templates ca94970356 Less intrusive 4.0 update state info (#7100) 2 ani în urmă
_tools 0f058184ad Add redirects for old UWP pages to FAQ note 1 an în urmă
about 7f97b671f9 Merge pull request #7889 from akien-mga/drop-uwp 1 an în urmă
classes 3c2eef1f25 classref: Sync with current master branch (80de898) 1 an în urmă
community 023d3c0051 Add FencerDevLog to the list of video tutorials in tutorials.rst 1 an în urmă
contributing ee401703f0 Remove UWP mentions as the platform port was removed in 4.2 1 an în urmă
getting_started ee1fe1caea Merge pull request #8462 from theDrake/patch-2 1 an în urmă
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 ani în urmă
tutorials 1828e5ad90 Fix typo in background_loading.rst 1 an î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 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 ani în urmă
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 ani în urmă
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 ani î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 9d1dd80374 Build ePubs of the documentation for offline reading 2 ani în urmă
conf.py 6d295f7c84 conf.py: Fix regression with composite language codes 1 an în urmă
index.rst 9d1dd80374 Build ePubs of the documentation for offline reading 2 ani în urmă
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 ani în urmă
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2 ani î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 use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also 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.

For mobile devices or e-readers, you can also download an ePub copy for offline reading (updated every Monday). 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

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.