Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
Godot
/
godot-docs
zrkadlo https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Súbory Issues 0 Wiki

#godot #docs #howto

Strom: dd4c2439fe
Branche Tagy
godot-docs
ZIP TAR.GZ
Bastiaan Olij dd4c2439fe Add a note to the vendor plugin info that it no longer needs to be enabled. 1 rok pred
.github b08b23d19b Build offline version of stable branch 1 rok pred
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 rok pred
_static ac92bfb47a Merge pull request #9015 from adamscott/fix-website-highlight 1 rok pred
_styleguides 88970e5daa Add German style guide 1 rok pred
_templates bedd304160 Remove Giscus from search page (#8777) 1 rok pred
_tools 643001f9b1 Merge pull request #8450 from Cerno-b/reorganise-about-headers 1 rok pred
about 47f6470576 Update release policy info on 4.1 1 rok pred
classes 55c8a88dfe classref: Sync with current master branch (68ad520) 1 rok pred
community aa76ea2930 Update community tutorials and resources for 4.0+ 1 rok pred
contributing 809e728db0 Merge pull request #8983 from Calinou/compiling-for-linuxbsd-production 1 rok pred
getting_started 680d3a7a71 Fix autoplay icon link in Your first 3D game - Adding animations 1 rok pred
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 rokov pred
tutorials dd4c2439fe Add a note to the vendor plugin info that it no longer needs to be enabled. 1 rok pred
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 rokov pred
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 rokov pred
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 rokov pred
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 rokov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile 31204023b6 Makefile: use sphinx-build -M 2 rokov pred
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 rokov pred
conf.py 95fb178429 Add support for user-provided comments with Giscus 1 rok pred
index.rst 9b9a06cdb3 Remove reference to DevDocs copy of documentation 1 rok pred
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 rokov pred
requirements.txt f7e0df5783 Pin more sphinx-contrib packages 1 rok pred
robots.txt fd5f6f4909 Appease our great search engine overlords 5 rokov pred

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.