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: 47d13ae2a2
Ramuri Etichete
godot-docs
ZIP TAR.GZ
Benjiko99 47d13ae2a2 Fix typo in docs 1 an în urmă
.github b08b23d19b Build offline version of stable branch 1 an în urmă
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 an în urmă
_static ac92bfb47a Merge pull request #9015 from adamscott/fix-website-highlight 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 dbe3a88377 Fix various minor typos 1 an în urmă
about 644552ddd2 Release policy: Bump 4.3 ETA to June 1 an în urmă
classes a4b6919fea classref: Sync with current master branch (4a01602) 1 an în urmă
community 8520601b13 Update the community channels 1 an în urmă
contributing dbe3a88377 Fix various minor typos 1 an în urmă
getting_started 25b8b8f20f Add more information about VS and VS Code debugging (#9222) 1 an în urmă
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 ani în urmă
tutorials 47d13ae2a2 Fix typo in docs 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 dbe3a88377 Fix various minor typos 1 an în urmă
conf.py 3e3bbde35b Add support for embedding videos in documentation pages 1 an în urmă
index.rst 9b9a06cdb3 Remove reference to DevDocs copy of documentation 1 an î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 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

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.